Написание модулей NPM в Typescript

Я работаю над своим первым модулем NPM. Раньше я кратко работал с машинописным текстом, и большая проблема заключалась в том, что для многих модулей не было доступных файлов определений. Поэтому я подумал, что было бы неплохо написать свой модуль на машинописном тексте.

Однако я не могу найти никакой информации о том, как это лучше всего сделать. Я нашел связанный вопрос « Могу ли я написать пакет npm в coffeescript? », Где люди предлагают публиковать только файлы javascript. Но в отличие от файлов coffeescript, файлы машинописного текста могут быть полезны, если они используются в приложении машинописного текста.

Должен ли я включать файлы Typescript при публикации модуля NPM или я должен публиковать только файлы javascript и предоставлять сгенерированные файлы .d.ts в DefinentyTyped?

Вот пример модуля Node, написанного на TypeScript: https://github.com/basarat/ts-npm-module

Вот образец проекта TypeScript, который использует этот образец модуля https://github.com/basarat/ts-npm-module-consume

В основном вам необходимо:

• компилировать с commonjsиdeclaration:true
• создать .d.tsфайл

А потом

• Пусть ваш ide прочитает сгенерированный .d.ts.

Atom-TypeScript просто обеспечивает хороший рабочий процесс вокруг этого: https://github.com/TypeStrong/atom-typescript#packagejson-support

В TypeScript 3.x или TypeScript 2.x следующие шаги описывают, что вам нужно сделать для создания библиотеки (пакета npm) с TypeScript:

• Создайте свой проект, как обычно (с тестами и всем остальным)
• Добавьте, declaration: trueчтобы tsconfig.jsonгенерировать набор текста.
• Экспортируйте API через index.ts
• В package.json, укажите на созданные вами типы. Например, если у вас outDirесть dist, добавьте "types": "dist/index.d.ts"в свой пакет json.
• В package.jsonукажите на свой основной входной файл. Например, если у вас outDirесть, distа основной входной файл - это index.js, добавьте "main": "dist/index.js"в свой package.json.
• Создайте, .npmignoreчтобы игнорировать ненужные файлы (например, источник).
• Публикуйте в npm с помощью npm publish. Используйте спецификации semver для обновлений (исправление исправлений / ошибок npm version patch, неразрывные дополнения npm version minor, критические изменения api npm version major)

Так как у меня появилось время, чтобы просмотреть все устаревшие ресурсы по этой теме в Интернете (например, на этой странице ...), я решил обернуть это в библиотеке how-to-write-a-typescript с помощью актуальный рабочий минимальный пример.

Это более свежий ответ с использованием TypeScript 1.8.10:

Моя структура проекта:

|
|--- src
|--- test
|--- dist     <= My gulp file compiles and places the js, sourcemaps and .d.ts files here
|      |--- src
|      |--- test
|--- typings
.gitignore
.npmignore
gulpfile.js
package.json
README.md
tsconfig.json
tslint.json
typings.json

Я добавил следующее, .npmignoreчтобы избежать включения посторонних файлов и сохранить минимум для импорта и работы пакета:

node_modules/
*.log
*.tgz

src/
test/
gulpfile.js
tsconfig.json
tslint.json
typings.json
typings
dist/test

У меня .gitignoreесть:

typings

# ignore .js.map files
*.js.map
*.js
dist

У меня package.jsonесть:

"main": "dist/src/index.js",
"typings":  "dist/src/index.d.ts",

Сейчас бегу: npm pack

Результирующий файл (в распакованном виде) имеет следующую структуру:

|
|--- dist
|       |--- src
|              |
|              index.js
|              index.js.map
|              index.d.ts
|
package.json
README.md

Теперь я перехожу к проекту, где хочу использовать его как библиотеку, и набираю: npm install ./project-1.0.0.tgz

Устанавливается успешно.

Теперь я создаю файл index.tsв своем проекте, в котором только что установил npm import Project = require("project");

Печатание Project.дает мне возможности Intellisense, что и было целью всего этого упражнения.

Надеюсь, это поможет кому-то еще в использовании своих проектов TypeScript npm в качестве внутренних библиотек в своих более крупных проектах.

PS: Я считаю , что такой подход составления проектов по НПМ модулям , которые могут быть использованы в других проектах , напоминает .dllв .NETмире. Я вполне мог представить себе проекты, организованные в решение в VS Code, где каждый проект создает пакет npm, который затем может использоваться в другом проекте в решении в качестве зависимости.

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

Я также разместил его для закрытой ошибки по адресу: https://github.com/npm/npm/issues/11546

Этот пример загружен на Github: vchatterji / tsc-seed

Вам следует публиковать исходные тексты машинописных текстов вместо определения типа. В package.jsonПусть точка свойства «типов» в * .ts файл.

*.d.ts хороши для аннотирования существующих JS-библиотек, но как потребитель я бы предпочел читать машинописный код, чем переключаться между определениями типов и сгенерированным JS-кодом с пониженным уровнем.

Я в основном следую предложению Варуна Чаттерджи

Но я хотел бы показать полный пример с модульным тестированием и покрытием кода, а также опубликовать его npmи импортировать с помощью javascriptилиtypescript

Этот модуль написан с использованием, typescript 2.2и важно настроить prepublishловушку для компиляции кода с использованием, tscпрежде чем публиковать его в npm.

https://github.com/sweetim/haversine-position

https://www.npmjs.com/package/haversine-position

Вы можете использовать autodts для обработки распространения и использования .d.tsфайлов из npm также без поддержки со стороны Atom IDE.

autodts generate.d.tsобъединит все ваши собственные файлы вместе для публикации на npm и будет autodts linkобрабатывать ссылки на другие установленные пакеты, которые не всегда могут находиться непосредственно node_modulesв большом проекте, разделенном на несколько подпакетов.

Обе команды читают свои настройки из package.jsonи tsconfig.jsonв «конвент по конфигурации» стиль.

Есть еще один ответ на stackoverflow и сообщение в блоге с более подробной информацией.

В Lossless мы создали универсальный инструмент разработки TypeScript для пакетов npm: https://gitzone.gitlab.io/npmts/