Questa non è una domanda del tutto nuova, ma è da un bel po 'che mi guardo intorno e non riesco a trovare una soluzione.

Sto usando un modulo per la mia app angolare chiamato angular-translate. Tuttavia, ho dovuto apportare alcune piccole modifiche al codice sorgente per far funzionare tutto nel modo desiderato, e ora voglio mantenere tali modifiche npm install. Un collega ha suggerito di fare il fork del repo del codice sorgente e di indicare il mio repo forkato come dipendenza, che ho provato in questi modi, ad es.

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

Il primo mi dà una directory come questa senza build. Solo un package.json, .npmignore e alcuni file markdown

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

Il secondo npm installmi dà il repository completo, ma ancora una volta non ottengo una build come quando uso il comando npm install angular-translate. Ho visto alcune discussioni sull'esecuzione dello script di pre-pubblicazione, ma non sono sicuro di come farlo durante l'installazione di tutti i moduli. Ho anche provato a pubblicare il fork come modulo personale nel registro npm, ma ancora una volta non ho ricevuto alcuna build e non sono sicuro che sia la cosa giusta da fare ...

Mi scuso per la mia ignoranza sull'argomento. Non ho una grande esperienza con npm. Mi piacerebbe ricevere un feedback su questo problema. Sembra che potrebbe essere un problema abbastanza comune quando è necessario apportare modifiche al codice sorgente di un pacchetto? Forse c'è una soluzione migliore? Grazie in anticipo per il vostro aiuto.

Prova npm install <ghusername>/<repoName>, dov'è il <ghUsername>tuo nome utente GitHub (senza @) ed <repoName>è il nome del repository. Questo dovrebbe installarlo correttamente. Molto probabilmente vorrai usare il flag --saveo --save-devcon il comando install per salvare la dipendenza nel tuo file package.json.

Se non funziona correttamente, controlla il contenuto del tuo file .npmignore file.

Non fatevi prendere dal panico se il comando di installazione richiede molto tempo; l'installazione da un repository git è più lenta rispetto all'installazione dal registro npm.

Modificare:

Il tuo problema è che, nel tuo caso, dist/non è impegnato nel repo (poiché è nel file .gitignore). È qui che risiede il codice effettivo. dist/viene src/compilato dai file prima che il pacchetto venga pubblicato nel registro npm, madist/ non viene mai nel repository.

È brutto, ma in questo caso dovrai rimuovere dist/da .gitignoree quindi eseguire:

npm run build
git add .
git commit
git push

(Assicurati di aver eseguito npm install prima)

Dovresti quindi essere in grado di installare da GitHub.

Potrebbe esserci un altro modo per farlo utilizzando uno postinstallscript, ma non sono sicuro che sia possibile; Non l'ho mai provato.

Aggiornamento per coloro che utilizzano npm 5:

A partire da npm @ 5, gli prepublishscript sono deprecati.

Utilizzare prepareper passaggi di creazione e solo prepublishOnlyper il caricamento.

Ho scoperto che l'aggiunta di a "prepare": "npm run build"agli script ha risolto tutti i miei problemi.

Il codice pubblicato su npmjs.com spesso non è contenuto nel repository del pacchetto. È comune "compilare" i file sorgente JavaScript in versioni destinate al consumo generale nelle librerie. Questo è ciò che viene solitamente pubblicato su npmjs.com.

È così comune che è una caratteristica di npmeseguire automaticamente un passaggio di "build" prima di pubblicare ( npm publish). Questo era originariamente chiamato prepublish. Sembra che Npm abbia pensato che sarebbe stato utile eseguire lo prepublishscript anche su un filenpm install poiché quello era il modo standard per inizializzare un ambiente di sviluppo.

Ciò ha portato a una grande confusione nella comunità. Ci sono problemi molto lunghi su GitHub su questo.

Alla fine, nel tentativo di non modificare il vecchio comportamento, hanno deciso di aggiungere altri due script automatici: prepublishOnlyeprepare .

prepublishOnlyfa quello che ti aspetti. Non funzionanpm install . Molti manutentori di pacchetti sono passati ciecamente a questo.

Ma c'era anche questo problema che le persone volevano non dipendere da npmjs.com per distribuire le versioni dei pacchetti. I repository Git erano la scelta naturale. Tuttavia è pratica comune non eseguire il commit di file "compilati" in git. Questo è quello cheprepare stato aggiunto per gestire ...

prepare è il modo corretto

Se hai un repository con file sorgenti ma per usarlo è necessario un passaggio di "build",
preparefa esattamente quello che vuoi in tutti i casi (a partire da npm 4).

prepare: Eseguire entrambi PRIMA che il pacchetto venga compresso e pubblicato, in locale npm installsenza argomenti e durante l'installazione delle dipendenze git.

Puoi persino inserire le tue dipendenze di compilazione devDependenciese verranno installate prima preparedell'esecuzione.

Ecco un esempio di un mio pacchetto che utilizza questo metodo.

Problemi con .gitignore

C'è un problema con questa opzione che attira molte persone. Quando si prepara una dipendenza, Npm e Yarn manterranno solo i file elencati nella filessezione di package.json.

Si potrebbe vedere che filestutti i file sono inclusi per impostazione predefinita e pensare che siano finiti. Ciò che è facilmente sfuggito è che per .npmignore lo più sovrascrive la filesdirettiva e , se .npmignorenon esiste, .gitignoreviene utilizzato al suo posto.

Quindi, se avete i file incorporati elencati .gitignorecome una persona sana di mente, e non fare niente altro, preparevi sembrerà rotto

Se decidi filesdi includere solo i file compilati o aggiungi un vuoto .npmignore, sei pronto.

La mia raccomandazione è di impostare files(o, per inversione, .npmignore) in modo tale che gli unici file effettivamente pubblicati siano quelli necessari agli utenti del pacchetto pubblicato. Imho, non è necessario includere sorgenti non compilate nei pacchetti pubblicati.

Risposta originale: https://stackoverflow.com/a/57503862/4612476

Per cavalcare l'eccellente risposta di @ RyanZim, postinstall è sicuramente un'opzione valida per questo.

O eseguire una delle seguenti operazioni:

1. Aggiorna il package.json nel tuo repository biforcato per aggiungere un elemento di postinstallazione agli script. Qui, esegui tutto ciò di cui hai bisogno per ottenere l'output compilato (preferito).
2. Aggiorna il tuo package.json e aggiungi una postinstallazione che aggiorni la directory necessaria in node_modules.

Se hai biforcato il repository di un'altra persona, potrebbe valere la pena sollevare un problema per illustrare il problema che l'installazione del loro pacchetto tramite GitHub non funziona in quanto non fornisce i mezzi necessari per costruire lo script. Da lì, possono accettare un PR per risolverlo con una postinstallazione, oppure possono rifiutarlo e puoi fare # 2.

Usa semplicemente il comando npm install git+https://git@github.com/myRepo/angular-translate.git. Grazie.