NPM模块-如何利用package.json文件？

Question

I'm writing a NPM module for a cli-based tool. After someone installs the package, I need to read their package.json file. I know how to read the file in syntax. My question is, how can I consistenly retrieve the package.json file and should I use relative or absolute paths.

So, after installing, my code would reside somewhere inside the node_modules folder:

package.json // I need to require this file
node_modules/
  ↳ my-package/
    ↳ dist/
      ↳ my-package.js // the actual file running the code

Any suggestions/best practices? Or is it just a matter of using the right filepath?

Answer 1

Reading the package.json file is very easy, as you can simply require it:

var package = require('./path/to/package.json');

Finding the right path is what's not so simple.

This is quite a common task and there is no simple way to achieve that with core modules but there are few modules on npm that can help you with that.

find-package-json:

Easily find package.json files that you're searching for. It spiders parent directories for package.json files and correctly reads the results. It follows an ES6 iterator design so it should be easy to implement.

parent-package-json:

Using parent-package-json, you can find the parent package.json, so the package.json of the module that uses your module.

find-and-read-package-json:

Find and read data from a package.json file.

See:

• https://www.npmjs.com/package/find-package-json
• https://www.npmjs.com/package/parent-package-json
• https://www.npmjs.com/package/find-and-read-package-json