Is there any documentation on the package.json file?

Question

Here's an instance of the package.json file that express.js generates

{
    "name": "packagename",
    "version": "0.0.1",
    "private": true,
    "dependencies": {
        "express": "2.5.5",
        "stylus": "0.22.2"
    }
}

It's fairly obvious that I can add packages to the dependencies object. However I have no idea what "private": true means. Nor do I know what syntax I can use in the dependencies value fields. I've Googled for quite a while without discovering anything.

What I'm wondering is pretty much if a complete summary of all settings that the package.json file can contain exists, as I could not find one. I haven't checked man since I'm on a windows PC.

Thanks

Answer 1

You're looking for the output of npm help json . It is available in Markdown format on NPM's GitHub project .

Also check out this interactive guide :

Answer 2

除了来自NPM的package.json的官方指南之外，来自Nodejitsu的人们为它做了一个很好的备忘单： http ：//package.json.nodejitsu.com/

Answer 3

I've found this very useful...

https://npmjs.org/doc/json.html

Answer 4

A package.json cheatsheet . The most beautiful documentation that I could find for package.json.