Skip to content

面向Web的包描述规范 v1

元彦 edited this page Jul 23, 2013 · 2 revisions

包描述文件

使用与Node.js社区一致的package.json文件。

package.json 配置

package.json 配置是对NPM配置的扩展,在NPM配置的基础上只引入了 webDependencies 顶级配置项,避免配置规则的冲突:

{
   "name": "playground",
   "version": "1.0.0",
   "main" : "./src/module.js",
   "webDependencies" : {
       "jquery" : "latest" 
   }
}

必选配置项

  • name: 模块名只能包含小写字母数字和中划线
  • version: 版本号

可选配置项

  • webDependencies: 模块依赖
  • license: 版本声明
  • description: 模块描述
  • author: 模块作者信息
  • repository: 模块项目地址
  • tests: 测试用例

版本规则

版本号主体由 3 组数字组成的 <主版本号>.<次版本号>.<补丁版本号> 格式,并且约定开发中的模块版本号应加上 -dev 后缀:

1.0.0
0.1.1-dev
  • 进行不向下兼容的修改时增长主版本号
  • 增加API但保持向下兼容时增长次版本号
  • Bug修复但不影响API时增长补丁版本号

更多语义版本内容请访问 http://semver.org/

模块依赖版本条件

latest        :=    latest
>1.2.3        :=    >1.2.3
<1.2.3        :=    <1.2.3
~1.2.3        :=    >=1.2.3 <1.3.0
~1.2          :=    >=1.2.0 <2.0.0
~1            :=    >=1.0.0 <2.0.0
1.2.x         :=    >=1.2.0 <1.3.0
1.x           :=    >=1.0.0 <2.0.0
1.2.3 - 2.3.4 :=    >=1.2.3 <=2.3.4