При написании библиотеки вы должны поместить файлы JavaScript, сгенерированные TypeScript, в gitignore? - PullRequest
1 голос
/ 30 сентября 2019

Я пишу библиотеку, и мои файлы TypeScript находятся в папке src. Я настроил tsc так, чтобы он выводил файлы JavaScript в папку js. Сценарии, входящие в комплект, входят в dist.

Нет видимых причин для индексации js и dist в репозитории git, поскольку они являются продуктами файлов TypeScript в src. Я мог бы исключить js и dist из .gitignore и включить их в .npmignore, чтобы они оказались в окончательном выпуске на npm.

В моих тестах используются файлы из js иЯ запускаю их перед каждым выпуском, поэтому, если тесты пройдут, это означает, что папки js и dist в порядке и готовы к публикации на npm.

Возможно, недостатком является то, что у вас не будетскомпилированные файлы при клонировании репо - вам нужно будет npm install и собрать их. Но я думаю, что это не оправдывает наличие коммитов в два раза больше.

Было бы плохой практикой игнорировать js и dist в git?

1 Ответ

4 голосов
/ 30 сентября 2019

вы должны поместить файлы JavaScript, сгенерированные TypeScript, в gitignore?

Да. Обязательно игнорируйте их.

Причина

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

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...