update package json version automatically

Question

Before I do a small release and tag it  I d like to update the package json to reflect the new version of the program   Is there a way to edit the file package json automatically   Would using a git pre-release hook help

User · Answer

Just in case if you want to do this using an npm package semver link

let fs = require('fs');
let semver = require('semver');

if (fs.existsSync('./package.json')) {
    var package = require('./package.json');
    let currentVersion = package.version;
    let type = process.argv[2];
    if (!['major', 'minor', 'patch'].includes(type)) {
        type = 'patch';
    }

    let newVersion = semver.inc(package.version, type);
    package.version = newVersion;
    fs.writeFileSync('./package.json', JSON.stringify(package, null, 2));

    console.log('Version updated', currentVersion, '=>', newVersion);
}

package.json should look like,

{
  "name": "versioning",
  "version": "0.0.0",
  "description": "Update version in package.json using npm script",
  "main": "version.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "version": "node version.js"
  },
  "author": "Bhadresh Arya",
  "license": "ISC",
  "dependencies": {
    "semver": "^7.3.2"
  }
}

just pass major, minor, patch argument with npm run version. Default will be patch.

example: npm run version or npm run verison patch or npm run verison minor or npm run version major

Git Repo

User · Answer

If you are using yarn you can use   yarn version --patch   This will increment package json version by patch  0 0 x   commit  and tag it with format v0 0 0  Likewise you can bump minor or major version by using --minor or --major  When pushing to git ensure you also push the tags with --follow-tags  git push --follow-tags   You can also create a script for it       release-it    yarn version --patch  amp  amp  git push --follow-tags    Simply run it by typing yarn release-it

User · Answer

npm version is probably the correct answer  Just to give an alternative I recommend grunt-bump  It is maintained by one of the guys from angular js   Usage   grunt bump  gt  gt  Version bumped to 0 0 2  grunt bump patch  gt  gt  Version bumped to 0 0 3  grunt bump minor  gt  gt  Version bumped to 0 1 0  grunt bump  gt  gt  Version bumped to 0 1 1  grunt bump major  gt  gt  Version bumped to 1 0 0   If you re using grunt anyway it might be the simplest solution

User · Answer

As an addition to npm version you can use the --no-git-tag-version flag if you want a version bump but no tag or a new commit   npm --no-git-tag-version version patch   https   docs npmjs com cli version

User · Answer

With Husky       quot name quot    quot demo-project quot      quot version quot    quot 0 0 3 quot      quot husky quot          quot hooks quot            quot pre-commit quot    quot npm --no-git-tag-version version patch  amp  amp  git add   quot

User · Answer

You can use the version-select package  npm i -D version-select         quot name quot    quot test quot        quot version quot    quot 1 0 0 quot        quot scripts quot              quot version-select quot    quot version-select quot              quot devDependencies quot              quot version-select quot    quot  1 0 13 quot             Read more

User · Answer

This is what I normally do with my projects   npm version patch git add    git commit -m  Commit message  git push npm publish   The first line  npm version patch  will increase the patch version by 1  x x 1 to x x 2  in package json  Then you add all files -- including package json which at that point has been modified  Then  the usual git commit and git push  and finally npm publish to publish the module   I hope this makes sense     Merc

User · Answer

I want to add some clarity to the answers this question got   Even thought there are some answers here that are tackling properly the problem and providing a solution  they are not the correct ones  The correct answer to this question is to use npm version     Is there a way to edit the file package json automatically    Yes  what you can do to make this happen is to run the npm version command when needed  you can read more about it here npm version  but the base usage would be npm version patch and it would add the 3rd digit order on your package json version  1 0 X      Would using a git pre-release hook help    You could configure to run the npm version command on the pre-release hook  as you need  but that depends if that is what you need or not in your CD CI pipe  but without the npm version command a git pre-release hook can t do anything  easily  with the package json   The reason why npm version is the correct answer is the following    If the user is using a folder structure in which he has a package json he is using npm if he is using npm he has access to the npm scripts  If he has access to npm scripts he has access to the npm version command   Using this command he doesn t need to install anything more in his computer or CD CI pipe which on the long term will reduce the maintainability effort for the project  and will help with the setup   The other answers in which other tools are proposed are incorrect   gulp-bump works but requires another extra package which could create issues in the long term  point 3 of my answer   grunt-bump works but requires another extra package which could create issues in the long term  point 3 of my answer

