commonjs规则

  • package.json必须放在顶层目录下
  • 二进制文件必须放在bin目录下
  • JavaScript代码必须放在lib目录下
  • 文档应该放在doc目录下

  • 单元测试必须放在test目录下

    npm包管理

    nodejs在调用某个包时，会先检查package.json中的main字段，将其作为包的接口模块。如通过package.json中不存在main字段，会去寻找index.js或index.node作为包的接口

    package.json

    package.json完全符合commonjs规范

  • name：包名称，必须唯一字段。

  • description：包的介绍说明
  • version：版本号
  • keywords：关键字，用于搜索(npm)
  • maintainers：维护者数组，每个元素都需要包含name，email（可选），web（可选）字段
  • contributors：贡献者数组，于上面一样。包作者应该放到第一位。
  • bugs：提交bug地址，可以是网址或邮箱
  • licenses：许可证数组，每个元素都要包含type（许可证名称）和url（连接到许可证的地方）字段
  • repositories：仓库托管地址数组，每个元素都要包含type（参考类型，入git）
  • url：仓库地址和path（相对于仓库的路径可选字段）
  • dependencies：生成环境包的依赖，一个关联数组，由包名称和版本号组成
  • devDependencies：开发环境包依赖，一个关联数组。由名称和版本号组成