Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

npm-version (1)

Name

npm-version - Bump a package version Synopsis npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git] 'npm [-v | --version]' to print npm version 'npm view <pkg> version' to view a package's published version 'npm ls' to inspect current package/dependency versions Configuration <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/defini- tions.js --> allow-same-version o Default: false o Type: Boolean Prevents throwing an error when npm version is used to set the new ver- sion to the same value as the current version. <!-- automatically gen- erated, do not edit manually --> <!-- see lib/utils/config/defini- tions.js --> commit-hooks o Default: true o Type: Boolean Run git commit hooks when using the npm version command. <!-- automat- ically generated, do not edit manually --> <!-- see lib/utils/con- fig/definitions.js --> git-tag-version o Default: true o Type: Boolean Tag the commit when using the npm version command. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/defini- tions.js --> json o Default: false o Type: Boolean Whether or not to output JSON data, rather than the normal output. o In npm pkg set it enables parsing set values with JSON.parse() before saving them to your package.json. Not supported by all npm commands. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> preid o Default: "" o Type: String The "prerelease identifier" to use as a prefix for the "prerelease" part of a semver. Like the rc in 1.2.0-rc.8. <!-- automatically gener- ated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> sign-git-tag o Default: false o Type: Boolean If set to true, then the npm version command will tag the version using -s to add a signature. Note that git requires you to have set up GPG keys in your git configs for this to work properly. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> workspace o Default: o Type: String (can be set multiple times) Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option. Valid values for the workspace config are either: o Workspace names o Path to a workspace directory o Path to a parent workspace directory (will result to selecting all of the nested workspaces) When set for the npm init command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project. This value is not exported to the environment for child processes. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> workspaces o Default: false o Type: Boolean Enable running a command in the context of all the configured workspaces. This value is not exported to the environment for child processes. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> Description Run this in a package directory to bump the version and write the new data back to package.json, package-lock.json, and, if present, npm-shrinkwrap.json. The newversion argument should be a valid semver string, a valid second argument to semver.inc https://github.com/npm/node-semver#functions (one of patch, minor, major, prepatch, preminor, premajor, prerelease), or from-git. In the second case, the existing version will be incre- mented by 1 in the specified field. from-git will try to read the lat- est git tag, and use that as the new npm version. If run in a git repo, it will also create a version commit and tag. This behavior is controlled by git-tag-version (see below), and can be disabled on the command line by running npm --no-git-tag-version ver- sion. It will fail if the working directory is not clean, unless the -f or --force flag is set. If supplied with -m or --message config option, npm will use it as a commit message when creating a version commit. If the message config contains %s then that will be replaced with the resulting version num- ber. For example: npm version patch -m "Upgrade to %s for reasons" If the sign-git-tag config is set, then the tag will be signed using the -s flag to git. Note that you must have a default GPG key set up in your git config for this to work properly. For example: $ npm config set sign-git-tag true $ npm version patch You need a passphrase to unlock the secret key for user: "isaacs (http://blog.izs.me/) <i@izs.me>" 2048-bit RSA key, ID 6C481CF6, created 2010-08-31 Enter passphrase: If preversion, version, or postversion are in the scripts property of the package.json, they will be executed as part of running npm version. The exact order of execution is as follows: 1. Check to make sure the git working directory is clean before we get started. Your scripts may add files to the commit in future steps. This step is skipped if the --force flag is set. 2. Run the preversion script. These scripts have access to the old ver- sion in package.json. A typical use would be running your full test suite before deploying. Any files you want added to the commit should be explicitly added using git add. 3. Bump version in package.json as requested (patch, minor, major, etc). 4. Run the version script. These scripts have access to the new version in package.json (so they can incorporate it into file headers in generated files for example). Again, scripts should explicitly add generated files to the commit using git add. 5. Commit and tag. 6. Run the postversion script. Use it to clean up the file system or automatically push the commit and/or tag. Take the following example: { "scripts": { "preversion": "npm test", "version": "npm run build && git add -A dist", "postversion": "git push && git push --tags && rm -rf build/temp" } } This runs all your tests and proceeds only if they pass. Then runs your build script, and adds everything in the dist directory to the commit. After the commit, it pushes the new commit and tag up to the server, and deletes the build/temp directory. See Also o npm help init o npm help run-script o npm help scripts o npm help package.json o npm help config

Synopsis

Please see following description for synopsis

Description

NPM-VERSION(1)                                                  NPM-VERSION(1)



