nodejs npm package.json中文文档

2020-06-17 05:45:27易采站长站整理

将markdown文件放在这里。最后,这些会被很好地展示出来,也许,某一天。
Put markdown files in here. Eventually, these will be displayed nicely,
maybe, someday.

directories.example

将事例脚本放在这里。某一天,它可能会以聪明的方式展示出来。

repository

指定你的代码存放的地方。这个对希望贡献的人有帮助。如果git仓库在github上,那么npm docs命令能找到你。

这样做:

“repository” :
  { “type” : “git”
  , “url” : “http://github.com/isaacs/npm.git”
  }
“repository” :
  { “type” : “svn”
  , “url” : “http://v8.googlecode.com/svn/trunk/”
  }
URL应该是公开的(即便是只读的)能直接被未经过修改的版本控制程序处理的url。不应该是一个html的项目页面。因为它是给计算机看的。

scripts

“scripts”是一个由脚本命令组成的hash对象,他们在包不同的生命周期中被执行。key是生命周期事件,value是要运行的命令。

参见 npm-scripts(7)

config

“config” hash可以用来配置用于包脚本中的跨版本参数。在实例中,如果一个包有下面的配置:

{ “name” : “foo”
, “config” : { “port” : “8080” } }
然后有一个“start”命令引用了npm_package_config_port环境变量,用户可以通过npm config set foo:port 8001来重写他。

参见 npm-config(7) 和 npm-scripts(7)。

dependencies

依赖是给一组包名指定版本范围的一个hash。这个版本范围是一个由一个或多个空格分隔的字符串。依赖还可以用tarball或者git URL。

请不要将测试或过渡性的依赖放在dependencieshash中。见下文的devDependencies。

详见semver(7).

1.version 必须完全和version一致
2.>version 必须比version大
3.>=version 同上
4.<version 同上
5.<=version 同上
6.~version 大约一样,见semver(7)
7.1.2.x 1.2.0, 1.2.1, 等,但不包括1.3.0
8.http://… 见下文’依赖URL’
9.* 所有
10.”” 空,同*
11.version1 – version2 同 >=version1 <=version2.
12.range1 || range2 二选一。
13.git… 见下文’依赖Git URL’
14.user/repo 见下文’GitHub URLs’
15.比如下面都是合法的:

{ “dependencies” :
  { “foo” : “1.0.0 – 2.9999.9999”
  , “bar” : “>=1.0.2 <2.1.2”
  , “baz” : “>1.0.2 <=2.3.4”
  , “boo” : “2.0.1”