Depend on a branch or tag using a git URL in a package json

Question

Say I ve forked a node module with a bugfix and I want to use my fixed version  on a feature branch of course  until the bugfix is merged and released    How would I reference my fixed version in the dependencies of my package json

User · Answer

If it helps anyone  I tried everything above  https w token mode  - and still nothing was working  I got no errors  but nothing would be installed in node modules or package lock json  If I changed the token or any letter in the repo name or user name  etc  - I d get an error  So I knew I had the right token and repo name   I finally realized it s because the name of the dependency I had in my package json didn t match the name in the package json of the repo I was trying to pull  Even npm install --verbose doesn t say there s any problem  It just seems to ignore the dependency w o error

User · Answer

If you want to use devel or feature branch  or you haven   t published a certain package to the NPM registry  or you can   t because it   s a private module  then you can point to a git    URI instead of a version number in your package json    dependencies         public    git   github com user repo git ref       private    git ssh   git github com user repo git ref      The  ref portion is optional  and it can be a branch  like master   tag  like 0 0 1  or a partial or full commit id

User · Answer

From the npm docs   git   github com  lt user gt   lt project gt  git  lt branch gt   git   github com  lt user gt   lt project gt  git feature   lt branch gt    As of NPM version 1 1 65  you can do this    lt user gt   lt project gt   lt branch gt

User · Answer

per  dantheta s comment   As of npm 1 1 65  Github URL can be more concise user project  npmjs org doc files package json html You can attach the branch like user project branch  So  quot babel-eslint quot    quot babel babel-eslint quot    Or for tag v1 12 0 on jscs   quot jscs quot    quot jscs-dev node-jscs v1 12 0 quot    Note  if you use npm --save  you ll get the longer git From https   docs npmjs com cli v6 configuring-npm package-json git-urls-as-dependencies  Git URLs as Dependencies Git urls are of the form  git ssh   git github com npm cli git v1 0 27 git ssh   git github com npm cli semver  5 0 git https   isaacs github com npm cli git git   github com npm cli git v1 0 27   If   lt commit-ish gt  is provided  it will be used to clone exactly that commit  If  gt  the commit-ish has the format  semver  lt semver gt    lt semver gt  can be any valid semver range or exact version  and npm will look for any tags or refs matching that range in the remote repository  much as it would for a registry dependency  If neither   lt commit-ish gt  or  semver  lt semver gt  is specified  then master is used    GitHub URLs As of version 1 1 65  you can refer to GitHub urls as just  quot foo quot    quot user foo-project quot   Just as with git URLs  a commit-ish suffix can be included  For example      quot name quot    quot foo quot     quot version quot    quot 0 0 0 quot     quot dependencies quot         quot express quot    quot expressjs express quot       quot mocha quot    quot mochajs mocha 4727d357ea quot       quot module quot    quot user repo feature  branch quot

User · Answer

On latest version of NPM you can just do   npm install gitAuthor gitRepo tag  If the repo is a valid NPM package it will be auto-aliased in package json as        NPMPackageName    gitAuthor gitRepo tag     If you could add this to  justingordon  s answer there is no need for manual aliasing now

[git] Depend on a branch or tag using a git URL in a package.json?

Examples related to git

Examples related to dependencies

Examples related to npm

Examples related to branch

Examples related to git-tag