projen

Definieren und pflegen Sie komplexe Projektkonfigurationen über Code.

SCHLIESSEN SIE SICH DER #TemplatesAreEvil-BEWEGUNG AN!

projen synthetisiert Projektkonfigurationsdateien wie package.json, tsconfig.json, .gitignore, GitHub-Workflows, eslint, jest usw. aus einer gut typisierten Definition, die in JavaScript geschrieben ist.

Sehen Sie sich diesen Vortrag über projen an.

Im Gegensatz zu bestehenden Templating-/Scaffolding-Werkzeugen ist projen kein einmaliger Generator. Synthetisierte Dateien sollten niemals manuell bearbeitet werden (projen erzwingt dies sogar). Um Ihr Projektsetup zu ändern, interagieren Benutzer mit reichhaltigen, stark typisierten Klassen und führen projen aus, um ihre Projektkonfigurationsdateien zu aktualisieren.

Erste Schritte

Um ein neues Projekt zu erstellen, führen Sie den folgenden Befehl aus und folgen Sie den Anweisungen:```console $ mkdir my-project $ cd my-project $ git init $ npx projen new PROJECT-TYPE 🤖 Synthesizing project... ...

Dieses Programm instanziiert den Projekttyp mit minimaler Einrichtung und ruft dann synth() auf, um die Projektdateien zu synthetisieren. Standardmäßig führt der Befehl new ebenfalls dieses Programm aus, was zu einem vollständig funktionsfähigen Projekt führt.

Sobald Ihr Projekt erstellt ist, können Sie es konfigurieren, indem Sie .projenrc.js bearbeiten und npx projen erneut ausführen, um es erneut zu synthetisieren.

Die von projen generierten Dateien gelten als "Implementierungsdetail", und projen schützt sie vor manueller Bearbeitung (die meisten Dateien sind als schreibgeschützt markiert, und im CI-Build-Workflow ist eine "Anti-Manipulations"-Prüfung konfiguriert, um sicherzustellen, dass Dateien während des Builds nicht aktualisiert werden).

Um beispielsweise die PyPI-Veröffentlichung in jsii-Projekten einzurichten, können Sie die python option verwenden:```js const project = new JsiiProject({ // ... python: { distName: "mydist", module: "my_module", } });

Und du wirst feststellen, dass deine package.json-Datei jetzt einen python-Abschnitt in ihrer jsii-Konfiguration enthält und der GitHub-release.yml-Workflow einen PyPI- Veröffentlichungsschritt enthält.

Wir empfehlen, dies in dein Shell-Profil aufzunehmen, damit du einfach pj ausführen kannst, wann immer du .projenrc.js aktualisierst:```bash alias pj='npx projen'

Der Befehl build ist derselbe Befehl, der in deinen CI-Builds ausgeführt wird. Er kompiliert, lintet, testet und verpackt dein Modul typischerweise für die Verteilung.

Funktionen

Einige Beispiele für Funktionen, die in Projekttypen integriert sind:

• Vollständige Synthese von package.json
• Standard-npm-Skripte wie compile, build, test, package
• eslint
• Jest
• jsii: Kompilierung, Verpackung, API-Kompatibilitätsprüfungen, API.md
• Bump- & Release-Skripte mit CHANGELOG-Erstellung basierend auf Conventional Commits
• Automatisierte PR-Builds
• Automatisierte Releases an npm, maven, NuGet und PyPI
• Mergify-Konfiguration
• Generierung von LICENSE-Dateien
• gitignore- und npmignore-Verwaltung
• Node-„engines“-Unterstützung mit Kopplung an die CI-Build-Umgebung und @types/node
• Anti-Manipulation: CI-Builds schlagen fehl, wenn eine synthetisierte Datei manuell geändert wird

API-Referenz

Siehe API-Referenz für API-Details.

Darüber hinaus werden mehrere projen-Komponenten und Projekttypen mit Beispielen in /docs erläutert (derzeit in Arbeit!).

Ökosystem

projen verfolgt einen „Batterien inklusive“-Ansatz und zielt darauf ab, Dutzende verschiedener Projekttypen out of the box anzubieten (wir fangen gerade erst an). Denke an projen new react, projen new angular, projen new java-maven, projen new awscdk-typescript, projen new cdk8s-python (nichts in projen ist an JavaScript oder npm gebunden)...

Das Hinzufügen neuer Projekttypen ist so einfach wie das Einreichen eines Pull Requests an dieses Repository und das Exportieren einer Klasse, die projen.Project (oder eine seiner Ableitungen) erweitert. Projen entdeckt Projekttypen automatisch, sodass dein Typ sofort in projen new verfügbar ist.

Projekte in externen Modulen

projen wird mit vielen Projekttypen out of the box gebündelt, kann aber auch mit Projekttypen und Komponenten arbeiten, die in externen jsii-Modulen definiert sind (der Grund, warum wir jsii benötigen, ist, dass projen die jsii-Metadaten verwendet, um Projekttypen & Optionen in projen new zu entdecken).

Angenommen, wir haben ein Modul in npm namens projen-vuejs, das einen einzelnen Projekttyp für vue.js enthält:```bash $ npx projen new --from projen-vuejs

Unter der Haube installiert projen new das Modul projen-vuejs aus npm (Version 2.0.0 und höher), entdeckt die Projekttypen darin und bootstrapt den Projekttyp vuejs-ts. Es weist dem Feld description den Wert "my awesome vue project" zu. Wenn du deine .projenrc.js-Datei untersuchst, wirst du sehen, dass projen-vuejs als Dev-Abhängigkeit definiert ist:```javascript const { VueJsProject } = require('projen-vuejs');

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

project.synth();

Dank geht an diese wunderbaren Menschen (Emoji-Schlüssel):

Lizenz

Verteilt unter der Apache-2.0-Lizenz.