NPM Link：获取安装包的路径

Question

我尝试构建我的第一个 npm 包，但现在卡住了。

我想从我的包中加载一个位于我的测试项目根目录中的配置文件

我使用“npm link my-package”来安装它的语言环境以进行测试（如果这很重要）

这是我的文件夹结构

- my-package 
- test-project
  - node-modules 
    - my-package (npm link)
  - config.json

这个包是一个 vuejs 应用，应该启动一个服务器并提供一个页面

我从我的测试项目运行这个脚本

"scripts": {
  "generatePage": "npm explore my-package -- npm run serve"
},

我的包中的脚本

"scripts": {
  "serve": "node readFile.js & vue-cli-service serve"
},

我的包/readFile.js

file_path = path.join(process.cwd(), 'config.json')
console.log('file_path', file_path)

如果我正在运行我的脚本，我会得到这条路径/Users/name/work/my-package/config.json，但我需要/Users/name/work/test-project/config.json

如何获得正确的路径？

Answer 1

当您编写一个将被另一个代码库使用的库时，您无法确定 NPM 或 yarn（或您选择的任何包管理器）将安装您的库的确切位置。它可能直接在node_modules 中，但可能会根据用例嵌套。但是，正如stackoverflow 的答案here 所示，process.main.filename 变量将告诉我们调用我们的主进程的确切位置。我们可以使用这个值来确定你要读取的配置文件在哪里。

下面是一些示例代码：

config-lib 库读取配置。

index.js文件：

const fs = require("fs");
const path = require("path");
const promisify = require("util").promisify;

const readFilep = promisify(fs.readFile);

module.exports = async function loadConfig(filename = "config.json") {
  const configPath = path.resolve(
    path.dirname(require.main.filename),
    filename
  );
  console.log("(load-config lib) Config Path: " + configPath);
  try {
    const data = await readFilep(configPath, "utf8");
    return JSON.parse(data);
  } catch (err) {
    console.log(err);
  }
};

这个库有一个简单的package.json

{
  "name": "config-lib",
  "version": "1.0.0",
  "description": "I read a config",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Some Cool Guy <somecoolguy@example.com>",
  "license": "MIT"
}

现在项目本身需要这个库。这里是项目package.json

{
  "name": "project",
  "version": "1.0.0",
  "description": "I am the project",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Some Other Cool Guy <someoneelse@example.com>",
  "license": "MIT",
  "dependencies": {
    "config-lib": "file:../lib"
  }
}

（此示例中的 config-lib 库是从本地文件夹加载的。）

config-lib 库要求我在我的项目中创建一个名为 config.json 的配置文件（顺便说一句……将其命名为更具体到您的库的名称，以免与本地项目配置发生冲突（如果有的话） )。

这是一个例子config.json：

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

最后，在我的项目中，我可以使用config-lib 库来读取我的配置文件：

const configLib = require("config-lib");

(async () => {
  console.log("Reading config");
  const data = await configLib();

  console.log("Here is my config: " + JSON.stringify(data));
  console.log("key1 value: " + data.key1);
})();