关于package.json
2019-06-11 本文已影响0人
广告位招租
packags.json各字段的意思和用途
栗子一： express
{
"name": "express", // 名称
"description": "Fast, unopinionated, minimalist web framework", // 描述
"version": "4.13.3", // 版本号
"author": { // 作者
"name": "TJ Holowaychuk",
"email": "tj@vision-media.ca"
},
"contributors": [ // 其他贡献者
{
"name": "Aaron Heckmann",
"email": "aaron.heckmann+github@gmail.com"
},
{
"name": "Ciaran Jessup",
"email": "ciaranj@gmail.com"
},
{
"name": "Douglas Christopher Wilson",
"email": "doug@somethingdoug.com"
},
{
"name": "Guillermo Rauch",
"email": "rauchg@gmail.com"
},
{
"name": "Jonathan Ong",
"email": "me@jongleberry.com"
},
{
"name": "Roman Shtylman",
"email": "shtylman+expressjs@gmail.com"
},
{
"name": "Young Jae Sim",
"email": "hanul@hanul.me"
}
],
"license": "MIT", // 对你的包指定一个license来让用户知道他们的使用权利和限制，你可以查看SPDX许可证标识符的完整列表(https://spdx.org/licenses/)，理想情况下你应该挑选一个经过OSI(https://opensource.org/licenses/alphabetical)核准的标识符。
"repository": { // 包代码的Repo信息，包括type和URL，type可以是git或svn，URL则是包的Repo地址
"type": "git",
"url": "git+https://github.com/strongloop/express.git"
},
"homepage": "http://expressjs.com/", // 主页
"keywords": [ // 关键词
"express",
"framework",
"sinatra",
"web",
"rest",
"restful",
"router",
"app",
"api"
],
"dependencies": { // 生产环境依赖包列表。它们将会被安装在 node_module 目录下
"accepts": "~1.2.12",
"array-flatten": "1.1.1",
"content-disposition": "0.5.0",
"content-type": "~1.0.1",
"cookie": "0.1.3",
"cookie-signature": "1.0.6",
"debug": "~2.2.0",
"depd": "~1.0.1",
"escape-html": "1.0.2",
"etag": "~1.7.0",
"finalhandler": "0.4.0",
"fresh": "0.3.0",
"merge-descriptors": "1.0.0",
"methods": "~1.1.1",
"on-finished": "~2.3.0",
"parseurl": "~1.3.0",
"path-to-regexp": "0.1.7",
"proxy-addr": "~1.0.8",
"qs": "4.0.0",
"range-parser": "~1.0.2",
"send": "0.13.0",
"serve-static": "~1.10.0",
"type-is": "~1.6.6",
"utils-merge": "1.0.0",
"vary": "~1.0.1"
},
"devDependencies": { // 开发环境依赖包列表。它们将会被安装在 node_module 目录下
"after": "0.8.1",
"ejs": "2.3.3",
"istanbul": "0.3.17",
"marked": "0.3.5",
"mocha": "2.2.5",
"should": "7.0.2",
"supertest": "1.0.1",
"body-parser": "~1.13.3",
"connect-redis": "~2.4.1",
"cookie-parser": "~1.3.5",
"cookie-session": "~1.2.0",
"express-session": "~1.11.3",
"jade": "~1.11.0",
"method-override": "~2.3.5",
"morgan": "~1.6.1",
"multiparty": "~4.1.2",
"vhost": "~3.0.1"
},
"engines": { // 指定node的工作版本
"node": ">= 0.10.0"
},
"files": [ // 一个被项目包含的文件名数组，如果你在里面放一个文件夹名，那么这个文件夹中的所有文件都会被包含进项目中
"LICENSE",
"History.md",
"Readme.md",
"index.js",
"lib/"
],
"scripts": { // 由脚本命令组成的字典，这些命令运行在包的各个生命周期中。这里的键是生命周期事件名，值是要运行的命令
"test": "mocha --require test/support/env --reporter spec --bail --check-leaks test/ test/acceptance/",
"test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --require test/support/env --reporter spec --check-leaks test/ test/acceptance/",
"test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --require test/support/env --reporter dot --check-leaks test/ test/acceptance/",
"test-tap": "mocha --require test/support/env --reporter tap --check-leaks test/ test/acceptance/"
},
"gitHead": "ef7ad681b245fba023843ce94f6bcb8e275bbb8e",
"bugs": { // 改项目的issue跟踪页面或这报告issue的email地址。这对使用这个包遇到问题的用户会有帮助。
"url": "https://github.com/strongloop/express/issues"
},
"_id": "express@4.13.3",
"_shasum": "ddb2f1fb4502bf33598d2b032b037960ca6c80a3",
"_from": "express@*",
"_npmVersion": "1.4.28",
"_npmUser": {
"name": "dougwilson",
"email": "doug@somethingdoug.com"
},
"maintainers": [ // 维护人员
{
"name": "tjholowaychuk",
"email": "tj@vision-media.ca"
},
{
"name": "jongleberry",
"email": "jonathanrichardong@gmail.com"
},
{
"name": "dougwilson",
"email": "doug@somethingdoug.com"
},
{
"name": "rfeng",
"email": "enjoyjava@gmail.com"
},
{
"name": "aredridel",
"email": "aredridel@dinhe.net"
},
{
"name": "strongloop",
"email": "callback@strongloop.com"
},
{
"name": "defunctzombie",
"email": "shtylman@gmail.com"
}
],
"dist": {
"shasum": "ddb2f1fb4502bf33598d2b032b037960ca6c80a3",
"tarball": "http://registry.npmjs.org/express/-/express-4.13.3.tgz"
},
"directories": {},
"_resolved": "https://registry.npmjs.org/express/-/express-4.13.3.tgz",
"readme": "ERROR: No README data found!"
}
栗子二： normalize.css
{
"name": "normalize.css",
"version": "3.0.3",
"description": "Normalize.css as a node packaged module",
"style": "normalize.css",
"files": [
"LICENSE.md",
"normalize.css"
],
"homepage": "http://necolas.github.io/normalize.css",
"repository": {
"type": "git",
"url": "git://github.com/necolas/normalize.css.git"
},
"main": "normalize.css", // 指定了模块的入口程序文件
"author": {
"name": "Nicolas Gallagher"
},
"license": "MIT",
"gitHead": "2bdda84272650aedfb45d8abe11a6d177933a803",
"bugs": {
"url": "https://github.com/necolas/normalize.css/issues"
},
"_id": "normalize.css@3.0.3",
"scripts": {},
"_shasum": "acc00262e235a2caa91363a2e5e3bfa4f8ad05c6",
"_from": "normalize.css@3.0.3",
"_npmVersion": "2.7.0",
"_nodeVersion": "0.10.35",
"_npmUser": {
"name": "necolas",
"email": "nicolasgallagher@gmail.com"
},
"maintainers": [
{
"name": "tjholowaychuk",
"email": "tj@vision-media.ca"
},
{
"name": "necolas",
"email": "nicolasgallagher@gmail.com"
}
],
"dist": {
"shasum": "acc00262e235a2caa91363a2e5e3bfa4f8ad05c6",
"tarball": "https://registry.npmjs.org/normalize.css/-/normalize.css-3.0.3.tgz"
},
"directories": {},
"_resolved": "https://registry.npmjs.org/normalize.css/-/normalize.css-3.0.3.tgz",
"readme": "ERROR: No README data found!"
}
更多
1. files
files字段是一个被项目包含的文件名数组，如果你在里面放一个文件夹名，那么这个文件夹中的所有文件都会被包含进项目中(除非是那些在其他规则中被忽略的文件)。
你还可以在包的根目录或子目录下提供一个".npmignore"文件来忽略项目包含文件，即使这些文件被包含在files字段中。.npmignore文件和.gitignore的功能很像。
某些文件总是被包含的，不论是否在规则中指定了它们：
package.json
README (and its variants)
CHANGELOG (and its variants)
LICENSE / LICENCE
相反地，一些文件总是被忽略：
.git
CVS
.svn
.hg
.lock-wscript
.wafpickle-N
.swp
.DS_Store
._
npm-debug.log
2. bin
许多包有一个或多个可执行文件希望被安装到系统路径。在npm下要这么做非常容易(事实上，npm就是这么运行的)。
这需要在你的package.json中提供一个bin字段，它是一个命令名和本地文件名的映射。在安装时，如果是全局安装，npm将会使用符号链接把这些文件链接到prefix/bin，如果是本地安装，会链接到./node_modules/.bin/。
比如，要使用myapp作为命令时可以这么做：
{ "bin" : { "myapp" : "./cli.js" } }
这么一来，当你安装myapp，npm会从cli.js文件创建一个到/usr/local/bin/myapp的符号链接(这使你可以直接在命令行执行myapp)。
如果你只有一个可执行文件，那么它的名字应该和包名相同，此时只需要提供这个文件路径(字符串)，比如：
{
"name": "my-program",
"version": "1.2.5",
"bin": "./path/to/program"
}
这和以下这种写法相同：
{
"name": "my-program",
"version": "1.2.5",
"bin": {
"my-program": "./path/to/program"
}
}
3. os/cup
可以指定模块运行的操作系统和特定的cpu架构
"os" : [ "!win32" ],
"cpu" : [ "x64", "ia32" ]
