projen

Определяйте и поддерживайте сложную конфигурацию проектов с помощью кода.

ПРИСОЕДИНЯЙТЕСЬ К ДВИЖЕНИЮ #TemplatesAreEvil!

projen синтезирует файлы конфигурации проекта, такие как package.json, tsconfig.json, .gitignore, рабочие процессы GitHub, eslint, jest и т. д., из хорошо типизированного определения, написанного на JavaScript.

Посмотрите этот доклад о projen.

В отличие от существующих инструментов шаблонизации/скаффолдинга, projen — это не разовый генератор. Синтезированные файлы никогда не следует редактировать вручную (на самом деле projen это обеспечивает). Чтобы изменить настройку проекта, пользователи взаимодействуют с богатыми строго типизированными классами и выполняют projen для обновления файлов конфигурации проекта.

Начало работы

Чтобы создать новый проект, выполните следующую команду и следуйте инструкциям:```console $ mkdir my-project $ cd my-project $ git init $ npx projen new PROJECT-TYPE 🤖 Synthesizing project... ...

Эта программа создаёт экземпляр типа проекта с минимальной настройкой, а затем вызывает synth() для синтеза файлов проекта. По умолчанию команда new также выполняет эту программу, что приводит к полностью рабочему проекту.

После создания проекта вы можете настроить его, отредактировав .projenrc.js и повторно запустив npx projen для повторного синтеза.

Файлы, сгенерированные projen, считаются «деталью реализации», и projen защищает их от ручного редактирования (большинство файлов помечены как доступные только для чтения, а в CI-сборке настроена проверка «анти-взлома» для обеспечения того, чтобы файлы не обновлялись во время сборки).

Например, чтобы настроить публикацию в PyPI для проектов jsii, вы можете использовать python option:```js const project = new JsiiProject({ // ... python: { distName: "mydist", module: "my_module", } });

И вы заметите, что ваш файл package.json теперь содержит раздел python в его конфигурации jsii, а рабочий процесс GitHub release.yml включает шаг публикации в PyPI.

Мы рекомендуем добавить это в ваш профиль оболочки, чтобы вы могли просто запускать pj каждый раз, когда обновляете .projenrc.js:```bash alias pj='npx projen'

Команда build — это та же команда, которая выполняется в ваших CI-сборках. Она обычно компилирует, проверяет линтером, запускает тесты и упаковывает ваш модуль для распространения.

Возможности

Вот несколько примеров функций, встроенных в типы проектов:

• Полная генерация package.json
• Стандартные npm-скрипты, такие как compile, build, test, package
• eslint
• Jest
• jsii: компиляция, упаковка, проверки совместимости API, API.md
• Скрипты бампа и релизов с генерацией CHANGELOG на основе Conventional Commits
• Автоматические PR-сборки
• Автоматические релизы в npm, maven, NuGet и PyPI
• Конфигурация Mergify
• Генерация файла LICENSE
• Управление gitignore + npmignore
• Поддержка "engines" Node с привязкой к среде CI-сборки и @types/node
• Защита от подделки: CI-сборки завершатся ошибкой, если синтезированный файл был изменён вручную

Справочник по API

Подробности об API см. в Справочнике по API.

Кроме того, несколько компонентов projen и типов проектов объясняются с примерами в /docs (сейчас в процессе разработки!).

Экосистема

projen использует подход "batteries included" и стремится предлагать десятки различных типов проектов из коробки (мы только начинаем). Представьте projen new react, projen new angular, projen new java-maven, projen new awscdk-typescript, projen new cdk8s-python (ничто в projen не привязано к javascript или npm!)...

Добавление новых типов проектов так же просто, как отправка pull request в этот репозиторий и экспорт класса, который расширяет projen.Project (или один из его производных). Projen автоматически обнаруживает типы проектов, поэтому ваш тип будет немедленно доступен в projen new.

Проекты во внешних модулях

projen поставляется со множеством типов проектов из коробки, но также может работать с типами проектов и компонентами, определёнными во внешних jsii-модулях (причина, по которой нам нужен jsii, заключается в том, что projen использует jsii-метаданные для обнаружения типов проектов и опций в projen new).

Допустим, у нас есть модуль в npm под названием projen-vuejs, который включает один тип проекта для vue.js:```bash $ npx projen new --from projen-vuejs

Под капотом projen new установит модуль projen-vuejs из npm (версии 2.0.0 и выше), обнаружит типы проектов в нём и инициализирует тип проекта vuejs-ts. Он присвоит значение "my awesome vue project" полю description. Если вы посмотрите на свой файл .projenrc.js, вы увидите, что projen-vuejs определён как dev-зависимость:```javascript const { VueJsProject } = require('projen-vuejs');

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

project.synth();

Спасибо этим замечательным людям (ключ эмодзи):

Лицензия

Распространяется под лицензией Apache-2.0.