Esta não é uma pergunta totalmente nova, mas estou procurando há um bom tempo e estou tendo problemas para encontrar uma solução.

Estou usando um módulo para meu aplicativo angular chamado angular-translate. No entanto, eu tive que fazer algumas pequenas modificações no código-fonte para fazer tudo funcionar da maneira que eu gostaria, e agora quero persistir nessas alterações npm install. Um colega sugeriu que eu bifurque o repositório do código-fonte e aponte para o repositório bifurcado como uma dependência, que tentei dessa maneira, por exemplo

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

O primeiro me fornece um diretório como este sem compilação. Apenas um package.json, .npmignore e alguns arquivos de descontos

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

O segundo npm installme fornece o repositório completo, mas novamente não recebo uma compilação como quando uso o comando npm install angular-translate. Eu já vi algumas discussões sobre a execução do script de pré-publicação, mas não sei como fazer isso ao instalar todos os módulos. Também tentei publicar a bifurcação como meu próprio módulo no registro npm, mas novamente não recebo compilação e não tenho certeza se é a coisa certa a fazer ...

Peço desculpas pela minha ignorância sobre o assunto. Não tenho muita experiência com npm. Gostaria de receber algum feedback sobre esta questão. Parece que pode ser um problema bastante comum quando modificações precisam ser feitas no código-fonte de um pacote? Talvez haja uma solução melhor? Agradeço antecipadamente por sua ajuda.

Tente npm install <ghusername>/<repoName>, onde <ghUsername>está o seu nome de usuário no GitHub (sem o @) e <repoName>é o nome do repositório. Isso deve instalá-lo corretamente. Você provavelmente desejará usar o sinalizador --saveou --save-devcom o comando install para salvar a dependência no seu package.json.

Se isso não estiver funcionando corretamente, verifique o conteúdo do seu .npmignorearquivo.

Não entre em pânico se o comando de instalação demorar muito; instalar a partir de um repositório git é mais lento que instalar a partir do registro npm.

Editar:

Seu problema é que, no seu caso, dist/não está comprometido com o repo (já que está no .gitignore). É aí que vive o código real. dist/é criado a partir dos arquivos src/antes da publicação do pacote no registro npm, mas dist/nunca é confirmado no repositório.

É feio, mas, neste caso, você terá que remover dist/do .gitignoree executar:

npm run build
git add .
git commit
git push

(Verifique se você executou npm installprimeiro)

Você deve conseguir instalar no github.

Pode haver outra maneira de fazer isso usando um postinstallscript, mas não tenho certeza se isso é possível; Eu nunca tentei.

Atualização para aqueles que usam o npm 5:

A partir do npm @ 5, os prepublishscripts estão obsoletos.

Use preparepara etapas de criação e prepublishOnlysomente para upload.

Eu achei que adicionar um "prepare": "npm run build"script corrigiu todos os meus problemas.

O código publicado no npmjs.com geralmente não é o que está no repositório do pacote. É comum "compilar" arquivos de origem JavaScript em versões destinadas ao consumo geral em bibliotecas. É o que geralmente é publicado no npmjs.com.

É tão comum que é um recurso npmexecutar automaticamente uma etapa de "construção" antes de publicar ( npm publish). Isso foi chamado originalmente prepublish. Parece que o Npm pensou que seria útil também executar o prepublishscript em uma npm installvez que essa era a maneira padrão de inicializar um ambiente de desenvolvimento.

Isso acabou causando uma grande confusão na comunidade. Existem questões muito longas no github sobre isso.

No final, em um esforço para não mudar o comportamento antigo, eles decidiram adicionar mais dois scripts automáticos: prepublishOnlye prepare.

prepublishOnlyfaz o que você espera. Não funciona npm install. Muitos mantenedores de pacotes mudaram cegamente para isso.

Mas havia também esse problema que as pessoas queriam não depender do npmjs.com para distribuir versões de pacotes. Os repositórios Git foram a escolha natural. No entanto, é prática comum não comprometer arquivos "compilados" no git. Foi isso que preparefoi adicionado para lidar com ...

prepare é a maneira correta

Se você possui um repositório com arquivos de origem, mas é necessário usar uma etapa "build",
preparefaça exatamente o que deseja em todos os casos (a partir da npm 4).

prepare: Execute ambos ANTES que o pacote seja compactado e publicado, no local, npm installsem argumentos, e ao instalar dependências git.

Você pode até colocar suas dependências de compilação devDependenciese elas serão instaladas antes da prepareexecução.

Aqui está um exemplo de um pacote meu que usa esse método.

Problemas com .gitignore

Há um problema com essa opção que atrai muitas pessoas. Ao preparar uma dependência, o Npm e o Yarn manterão apenas os arquivos listados na filesseção package.json.

Pode-se ver que o filespadrão é que todos os arquivos sejam incluídos e pensar que estão concluídos. O que é facilmente esquecido é que a .npmignore maioria substitui a filesdiretiva e , se .npmignorenão existe, .gitignoreé usada.

Então, se você tem seus arquivos construídos listados na .gitignorecomo uma pessoa sã, e não fazer qualquer outra coisa, preparevai parecer quebrado

Se você corrigir filespara incluir apenas os arquivos criados ou adicionar um vazio .npmignore, está tudo pronto.

Minha recomendação é definir files(ou, por inversão .npmignore), para que os únicos arquivos realmente publicados sejam os necessários para os usuários do pacote publicado. No entanto, não há necessidade de incluir fontes não compiladas nos pacotes publicados.

Resposta original: https://stackoverflow.com/a/57503862/4612476

Seguir a excelente resposta de @ RyanZim, postinstallé definitivamente uma opção válida para isso.

Siga um destes procedimentos:

1. Atualize o package.json no seu repositório bifurcado para adicionar um elemento pós-instalação aos scripts. Aqui, execute o que for necessário para obter a saída compilada (Preferred).
2. Atualize seu package.json e inclua uma pós-instalação que atualize o diretório necessário em node_modules.

Se você bifurcou outro repositório de pessoas, pode valer a pena levantar um problema para ilustrar o problema de que a instalação do pacote por meio do GitHub não funciona, pois não fornece os meios necessários para construir o script. A partir daí, eles podem aceitar um PR para resolver isso com uma pós-instalação ou podem rejeitá-lo e você pode fazer o segundo.

Basta usar o comando npm install git+https://git@github.com/myRepo/angular-translate.git. Obrigado.