Typescript-lib-starter

Проект

Это шаблон для библиотеки проектов на основе Typescript. Он основан на Rollup, Karma+Jasmine и Webpack.

Быстрый старт

Установка зависимостей

$ npm i

Сборка

$ npm run build

• Использование Rollup для сборки исходного кода Typescript и создания UMD и ESM5 стандартных пакетов.
• По умолчанию скрипт сборки также создаёт один файл пакета, который включает в себя весь сторонний код. Если вам не нужен этот пакет, вы можете закомментировать соответствующий блок кода в script/build.js.

Модульное тестирование

$ npm run test

• Использование Karma + Webpack для создания модульных тестов Typescript.
• Вы можете писать свои тестовые примеры непосредственно на Typescript и организовывать структуру каталогов по своему усмотрению.
• Только тесты с расширением *.spec.ts будут выполняться.

Запуск и устранение неполадок

$ npm start

• Использование Webpack для построения и запуска demo в виде обычного веб-проекта. Это может быть полезно для быстрой разработки и отладки.
• Хотя ваша библиотека будет использоваться не так, как demo, она может помочь при разработке библиотек, которые в конечном итоге будут использоваться в веб-приложениях.
• Если необходимо, вы можете использовать команду npm build-demo для создания содержимого demo.

Структура каталогов

|- src/
|- test/
|- demo
|    |- src/
|    |- assets
|    |- app.bundle.js
|    |- index.html
|- script/
|    |- build.js
|    |- release.js
|- tsconfig.json
|- karma.conf.js
|- webpack.config.js
|- package.json

• src: каталог исходного кода.
• test: каталог модульного тестирования.
• demo: каталог страницы demo.
  • src: исходный код страницы demo.
  • app.bundle.js: производственная версия пакета, созданная Webpack после выполнения команды npm run build-demo. Обратите внимание, что Webpack не генерирует этот пакет при использовании npm start.
• script: каталог скриптов инструментов.
  • build.js: скрипт сборки, который вызывает Rollup для выполнения задачи сборки. Вы можете выборочно использовать блоки кода сборки в зависимости от назначения вашей библиотеки.
  • release.js: скрипт публикации, который может автоматически публиковать в npm.
• tsconfig.json: файл конфигурации Typescript.
• karma.conf.js: файл конфигурации Karma. Используется для модульного тестирования.
• webpack.config.js: файл конфигурации Webpack. Используется для запуска или сборки проекта demo.