如何从Typescript中的package.json获取版本？

Question

我发现了这个问题

我已尝试使用以下方法从package.json获取版本：

import { version } from './package.json';

但结果是：

package.json' has unsupported extension. The only supported extensions are '.ts',
'.tsx', '.d.ts'.

Answer 1

有多种方法，但我发现最有用的方法是使用ng node环境包。这将生成一个文件/src/environments/base.ts，您可以在typescript导入中直接引用该文件。它包含一个名为sharedEnvironment的常量对象。您的导入行如下所示：从“/base”导入sharedEnvironment；

当您执行该命令时，它会查找以“NG”开头的所有环境变量，并将它们作为属性添加到sharedEnvironment。

因此，我创建了一个package.json脚本，用于设置变量并执行ng节点环境。为了兼容性，我使用了cross-env使其平台无关（适用于windows和*nix）

这是我的package.json剧本：-

"scripts": {
    "version": "cross-env-shell NG_APPVERSION=$npm_package_version node ./node_modules/ng-node-environment/index.js",
    "another" : "echo hello world"
}

然后运行：npm run version提取版本并将其放入/src/environments/base.ts

我现在可以访问属性appversion，并在我的环境中使用它。ts。

注意：如果我调用了变量NG_APP_Version，则属性名称将以驼峰形式显示在appVersion

import sharedEnvironment from './base';

export const environment = {
  production: false,
  logLevel: LogLevel.Error,
  version : sharedEnvironment.appversion,
};

当然，通过这种方式，我可以在执行ng-node-环境之前通过设置其他变量来添加package.json中的其他值，或者可以通过创建名为的变量来提前添加更多属性NG_

在Angular中开发时，为了确保它始终同步，我使用一个开始脚本开始开发：-

"scripts": {
    "version": "cross-env-shell NG_APPVERSION=$npm_package_version node ./node_modules/ng-node-environment/index.js",
    "start": "npm run version && ng serve"
}

所以我键入：npm start，它会同步版本号、构建和启动

Answer 2

如果您在commonJS环境中，为什么不简单地使用

const pj = require('./package.json')
console.log(pj.version)

编辑

由于您似乎正在使用webpack，只需添加适当的加载程序

   module: {
    loaders: [
        ...
        {test: /\.json$/, loader: 'json-loader'},
        ....

很明显，你需要使用npm安装来安装它

Answer 3

我喜欢对为浏览器设计的库这样做，而不依赖于Webpack或任何其他依赖项的方式是将一个预构建脚本添加到将版本写入TypeScript的package.json可以在其他地方导入的源文件。

  "scripts": {
    "prebuild": "node -p \"'export const LIB_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/version.ts",
    "build": "tsc",
  }

此节点使用以下代码运行：

'导出常量LIB_VERSION='JSON. stringify（需要（'./package.json'）. version) ';'

并将输出重定向到src/version.ts

这将导致version.ts包含：

export const LIB_VERSION=“1.0.0”

然后，您只需从其他文件导入并使用此文件：

从“/VERSION”导入{LIB_VERSION}

您可能想从源代码管理中排除src/version.ts，这样它的更改就不会浪费您的更改历史！