Это не совсем новый вопрос, но я уже давно осмотрелся, и у меня возникли проблемы с поиском решения.

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

npm install https://github.com/myRepo/angular-translate
npm install https://github.com/myRepo/angular-translate/archive/master.tar.gz

Первый дает мне такой каталог без сборки. Просто package.json, .npmignore и некоторые файлы уценки

-angular-translate
   .npmignore 
   .nvmrc
    CHANGELOG.md 
    package.json
    etc

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

Прошу прощения за свое незнание темы. У меня нет большого опыта работы с npm. Хотел бы получить отзывы по этой проблеме. Кажется, это может быть достаточно распространенной проблемой, когда необходимо внести изменения в исходный код пакета? Может есть решение получше? Заранее спасибо за вашу помощь.

Попробуйте npm install <ghusername>/<repoName>, где <ghUsername>ваше имя пользователя GitHub (без символа @) и <repoName>имя репозитория. Это должно правильно установить его. Скорее всего, вы захотите использовать флаг --saveили --save-devс командой установки, чтобы сохранить зависимость в вашем package.json.

Если это работает неправильно, проверьте содержимое вашего .npmignoreфайла.

Не паникуйте, если команда установки занимает много времени; установка из репозитория git происходит медленнее, чем установка из реестра npm.

Редактировать:

Ваша проблема в том, что в вашем случае dist/он не привязан к репо (поскольку он находится в .gitignore). Вот где живет настоящий код. dist/создается из файлов src/до публикации пакета в реестре npm, но dist/никогда не фиксируется в репо.

Это некрасиво, но в этом случае вам придется удалить dist/из, .gitignoreа затем запустить:

npm run build
git add .
git commit
git push

(Убедитесь, что вы бежали npm installпервым)

После этого вы сможете установить его с github.

Возможно, есть другой способ сделать это с помощью postinstallсценария, но я не уверен, что это возможно; Никогда не пробовал.

Обновление для тех, кто использует npm 5:

Начиная с npm @ 5 prepublishскрипты устарели.

Используйте prepareдля этапов сборки и только prepublishOnlyдля загрузки.

Я обнаружил, что добавление "prepare": "npm run build"к скриптам устранило все мои проблемы.

Код, опубликованный на npmjs.com, часто отличается от того, что находится в репозитории пакета. Обычно исходные файлы JavaScript "компилируются" в версии, предназначенные для общего использования в библиотеках. Это то, что обычно публикуется на npmjs.com.

Это настолько распространено, что это функция npmавтоматического запуска шага «сборки» перед публикацией ( npm publish). Первоначально это называлось prepublish. Похоже, что Npm подумал, что было бы удобно запустить prepublishскрипт и на сервере, npm installпоскольку это был стандартный способ инициализации среды разработки.

Это привело к серьезному замешательству в сообществе. На github есть очень длинные вопросы по этому поводу.

В конце концов, чтобы не менять старое поведение, они решили добавить еще два автоматических скрипта: prepublishOnlyи prepare.

prepublishOnlyделает то, что вы ожидаете. Не запускается npm install. Многие разработчики пакетов просто слепо перешли на это.

Но была еще одна проблема: люди не хотели зависеть от npmjs.com в распространении версий пакетов. Репозитории Git были естественным выбором. Однако распространенной практикой является не фиксировать "скомпилированные" файлы в git. Вот что prepareдобавили в ручку ...

prepare правильный путь

Если у вас есть репозиторий с исходными файлами, но для его использования необходим этап «сборки», он
prepareделает именно то, что вы хотите, во всех случаях (начиная с npm 4).

prepare: Запустите как ПЕРЕД тем, как пакет будет упакован и опубликован, локально npm installбез каких-либо аргументов и при установке зависимостей git.

Вы даже можете поместить в него зависимости сборки, devDependenciesи они будут установлены до prepareвыполнения.

Вот пример моего пакета, в котором используется этот метод.

Проблемы с .gitignore

У этого варианта есть одна проблема, которая волнует многих. При подготовке зависимости Npm и Yarn сохранят только файлы, перечисленные в filesразделе package.json.

Можно увидеть, что по filesумолчанию включены все файлы, и подумать, что все готово. Что легко упустить, так это то, что в .npmignore основном переопределяет filesдирективу и , если .npmignoreне существует, .gitignoreиспользуется вместо нее .

Итак, если у вас есть созданные вами файлы, перечисленные .gitignoreкак нормальный человек, и вы больше ничего не делаете, они prepareбудут казаться сломанными

Если вы исправите, filesчтобы включить только созданные файлы или добавить пустой .npmignore, все готово.

Я рекомендую установить files(или путем инверсии .npmignore) так, чтобы фактически публикуемые файлы были только теми, которые необходимы пользователям опубликованного пакета. Имхо, нет необходимости включать некомпилированные исходники в опубликованные пакеты.

Оригинальный ответ: https://stackoverflow.com/a/57503862/4612476

Использование отличного ответа @RyanZim, postinstallбезусловно , является подходящим вариантом для этого.

Либо выполните одно из следующих действий:

1. Обновите package.json в своем разветвленном репо, чтобы добавить в скрипты элемент postinstall. Здесь запустите все, что вам нужно, чтобы получить скомпилированный вывод (предпочтительно).
2. Обновите свой package.json и добавьте постинсталляцию, которая обновляет необходимый каталог в node_modules.

Если вы разветвили репозиторий другого человека, то, возможно, стоит поднять проблему, чтобы проиллюстрировать проблему, заключающуюся в том, что установка их пакета через GitHub не работает, поскольку не предоставляет необходимых средств для сборки скрипта. Оттуда они могут либо принять PR для решения этой проблемы с помощью постустановки, либо отклонить его, и вы можете сделать №2.

Просто используйте команду npm install git+https://git@github.com/myRepo/angular-translate.git. Спасибо.