包结构规范 (1.1)

李玉北、erik、黄后锦、王杨、张立理、赵雷。

本文档由商业运营体系前端技术组审校发布。

要求

在本文档中，使用的关键字会以中文+括号包含的关键字英文表示：必须(MUST)。关键字”MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL”被定义在rfc2119中。

规范说明约定

以下规范文档中，以${root}表示包的根目录。

包开发说明

包定义

模块定义

包中的模块定义时 必须(MUST) 采用匿名iddefine( factory )进行定义， 不允许(MUST NOT) 使用define( moduleId, factory )。

依赖管理

包中的模块对其他模块的依赖分成两种：内部模块依赖和外部包依赖。下面是关于模块依赖的管理说明：

对内部模块依赖的情况， 必须(MUST) 保证内部模块id与路径的对应关系。require依赖引用 必须(MUST) 使用relative id， 不允许(MUST NOT) 使用top-level id。
对外部包依赖的情况，require依赖引用 必须(MUST) 使用top-level id。

开发时，我们通常会做一些测试用例或示例，此时需要通过AMD Loader将当前包粘合到页面环境，并使其可运行。这时我们需要遵守一些规则：

对内部模块依赖，AMD Loader配置 推荐(RECOMMENDED) 通过packages将location配置到下的src目录， 不允许(MUST NOT) 通过paths进行路径映射。
对外部包依赖，请参照将相关依赖包导入，并且 必须(MUST) 通过packages项配置AMD Loader。

允许(SHALL) 包含如下类型的资源：

包描述文件 必须(MUST) 置于${root}下，命名为package.json， 必须(MUST) 是一个UTF-8编码的严格JSON格式的文本文件。

必选字段

name: 包名。 必须(MUST) 为由camel命名法产生的字母组成的字符串。
version: 版本号。版本号 必须(MUST) 为字符串，需要符合SemVer的格式约定。
maintainers: 维护者列表。该字段 必须(MUST) 是一个数组，数组中每项 必须(MUST) 包含维护者的名称字段”name”与电子邮件字段”email”。

可选字段

main: 模块名，用来说明当前包的入口文件。如果包名为foo，那么执行require("foo")的时候，返回的内容就是当前模块exports的内容。
dependencies: 依赖声明。该字段 必须(MUST) 是一个JSON Object，其中key为依赖的包名，为版本号，支持如下的格式：
- version
- >version
- >=version
- <version
- <=version
- *: 任意版本
devDependencies: 类似dependencies的角色，但不是当前包必须的，只是在开发和调试的时候一些依赖的内容。
contributors: 贡献者列表。该字段 必须(MUST) 是一个数组，数组中每项 必须(MUST) 包含维护者的名称字段name与电子邮件字段email。
homepage: 该字段 必须(MUST) 为URL格式的字符串。

示例

package.json

package.json 必须(MUST) 直接放在包顶层目录${root}中。

src

按照通常的理解，一个包项目不应该特别复杂。下面是一个简单的例子，详细的目录划分方法和原则请参考。

dep

用来存放dependencies package的代码， 不允许(MUST NOT) 放置任何其它的内容。