package.json字段解释

一、字段解释：参考网址

 

1. name：项目的名字，不要把node或者js放在名字中；
2. version：项目版本号，改变包的同时应该也改变版本号；
3. description ：描述包作用；
4. dependencies：指定项目运行时依赖的包名和版本号（或者版本号范围），可以用 file 配置本地依赖（在把包发不到公共registry时不要如此设置）；如

   {
       "name": "baz",
       "dependencies": {
           "bar": "file:../foo/bar"
       }
   }

    

5. devDependencies：如果有人计划在他们的项目中下载和使用你的模块，但他们可能并不想或并不需要你开发所使用的外部测试和文档框架，这些项将会在根目录下执行npm link或npm install时被安装；
6. engines：指定 node 或/和 npm 的工作版本，；
7. private： 可防止私包发布，设置true 时，npm会拒绝发布它；
8. repository ：指定代码存放位置，设置好后，项目推送到远程地址时可以只是用 npm publish；

   "repository" :
     { 
       "type" : "git",
       "url" : "http://github.com/isaacs/npm.git"
     }
   
   "repository" :
     { 
       "type" : "svn"，
        "url" : "http://v8.googlecode.com/svn/trunk/"
     }

9. scripts：由脚本命令组成的hash对象；
10. config：配置用于包脚本中的跨版本参数；
11. keywords：项目简介，方便npm search查询；
12. homepage：项目官网url，这和“url”不一样。如果你放一个“url”字段，registry会以为是一个跳转到你发布在其他地方的地址；
13. bugs：方便用户提交项目问题的url 或邮件地址；

    { 
        "url" : "http://github.com/owner/project/issues",
         "email" : "[email protected]"
    }

14.  license：许可证；
15. files：包含项目中文件的数组；
16. main：配置一个文件名指向模块的入口文件，这应该是一个相对于根目录的文件路径；
17. bin：配置一个或多个可执行的文件；
18. man：指定一个单一的文件或者一个文件数组供man程序使用；
19.  

二、注意事项：

1. package.json可以手工编写，也可以使用 npm init 命令自动生成；
2. package.json中添加中文注释会编译出错；
3. package.json中最重要的字段是 name 和 version。他们都是必须的，如果没有就无法install。name和version一起组成的标识在假设中是唯一的。改变包应该同时改变version。
4. 每个项目根目录下一般都有package.json文件，来定义项目需要的各种模块，以及项目配置信息；
5. package.json必须是真正的json，不能是js对象。