projen

Define y mantén configuraciones de proyectos complejas mediante código.

¡ÚNETE AL MOVIMIENTO #TemplatesAreEvil!

projen sintetiza archivos de configuración de proyectos como package.json, tsconfig.json, .gitignore, flujos de trabajo de GitHub, eslint, jest, etc. a partir de una definición bien tipada escrita en JavaScript.

Consulta esta charla sobre projen.

A diferencia de las herramientas existentes de plantillas/scaffolding, projen no es un generador de una sola vez. Los archivos sintetizados nunca deben editarse manualmente (de hecho, projen lo impone). Para modificar la configuración de tu proyecto, los usuarios interactúan con clases ricas y fuertemente tipadas y ejecutan projen para actualizar sus archivos de configuración del proyecto.

Primeros pasos

Para crear un nuevo proyecto, ejecuta el siguiente comando y sigue las instrucciones:```console $ mkdir my-project $ cd my-project $ git init $ npx projen new PROJECT-TYPE 🤖 Synthesizing project... ...

Este programa instancia el tipo de proyecto con una configuración mínima y luego llama a synth() para sintetizar los archivos del proyecto. De forma predeterminada, el comando new también ejecutará este programa, lo que dará como resultado un proyecto completamente funcional.

Una vez que se crea tu proyecto, puedes configurarlo editando .projenrc.js y volviendo a ejecutar npx projen para sintetizarlo nuevamente.

Los archivos generados por projen se consideran un "detalle de implementación" y projen los protege de ser editados manualmente (la mayoría de los archivos están marcados como de solo lectura, y se configura una verificación "anti manipulación" en el flujo de trabajo de compilación de CI para garantizar que los archivos no se actualicen durante la compilación).

Por ejemplo, para configurar la publicación en PyPI en proyectos jsii, puedes usar opción python:```js const project = new JsiiProject({ // ... python: { distName: "mydist", module: "my_module", } });

Y notarás que tu archivo package.json ahora contiene una sección python en su configuración jsii, y el flujo de trabajo release.yml de GitHub incluye un paso de publicación en PyPI.

Recomendamos poner esto en tu perfil de shell, para que puedas simplemente ejecutar pj cada vez que actualices .projenrc.js:```bash alias pj='npx projen'

El comando build es el mismo comando que se ejecuta en tus builds de CI. Normalmente compila, ejecuta linters, ejecuta pruebas y empaqueta tu módulo para su distribución.

Características

Algunos ejemplos de características integradas en los tipos de proyecto:

• Sintetiza completamente package.json
• Scripts npm estándar como compile, build, test, package
• eslint
• Jest
• jsii: compile, package, comprobaciones de compatibilidad de API, API.md
• Scripts de bump y release con generación de CHANGELOG basada en Conventional Commits
• Builds de PR automatizados
• Releases automatizados a npm, maven, NuGet y PyPI
• Configuración de Mergify
• Generación de archivos LICENSE
• Gestión de gitignore + npmignore
• Soporte de "engines" de Node con acoplamiento al entorno de build de CI y a @types/node
• Anti-manipulación: los builds de CI fallarán si un archivo sintetizado se modifica manualmente

Referencia de API

Consulta la Referencia de API para obtener detalles de la API.

Además, varios componentes de projen y tipos de proyecto se explican con ejemplos en /docs (¡actualmente un trabajo en progreso!).

Ecosistema

projen adopta un enfoque de "baterías incluidas" y tiene como objetivo ofrecer docenas de tipos de proyecto listos para usar (apenas estamos comenzando). Piensa en projen new react, projen new angular, projen new java-maven, projen new awscdk-typescript, projen new cdk8s-python (nada en projen está vinculado a javascript o npm)...

Agregar nuevos tipos de proyecto es tan simple como enviar un pull request a este repositorio y exportar una clase que extienda projen.Project (o uno de sus derivados). Projen descubre automáticamente los tipos de proyecto, por lo que tu tipo estará disponible de inmediato en projen new.

Proyectos en módulos externos

projen viene incluido con muchos tipos de proyecto listos para usar, pero también puede funcionar con tipos de proyecto y componentes definidos en módulos jsii externos (la razón por la que necesitamos jsii es porque projen usa los metadatos de jsii para descubrir tipos de proyecto y opciones en projen new).

Digamos que tenemos un módulo en npm llamado projen-vuejs que incluye un único tipo de proyecto para vue.js:```bash $ npx projen new --from projen-vuejs

Bajo el capó, projen new instalará el módulo projen-vuejs desde npm (versión 2.0.0 y superior), descubrirá los tipos de proyecto que contiene e inicializará el tipo de proyecto vuejs-ts. Asignará el valor "my awesome vue project" al campo description. Si examinas tu archivo .projenrc.js, verás que projen-vuejs está definido como una dependencia de desarrollo:```javascript const { VueJsProject } = require('projen-vuejs');

const project = new VueJsProject({ name: 'my-vuejs-sample', description: "my awesome vue project", // ... devDeps: [ 'projen-vuejs' ] });

project.synth();

Gracias a estas maravillosas personas (clave de emoji):

Licencia

Distribuido bajo la licencia Apache-2.0.