如何从 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

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

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

编辑

既然你好像在用webpack，就添加合适的loader

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

显然你需要使用npm install

Answer 2

对于为浏览器设计且不依赖于 Webpack 或任何其他依赖项的库，我喜欢这样做的方式是向package.json添加一个prebuild脚本，将版本写入文件。

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

这将使用以下代码运行 node.js：

'export const LIB_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'

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

这导致version.ts包含：

export const LIB_VERSION = "1.0.0";

然后，您可以简单地从其他文件导入和使用它：

import { LIB_VERSION } from './version';

Answer 3

有多种方法，但我发现最有用的方法是使用 ng-node-environment 包。 这会生成一个文件./src/environments/base.ts ，您可以在打字稿导入中直接引用该文件。 它包含一个名为sharedEnvironment的常量对象。 您的导入行如下所示： import sharedEnvironment from './base' ;

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

因此，我创建了一个package.json脚本来设置变量并执行 ng-node-environment。 为了兼容性，我使用 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并在我的environment.ts使用它。

注意：如果我调用了变量NG_APP_Version则属性名称将使用驼峰式appVersion为appVersion

import sharedEnvironment from './base';

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

当然，这样我可以通过在执行ng-node-environment之前设置其他变量来添加package.json的其他值，或者可以通过创建名为NG_<Something>变量来提前添加更多属性，例如： NG_GitBranch 、 NG_ComputerName 、 NG_CliVersion等

在 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 4

为了避免包含整个 package.json 文件，我通常会创建一个名为buildData.json的模板并将其放在templates文件夹中。 我给它以下内容。

{
    "version": [<%= options.version %>]
}

然后在nuxt.config.js中，将模板添加到构建部分：

  build: {
    templates: [
      {
        src: "./templates/buildData.json",
        dst: "../buildData.json",
        options: {
          version: require("./package.json").version
        }
      }
    ]
  }

这将生成仅包含版本号的buildData.json文件。 完整的package.json文件在构建时只读，不包括发送到浏览器的文件。

最后，在需要版本号的地方添加此代码：

const version = require("@/buildData.json").version;

确保您提供给require语句的文件是生成的buildData.json而不是templates文件夹中的文件。