npm 包和模块中的版本号

Question

我正在创作一个具有模块和命令行可执行文件的 npm 包。 npm 包has a version。

我希望我的模块知道这个版本，以便我可以从my_executable -v 报告它，并在输出中使用它（例如“由 MyPackage v1.3.2 生成”）。但是，我不想在两个地方（在我的模块和我的package.json）输入相同的版本号，因为在某些时候我肯定会搞砸并忘记更新一个或另一个。我怎么能……

• …从我的模块中导出版本，并让package.json 从我的模块中读取版本？
  • 使用 Ruby gem 我可以做到这一点，因为gemspec 文件是纯 Ruby 代码，可以加载模块并从派生代码填充参数。我认为这对于 npm/package.json 是不可能的？
• …或者，从我的模块中读取package.json 中指定的版本？
  • package.json 是否保证与我的模块一起安装在已知位置？我要怎么拉进去？手动读取 JSON 并解析它？

---

编辑：一个简单的let pkg = require('./package.json') 在我的情况下不起作用，因为我的项目文件结构：

mypackage/
  bin/myexecutable    # uses require('../lib/mymodule.js')
  lib/mymodule.js     # needs to load package.json
  package.json

Answer 1

您可以从package.json 中提取您的包的版本，如下所示：

let pkg = require('./package.json');

访问pkg.version获取版本例如：

console.log(pkg.version);

如果package.json 与您正在执行的文件不在同一目录中：

let pkg = require(__dirname + '/path/to/package.json')

Answer 2

1) 通用解决方案是：

const path = require('path');
// will be used to check file existence
const {accessSync} = require("fs");

function getMainPackage() {
  let mainModuleName, pathToPackage;

  const mainModuleNameOnError = {
    name: "unknown",
    version: "unknown",
  };

  try {
    mainModuleName = require.main.paths.find((modulesPath) => {
      pathToPackage = path.resolve(modulesPath, "..", "package.json");
      try {
        accessSync(pathToPackage);
      } catch (e) {
        return false;
      }
      return true;
    });
  } catch (e) {
    return mainModuleNameOnError;
  }

  return (mainModuleName)
    ? require(pathToPackage);
    : mainModuleNameOnError;
}

//example
const pkg = getMainPackage();
console.log(pkg.version);

2) 如果你知道你的 package.json 放在哪里：

let pkg = require(<the_packagejson_folder> + './package.json');
console.log(pkg.version);

3) 如果您的应用程序是使用“npm start”启动的，您可以简单地使用：

process.env.npm_package_version

更多详情请见package.json vars。