NAME
       npm-version - Bump a package version

   Synopsis
         npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]

         'npm [-v | --version]' to print npm version
         'npm view <pkg> version' to view a package's published version
         'npm ls' to inspect current package/dependency versions

   Configuration
       <!--  AUTOGENERATED  CONFIG  DESCRIPTIONS  START --> <!-- automatically
       generated, do not edit manually --> <!--  see  lib/utils/config/defini-
       tions.js -->

   allow-same-version
       o Default: false

       o Type: Boolean


       Prevents throwing an error when npm version is used to set the new ver-
       sion to the same value as the current version.  <!-- automatically gen-
       erated,  do  not  edit  manually  --> <!-- see lib/utils/config/defini-
       tions.js -->


   commit-hooks
       o Default: true

       o Type: Boolean


       Run git commit hooks when using the npm version command.  <!-- automat-
       ically  generated,  do  not  edit  manually --> <!-- see lib/utils/con-
       fig/definitions.js -->


   git-tag-version
       o Default: true

       o Type: Boolean


       Tag the commit when using the npm version command.  <!--  automatically
       generated,  do  not edit manually --> <!-- see lib/utils/config/defini-
       tions.js -->


   json
       o Default: false

       o Type: Boolean


       Whether or not to output JSON data, rather than the normal output.

       o In npm pkg set it enables parsing set values with JSON.parse() before
         saving them to your package.json.


       Not  supported  by  all npm commands.  <!-- automatically generated, do
       not edit manually --> <!-- see lib/utils/config/definitions.js -->


   preid
       o Default: ""

       o Type: String


       The "prerelease identifier" to use as a  prefix  for  the  "prerelease"
       part of a semver. Like the rc in 1.2.0-rc.8.  <!-- automatically gener-
       ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
       -->


   sign-git-tag
       o Default: false

       o Type: Boolean


       If set to true, then the npm version command will tag the version using
       -s to add a signature.

       Note that git requires you to have set up GPG keys in your git  configs
       for  this  to work properly.  <!-- automatically generated, do not edit
       manually --> <!-- see lib/utils/config/definitions.js -->


   workspace
       o Default:

       o Type: String (can be set multiple times)


       Enable running a command in the context of the configured workspaces of
       the  current  project  while  filtering  by running only the workspaces
       defined by this configuration option.

       Valid values for the workspace config are either:

       o Workspace names

       o Path to a workspace directory

       o Path to a parent workspace directory (will result to selecting all of
         the nested workspaces)


       When  set  for the npm init command, this may be set to the folder of a
       workspace which does not yet exist, to create the folder and set it  up
       as a brand new workspace within the project.

       This  value  is  not  exported  to the environment for child processes.
       <!-- automatically  generated,  do  not  edit  manually  -->  <!--  see
       lib/utils/config/definitions.js -->


   workspaces
       o Default: false

       o Type: Boolean


       Enable  running  a  command  in  the  context  of  all  the  configured
       workspaces.

       This value is not exported to  the  environment  for  child  processes.
       <!--  automatically  generated,  do  not  edit  manually  -->  <!-- see
       lib/utils/config/definitions.js -->

       <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->


   Description
       Run this in a package directory to bump the version and write  the  new
       data   back   to  package.json,  package-lock.json,  and,  if  present,
       npm-shrinkwrap.json.

       The newversion argument should be a valid semver string, a valid second
       argument   to  semver.inc  https://github.com/npm/node-semver#functions
       (one of patch, minor, major, prepatch, preminor, premajor, prerelease),
       or  from-git.  In  the second case, the existing version will be incre-
       mented by 1 in the specified field.  from-git will try to read the lat-
       est git tag, and use that as the new npm version.

       If  run  in  a  git repo, it will also create a version commit and tag.
       This behavior is controlled by git-tag-version (see below), and can  be
       disabled  on  the command line by running npm --no-git-tag-version ver-
       sion.  It will fail if the working directory is not clean,  unless  the
       -f or --force flag is set.

       If  supplied  with  -m or --message config option, npm will use it as a
       commit message when creating a version commit.  If the  message  config
       contains  %s then that will be replaced with the resulting version num-
       ber.  For example:

         npm version patch -m "Upgrade to %s for reasons"

       If the sign-git-tag config is set, then the tag will  be  signed  using
       the  -s  flag to git.  Note that you must have a default GPG key set up
       in your git config for this to work properly.  For example:

         $ npm config set sign-git-tag true
         $ npm version patch

         You need a passphrase to unlock the secret key for
         user: "isaacs (http://blog.izs.me/) <i@izs.me>"
         2048-bit RSA key, ID 6C481CF6, created 2010-08-31

         Enter passphrase:

       If preversion, version, or postversion are in the scripts  property  of
       the package.json, they will be executed as part of running npm version.

       The exact order of execution is as follows:

       1. Check  to make sure the git working directory is clean before we get
          started.  Your scripts may add files to the commit in future  steps.
          This step is skipped if the --force flag is set.

       2. Run the preversion script. These scripts have access to the old ver-
          sion in package.json.  A typical use would be running your full test
          suite  before  deploying.   Any  files  you want added to the commit
          should be explicitly added using git add.

       3. Bump version in package.json  as  requested  (patch,  minor,  major,
          etc).

       4. Run the version script. These scripts have access to the new version
          in package.json (so they can incorporate it  into  file  headers  in
          generated  files for example).  Again, scripts should explicitly add
          generated files to the commit using git add.

       5. Commit and tag.

       6. Run the postversion script. Use it to clean up the  file  system  or
          automatically push the commit and/or tag.


       Take the following example:

         {
           "scripts": {
             "preversion": "npm test",
             "version": "npm run build && git add -A dist",
             "postversion": "git push && git push --tags && rm -rf build/temp"
           }
         }

       This runs all your tests and proceeds only if they pass. Then runs your
       build script, and adds everything in the dist directory to the  commit.
       After  the  commit,  it pushes the new commit and tag up to the server,
       and deletes the build/temp directory.

   See Also
       o npm help init

       o npm help run-script

       o npm help scripts

       o npm help package.json

       o npm help config




ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | runtime/nodejs/nodejs-16 |
       +---------------+--------------------------+
       |Stability      | Pass-thru volatile       |
       +---------------+--------------------------+

NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from     https://github.com/nodejs/node/ar-
       chive/v16.11.1.zip.

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                 October 2021                   NPM-VERSION(1)