如何在npm脚本中引用包版本？

Question

我想在npm脚本中引用我的包版本,以便在应用程序中显示当前版本.就像是

{
  "name": "bla",
  "version": "1.0.0",
  "author": "bla bla",
  "scripts": {
    "build": "node VERSION=<<package.version>> build/build.js"
  }
}

有没有办法做到这一点？

Answer 1

1)在npm-scripts中引用包版本.

在npm-script的,你可以参考version使用变量npm_package_version.例如:

• 使用bash shell(例如Linux,macOS):

  {
    ...
    "version": "1.0.0",
    "scripts": {
      "build": "echo $npm_package_version"
    }
  }
  

  注意$前缀

• 使用Windows(例如cmd.exe,Powershell):

  {
    ...
    "version": "1.0.0",
    "scripts": {
      "build": "echo %npm_package_version%"
    }
  }
  

  请注意%前缀和后缀

• 跨平台

  要使用跨平台的一种语法,请查看包交叉变量

2)在节点脚本中引用包版本.

包版本也可以在您的app/node脚本(即build.js)中引用,如下所示:

const VERSION = process.env.npm_package_version;
console.log(VERSION); // --> 1.0.0

3)用包版本替换.js文件中的占位符字符串.

另一种实现此目的的方法是在JavaScript文件中指定占位符文本字符串.假设我们有一个名为的文件,build.js并且在该文件中我们有一个名为VERSION如下声明的变量:

// build.js
const VERSION = '@VERSION@'

如您所见,占位符文本字符串是@VERSION@.

然后,您可以在npm脚本中安装和使用名为replace的包,如下所示:

{
  ...
  "version": "1.0.0",
  "scripts": {
    "add-version":  "replace -s \"@VERSION@\" $npm_package_version build/build.js"
  }
}

运行npm run add-version将在名为的文件中替换@VERSION@包版本(即1.0.0)的实例build.js.此解决方案将npm软件包版本硬编码到生成的文件中.

注意:脚本中的to字符串add-version(上面)当前使用$前缀(即$npm_package_version)来访问变量,因此这只能在bash shell上成功运行.但是,对于跨平台使用,您需要cross-var按照第一部分(上文)中的说明使用.在这种情况下,add-version脚本可以定义如下:

{
  ...
  "version": "1.0.0",
  "scripts": {
    "add-version":  "cross-var replace -s \"@VERSION@\" $npm_package_version build/build.js"
  }
}