npm8中文文档
如果有人计划在他们的程序中下载和使用您的模块,那么他们可能不想或不需要下载和构建您使用的外部测试或文档框架。
在这种情况下,最好将这些附加项映射到 devDependencies
对象中。
这些东西将在从包的根目录执行 npm link
或 npm install
时安装,并且可以像任何其他 npm 配置参数一样进行管理。有关该主题的更多信息,请参见 config
。
对于非平台特定的构建步骤,例如将 CoffeeScript 或其他语言编译为 JavaScript,请使用 prepare
脚本来执行此操作,并将所需的包设置为 devDependency。
例如:
{
"name": "ethopia-waza",
"description": "a delightfully fruity coffee varietal",
"version": "1.2.3",
"devDependencies": {
"coffee-script": "~1.6.3"
},
"scripts": {
"prepare": "coffee -o lib/ -c src/waza.coffee"
},
"main": "lib/waza.js"
}
prepare
脚本将在发布之前运行,这样用户就可以使用该功能,而无需他们自己编译。在开发模式下(即本地运行npm install
),它也会运行这个脚本,这样你就可以轻松地测试它。