Is there a way to get version from package json in nodejs code

Question

Is there a way to get the version set in package json in a nodejs app  I would want something like this  var port   process env PORT    3000 app listen port console log  Express server listening on port  d in  s mode  s   app address   port  app settings env  app VERSION

User · Answer

Using ES6 modules you can do the following   import  version  from    package json

User · Answer

For those who look for a safe client-side solution that also works on server-side  there is genversion  It is a command-line tool that reads the version from the nearest package json and generates an importable CommonJS module file that exports the version  Disclaimer  I m a maintainer     genversion lib version js   I acknowledge the client-side safety was not OP s primary intention  but as discussed in answers by Mark Wallace and aug  it is highly relevant and also the reason I found this Q amp A

User · Answer

The leanest way I found  const   version     JSON parse fs readFileSync    package json

User · Answer

There is another way of fetching certain information from your package json file namely using pkginfo module   Usage of this module is very simple  You can get all package variables using   require  pkginfo   module     Or only certain details  version in this case   require  pkginfo   module   version      And your package variables will be set to module exports  so version number will be accessible via module exports version    You could use the following code snippet   require  pkginfo   module   version    console log  Express server listening on port  d in  s mode  s   app address   port  app settings env  module exports version     This module has very nice feature - it can be used in any file in your project  e g  in subfolders  and it will automatically fetch information from your package json  So you do not have to worry where you package json is   I hope that will help

User · Answer

Or in plain old shell    node -e  quot console log require    package json   version   quot   This can be shortened to   node -p  quot require    package json   version quot

User · Answer

I know this isn t the intent of the OP  but I just had to do this  so hope it helps the next person   If you re using docker-compose for your CI CD process  you can get it this way    version    image  node 7-alpine   volumes      -    usr src service    working dir   usr src service    command  ash -c  node -p   require    package json   version replace   n            for the image  you can use any node image  I use alpine because it is the smallest

User · Answer

If using rollup  the rollup-plugin-replace plugin can be used to add the version without exposing package json to the client      rollup config js  import pkg from    package json   import   terser   from  rollup-plugin-terser   import resolve from  rollup-plugin-node-resolve   import commonJS from  rollup-plugin-commonjs  import replace from  rollup-plugin-replace    export default     plugins        replace         exclude   node modules             MY PACKAGE JSON VERSION   pkg version     will replace  MY PACKAGE JSON VERSION  with package json version throughout source code                  Then  in the source code  anywhere where you want to have the package json version  you would use the string  MY PACKAGE JSON VERSION       src index js export const packageVersion    MY PACKAGE JSON VERSION     replaced with actual version number in rollup config js

User · Answer

NPM one liner  npm -s run env echo   npm package version

User · Answer

I found that the following code fragment worked best for me  Since it uses require to load the package json  it works regardless the current working directory   var pjson   require    package json    console log pjson version     A warning  courtesy of  Pathogen      Doing this with Browserify has security implications    Be careful not to expose your package json to the client  as it means that all your dependency version numbers  build and test commands and more are sent to the client    If you re building server and client in the same project  you expose your server-side version numbers too    Such specific data can be used by an attacker to better fit the attack on your server

User · Answer

Here is how to read the version out of package json  fs   require  fs   json   JSON parse fs readFileSync  package json    utf8    version   json version  EDIT  Wow  this answer was originally from 2012  There are several better answers now  Probably the cleanest is  const   version     require    package json

User · Answer

To determine the package version in node code  you can use the following    const version   require    package json   version  for  lt  ES6 versions import  version  from    package json   for ES6 version const version   process env npm package version  if application has been started using npm start  all npm   environment variables become available  You can use following npm packages as well - root-require  pkginfo  project-version

User · Answer

In case you want to get version of the target package  import   version   from  TARGET PACKAGE package json    Example  import   version   from  react package json

User · Answer

