projen

Définissez et maintenez une configuration de projet complexe via du code.

REJOIGNEZ LE MOUVEMENT #TemplatesAreEvil !

projen synthétise des fichiers de configuration de projet tels que package.json, tsconfig.json, .gitignore, les workflows GitHub, eslint, jest, etc. à partir d'une définition bien typée écrite en JavaScript.

Consultez cette présentation à propos de projen.

Contrairement aux outils de templating/scaffolding existants, projen n'est pas un générateur ponctuel. Les fichiers synthétisés ne doivent jamais être modifiés manuellement (en fait, projen l'impose). Pour modifier la configuration de votre projet, les utilisateurs interagissent avec des classes riches et fortement typées et exécutent projen pour mettre à jour leurs fichiers de configuration de projet.

Pour commencer

Pour créer un nouveau projet, exécutez la commande suivante et suivez les instructions :```console $ mkdir my-project $ cd my-project $ git init $ npx projen new PROJECT-TYPE 🤖 Synthesizing project... ...

Ce programme instancie le type de projet avec une configuration minimale, puis appelle synth() pour synthétiser les fichiers du projet. Par défaut, la commande new exécutera également ce programme, ce qui aboutira à un projet entièrement fonctionnel.

Une fois votre projet créé, vous pouvez le configurer en modifiant .projenrc.js et en ré-exécutant npx projen pour synthétiser à nouveau.

Les fichiers générés par projen sont considérés comme un "détail d'implémentation" et projen les protège contre toute modification manuelle (la plupart des fichiers sont marqués en lecture seule, et une vérification "anti-altération" est configurée dans le workflow de build CI pour garantir que les fichiers ne sont pas mis à jour pendant le build).

Par exemple, pour configurer la publication PyPI dans les projets jsii, vous pouvez utiliser l'option python :```js const project = new JsiiProject({ // ... python: { distName: "mydist", module: "my_module", } });

Et vous remarquerez que votre fichier package.json contient désormais une section python dans sa configuration jsii et que le workflow GitHub release.yml inclut une étape de publication sur PyPI.

Nous recommandons de placer ceci dans votre profil shell, afin de pouvoir simplement exécuter pj à chaque fois que vous mettez à jour .projenrc.js :```bash alias pj='npx projen'

La commande build est la même commande qui est exécutée dans vos builds CI. Elle compile, lint, teste et empaquette généralement votre module pour la distribution.

Fonctionnalités

Quelques exemples de fonctionnalités intégrées aux types de projets :

• Synthèse complète de package.json
• Scripts npm standard comme compile, build, test, package
• eslint
• Jest
• jsii : compilation, empaquetage, vérifications de compatibilité d'API, API.md
• Scripts de bump et de release avec génération de CHANGELOG basée sur les Conventional Commits
• Builds PR automatisés
• Releases automatisées vers npm, maven, NuGet et PyPI
• Configuration Mergify
• Génération de fichiers LICENSE
• Gestion de gitignore + npmignore
• Support des "engines" Node avec couplage à l'environnement de build CI et à @types/node
• Anti-altération : les builds CI échoueront si un fichier synthétisé est modifié manuellement

Référence API

Voir Référence API pour les détails de l'API.

De plus, plusieurs composants projen et types de projets sont expliqués avec des exemples dans /docs (actuellement un travail en cours !).

Écosystème

projen adopte une approche "batteries incluses" et vise à proposer des dizaines de types de projets prêts à l'emploi (nous ne faisons que commencer). Pensez à projen new react, projen new angular, projen new java-maven, projen new awscdk-typescript, projen new cdk8s-python (rien dans projen n'est lié à javascript ou npm)...

L'ajout de nouveaux types de projets est aussi simple que de soumettre une pull request à ce dépôt et d'exporter une classe qui étend projen.Project (ou l'un de ses dérivés). Projen découvre automatiquement les types de projets, donc votre type sera immédiatement disponible dans projen new.

Projets dans des modules externes

projen est fourni avec de nombreux types de projets prêts à l'emploi, mais il peut également fonctionner avec des types de projets et des composants définis dans des modules jsii externes (la raison pour laquelle nous avons besoin de jsii est que projen utilise les métadonnées jsii pour découvrir les types de projets et les options dans projen new).

Disons que nous avons un module dans npm appelé projen-vuejs qui inclut un seul type de projet pour vue.js :```bash $ npx projen new --from projen-vuejs

Sous le capot, projen new installera le module projen-vuejs depuis npm (version 2.0.0 et supérieure), découvrira les types de projets qu'il contient et initialisera le type de projet vuejs-ts. Il attribuera la valeur "my awesome vue project" au champ description. Si vous examinez votre fichier .projenrc.js, vous verrez que projen-vuejs est défini comme une dépendance de développement :```javascript const { VueJsProject } = require('projen-vuejs');

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

project.synth();

Merci à ces personnes formidables (clé emoji) :

Licence

Distribué sous la licence Apache-2.0.