Шаблон для консольных проектов и библиотек

• TypeScript,
• сборка TSC и ESBuild,
• автопроверки и форматирование ESLint, Prettier,
• автотесты Jest,
• модули ECMAScript (вместо CommonJS),
• стандарт ES2022.

Установка

Выполняем

yarn create ts-console-project
# npm create ts-console-project

И следуем указаниям в консоли.

Аргументом в консоли можно указать каталог назначения, куда будет установлен проект.

Например

yarn create ts-console-project .

Установит проект в текущий каталог.

Если в каталоге назначения уже существует файл package.json, будет предложено обновить проект.

Быстрый запуск

Запуск в режиме разработки:

yarn dev
# npm run dev

Сборка проекта:

Сборка:

yarn build
# npm run build

Во время сборки запускается линтер, прохождение тестов, компиляция TypeScript и минификация.

Можно выполнить только компиляцию:

yarn compile
# npm run compile

Запуск:

yarn start
# npm run start

Обновление

Обновляются файлы:

• .gitignore
• .prettierignore
• eslint.config.js
• jest.config.js
• prettier.config.js
• package.json
• tsconfig.json

При обновлении создается каталог .backup, куда копируются исходные файлы.

В файле package.json обновляются скрипты и зависимости, необходимые проекту. Остальные скрипты и зависимости остаются неизменными.

Будьте внимательны, могут возникнуть конфликты версий.

Тестирование

Тестируем с помощью Jest.

Здесь он сразу настроен для использования с TypeScript.

Примеры использования приведены в проекте.

Файлы для тестирования должны называться по маске .test.ts или .spec.ts:

src/intro.test.ts

Можно использовать наборы кейсов для тестирования. Они должны называться по маске .case.ts:

src/intro.case.ts

Хорошей практикой может быть помещать тесты и кейсы в отдельные каталоги:

tests/
├── cases/
|   ├── ....case.ts
│   └── intro.case.ts
├── ....test.ts
└── intro.test.ts

Для запуска всех тестов используем команду

yarn test
# npm run test

Чтобы запустить какой-либо определенный тест, указываем его в качестве аргумента:

yarn test ./src/tests/example.test.ts
# npm run test ./src/tests/example.test.ts

Поддержка

Больше интересных библиотек в репозитории.

Если проект понравился, и вы хотите меня поддержать, не пожалейте поставить звездочку.

А сейчас просто обнимите своих родных и близких, скажите им, как вы их любите.

Лицензия

Лицензия MIT, 2025