Just adding an answer because I came to this question to see the best way to include the version from package json in my web application    I know this question is targetted for Node js however  if you are using Webpack to bundle your app just a reminder the recommended way is to use the DefinePlugin to declare a global version in the config and reference that  So you could do in your webpack config json  const pkg   require        package json          plugins         new webpack DefinePlugin         AppVersion  JSON stringify pkg version         And then AppVersion is now a global that is available for you to use  Also make sure in your  eslintrc you ignore this via the globals prop

User · Answer

I am using gitlab ci and want to automatically use the different versions to tag my docker images and push them  Now their default docker image does not include node so my version to do this in shell only is this scripts getCurrentVersion sh BASEDIR   dirname  0  cat  BASEDIR    package json   grep   quot version quot     head -n 1   awk   print  2     sed  s  quot   g  s    g   Now what this does is  Print your package json Search for the lines with  quot version quot  Take only the first result Replace  quot  and    Please not that i have my scripts in a subfolder with the according name in my repository  So if you don t change  BASEDIR    package json to  BASEDIR package json Or if you want to be able to get major  minor and patch version I use this scripts getCurrentVersion sh VERSION TYPE  1 BASEDIR   dirname  0  VERSION   cat  BASEDIR    package json   grep   quot version quot     head -n 1   awk   print  2     sed  s  quot   g  s    g    if    VERSION TYPE    quot major quot     then   echo   echo  VERSION   awk -F  quot   quot    print  1     elif    VERSION TYPE    quot minor quot     then   echo   echo  VERSION   awk -F  quot   quot    print  1 quot   quot  2     else   echo  VERSION fi  this way if your version was 1 2 3  Your output would look like this    gt  sh   getCurrentVersion sh major 1    gt  sh   getCurrentVersion sh minor 1 2    gt  sh   getCurrentVersion sh 1 2 3  Now the only thing you will have to make sure is that your package version will be the first time in package json that key is used otherwise you ll end up with the wrong version

User · Answer

Option 1 Best practice is to version from package json using npm environment variables  process env npm package version  more information on  https   docs npmjs com using-npm config html This will work only when you start your service using NPM command   Quick Info  you can read any values in pacakge json  using process env npm package  keyname   Option 2 Setting version in environment variable using https   www npmjs com package dotenv as  env file and reading it as process env version

User · Answer

If your application is launched with npm start  you can simply use  process env npm package version  See package json vars for more details

User · Answer

Why don t use the require resolve     const packageJson   path dirname require resolve  package-name        package json   const   version     require packageJson   console log  version   version    With this approach work for all sub paths

User · Answer

There are two ways of retrieving the version    Requiring package json and getting the version    const   version     require    package json       Using the environment variables    const version   process env npm package version    Please don t use JSON parse  fs readFile  fs readFileSync and don t use another npm modules it s not necessary for this question

User · Answer

You can use ES6 to import package json to retrieve version number and output the version on console   import  name as app name  version as app version   from    path to package json    console log  App ----   app name  nVersion ----   app version

User · Answer

I do this with findup-sync   var findup   require  findup-sync    var packagejson   require findup  package json     console log packagejson version        gt   0 0 1

User · Answer

x000D   x000D  const   version     require    package json    console log version    const v   require    package json   version  console log v   x000D   x000D   x000D

User · Answer

You can use the project-version package     npm install --save project-version   Then  const version   require  project-version     console log version       gt    1 0 0    It uses process env npm package version but fallback on the version written in the package json in case the env var is missing for some reason

User · Answer

I made a useful code to get the parent module s package json  function loadParentPackageJson         if   module parent     module parent filename  return null     let dir   path dirname module parent filename      let maxDepth   5     let packageJson   null     while  maxDepth  gt  0            const packageJsonPath      dir  package json          const exists   existsSync packageJsonPath          if  exists                packageJson   require packageJsonPath              break                   dir   path resolve dir                 maxDepth--           return packageJson

User · Answer

Import your package json file into your server js or app js and then access package json properties into server file   var package   require    package json      package variable contains all the data in package json

[node.js] Is there a way to get version from package.json in nodejs code?

Examples related to node.js

Examples related to npm

Examples related to version

Examples related to versioning