Шаблон начального модуля узла TypeScript

Этот пост и сопровождающий репозиторий были заархивированы. Тем не менее, есть новый репозиторий (стартовый шаблон), который включает в себя TypeScript, Babel, Jest и Rollup Configuration.

Репозиторий шаблона GitHub для быстрого запуска новых модулей узлов с TypeScript.

Вы устали от настройки TypeScript и других зависимостей, прежде чем даже написать одну строку кода? Я, поэтому я решил создать небольшой репозиторий шаблона с некоторыми инструментами, которые я использую для повседневного развития.

Вы можете проверить репозиторий на GitHub Или продолжить чтение, чтобы узнать о включенных задачах, непрерывной интеграции, крючках GIT и т. Д.

Что внутри

TypeScript установлен на строго Конфигурация с генерацией карты источника.
Eslint настроен на использование Стандартный конфигурация Для TypeScript, с несколькими переопределениями, которые, я думаю, имеют здравый смысл. Вы можете увидеть переопределения внутри .eslintrc.js файл.
ЕДИНЦИОННЫЕ Тестирование выполняется через Шутка в сочетании с ТС-ДЕСКА
Красиво Конфигурация с Несколько пользовательских правил Анкет
Покрытие кода.

Задачи

Prepublishonly : Запустите перед публикацией модуля в NPM.
сборка : Сборка
Строитель: Смотрите : Создайте и смотрите TypeScript для изменений.
тест : Запустите все тесты и генерируйте покрытие кода.
Тест: смотреть : Запустите и смотрите тесты на изменения (с typeahead
CI: тест Задача, выполняемая провайдером непрерывной интеграции (CIRCLECI), запускает тесты и загружает покрытие кода.
формат : Форматировать все файлы с красивее ( Тесты и SRC каталоги).
Исправление: src : запустить Eslint на SRC каталог с -Фикс флаг.
Исправление: тесты : запустить Eslint на Тесты каталог с -Фикс флаг.
исправить : run Исправление: src и Исправление: тесты задача параллельно.
Документы : генерировать документацию TypeScript через typedoc

Непрерывная интеграция

Circleci используется для непрерывной интеграции. Тесты выполняются для версий узлов 8, 10 и 12.

Circleci также настроен на загрузку покрытия кода в Codecov.io Однако вы также можете использовать Coiplls Для покрытия кода (он в настоящее время прокомментирован).

Git Hooks

Есть одна настройка Git Hook через Хаски Пакет в сочетании с ворсница Анкет Прежде чем совершать файлы, все поставленные файлы будут проходить через Eslint и красивее.

Отладка

Если вы используете VS -код в качестве редактора, есть одна конфигурация отладки, которая настроена на отладочную тестовый файл в настоящее время отладки в редакторе.

ТИЗКИКСКИЙ ДОКУМЕНТ Генератор

Типовая документация генерируется через typedoc Анкет В настоящее время он настроен на то, чтобы перейти к Документы/API каталог и он генерируется в разметке, поэтому он может отображаться на GitHub.

Частные члены исключены.
Только экспортируемые свойства задокументированы.

Вывод

Этот шаблон репозитория дал мне быстрый способ начать работу над модулем узла с TypeScript. Не стесняйтесь распаковать репозиторий и создавать свою версию шаблона. Например, вы можете заменить Standardjs с Airbnb гид по стилю.

Надеюсь, вы найдете это полезным.

Оригинал: “https://dev.to/ivandotv/typescript-node-module-template-repository-57be”