User · Answer

I am using husky and git-branch-is   As of husky v1       package json      husky          hooks            post-merge     git-branch-is master  amp  amp  npm version minor        git-branch-is dev  amp  amp  npm --no-git-tag-version version patch                  Prior to husky V1    scripts              postmerge     git-branch-is master  amp  amp  npm version minor        git-branch-is dev  amp  amp  npm --no-git-tag-version version patch               Read more about npm version  Webpack or Vue js  If you are using webpack or Vue js  you can display this in the UI using Auto inject version - Webpack plugin  NUXT  In nuxt config js   var WebpackAutoInject   require  webpack-auto-inject-version     module exports       build        plugins          new WebpackAutoInject              options            example          components              InjectAsComment  false                                     Inside your template for example in the footer    lt p gt  All rights reserved    2018  v AIV  version   AIV   lt  p gt

User · Answer

To give a more up-to-date approach   package json     scripts          eslint    eslint index js        pretest    npm install        test    npm run eslint        preversion    npm run test        version            postversion    git push  amp  amp  git push --tags  amp  amp  npm publish        Then you run it   npm version minor --force -m  Some message to commit    Which will        run tests     change your package json to a next minor version  e g  1 8 1 to 1 9 0  push your changes create a new git tag release and publish your npm package    --force is to show who is the boss  Jokes aside see https   github com npm npm issues 8620

User · Answer

Right answer  To do so  just npm version patch     My old answer  There is no pre-release hook originally in git  At least  man githooks does not show it   If you re using git-extra  https   github com visionmedia git-extras   for instance  you can use a pre-release hook which is implemented by it  as you can see at https   github com visionmedia git-extras blob master bin git-release  It is needed only a  git hook pre-release sh executable file which edits your package json file  Committing  pushing and tagging will be done by the git release command   If you re not using any extension for git  you can write a shell script  I ll name it git-release sh  and than you can alias it to git release with something like   git config --global alias release   sh path to pre-release sh  1   You can  than  use git release 0 4 which will execute path to pre-release sh 0 4  Your script can edit package json  create the tag and push it to the server

User · Answer

First  you need to understand the rules for upgrading the versioning number  You can read more about the semantic version here   Each version will have x y z version where it defines for different purpose as shown below    x - major  up this when you have major changes and it is huge discrepancy of changes occurred   y - minor  up this when you have new functionality or enhancement occurred   z - patch  up this when you have bugs fixed or revert changes on earlier version    To run the scripts  you can define it in your package json    script          buildmajor    npm version major  amp  amp  ng build --prod        buildminor    npm version minor  amp  amp  ng build --prod        buildpatch    npm version patch  amp  amp  ng build --prod      In your terminal  you just need to npm run accordingly to your needs like   npm run buildpatch   If run it in git repo  the default git-tag-version is true and if you do not wish to do so  you can add below command into your scripts   --no-git-tag-version   for eg   npm --no-git-tag-version version major  amp  amp  ng build --prod

User · Answer

I have created a tool that can accomplish automatic semantic versioning based on the tags in commit messages  known as change types  This closely follows the Angular Commit Message Convention along with the Semantic Versioning Specification   You could use this tool to automatically change the version in the package json using the npm CLI  this is described here     In addition  it can create a changelog from these commits and also has a menu  with a spell checker for commit messages  for creating commits based on the change type  I highly recommend checking it out and reading to docs to see everything that can be accomplished with it   I wrote the tool because I couldn t find anything that suited my needs for my CICD Pipeline to automate semantic versioning  I d rather focus on what the actual changes are than what the version should be and that s where my tool saves the day   For more information on the rationale for the tool  please see this

[git] update package.json version automatically

Examples related to git

Examples related to node.js

Examples related to npm

Examples related to githooks