Должен ли я при создании пакета иметь файл package.json в моей папке / src? - PullRequest
Новая
       19

Должен ли я при создании пакета иметь файл package.json в моей папке / src?

0 голосов
/ 14 марта 2019

У меня есть несколько пакетов, в которых есть файл package.json в корневом каталоге, а также файл package.json в папке /src. Когда я строю, это файл /src, который копируется в папку /dist. (и позже опубликовано в Nexus).

Что меня интересует, так это правильный путь, так как при развитии я изменяю только самое внешнее /package.json file. Это означает, что файл / src «устарел». А обновление двух файлов - это проблема.

Я делаю это "правильным" способом, я должен держать два файла в актуальном состоянии? Или я могу просто использовать один файл, «корневой». 

package.json
src/
    index.ts
    package.json
dist/
    index.d.ts
    index.js
    package.json //from src

1 Ответ

0 голосов
/ 16 марта 2019

То, как вы настроили свой проект, немного необычно.Как правило, проект выглядит следующим образом: один корень package.json: 

.npmignore
package.json
src/
    index.ts
dist/
    index.d.ts
    index.js

Вместо публикации только содержимого папки dist вы запускаете npm publish изкорень проекта.Новый файл .npmignore сообщает npm, что не публиковать.Если вы хотите исключить только src, ваш .npmignore будет выглядеть следующим образом: 

src

Затем в package.json установите поля main и typings, чтобы сообщить узлуи TS, где найти ваш код: 

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

(В качестве альтернативы, если вы действительно просто хотите опубликовать содержимое dist, вы можете настроить еще один шаг сборки, чтобы скопировать вашroot package.json в dist. Но описанная выше стратегия публикации гораздо более типична.)

...