Creating a package.json file

您可以将package.json文件添加到您的程序包中,以使其他人易于管理和安装. 发布到注册表的程序包必须包含package.json文件.

A package.json file:

注意:为了使您的软件包更易于在npm网站上找到,我们建议在package.json文件中包含自定义description .

package.json fields

Required name and version fields

package.json文件必须包含"name""version"字段.

"name"字段包含软件包的名称,并且必须为小写字母和一个单词,并且可以包含连字符和下划线.

"version"字段的格式必须为xxx并遵循语义版本控制准则 .

Author field

如果要在"author"字段中包含软件包作者信息,请使用以下格式(电子邮件和网站都是可选的):

Your Name <[email protected]> (http://example.com)

Example

{
  "name": "my-awesome-package",
  "version": "1.0.0"
}

Creating a new package.json file

您可以创建一个package.json通过运行CLI问卷或创建一个默认的文件package.json文件.

Running a CLI questionnaire

要使用提供的值创建package.json文件,请使用npm init命令.

  1. 在命令行上,导航到包的根目录.
      cd /path/to/package 
  2. 运行以下命令:
      npm init 
  3. Answer the questions in the command line questionnaire.

Customizing the package.json questionnaire

如果您希望创建许多package.json文件,则可以自定义在init过程中提出的问题和创建的字段,以便所有package.json文件都包含一组标准信息.

  1. 在您的主目录中,创建一个名为.npm-init.js的文件.
  2. 要添加自定义问题,请使用文本编辑器,使用prompt功能添加问题:
      module.exports = prompt("what's your favorite flavor of ice cream, buddy?", "I LIKE THEM ALL"); 
  3. 要使用文本编辑器添加自定义字段,请将所需的字段添加到.npm-init.js文件中:
      module.exports = { customField: 'Example custom field', otherCustomField: 'This example field is really cool' } 

要了解有关创建高级npm init定制的更多信息,请参见init-package-json GitHub存储库.

Creating a default package.json file

要使用从当前目录提取的信息来创建默认的package.json ,请使用带有--yes-y标志的npm init命令. 有关默认值的列表,请参见" 从当前目录提取的默认值 ".

  1. 在命令行上,导航到包的根目录.
      cd /path/to/package 
  2. 运行以下命令:
      npm init --yes 

Example

  > npm init --yes
  Wrote to /home/ag_dubs/my_package/package.json:

  {
    "name": "my_package",
    "description": "",
    "version": "1.0.0",
    "main": "index.js",
    "scripts": {
      "test": "echo \"Error: no test specified\" && exit 1"
    },
    "repository": {
      "type": "git",
      "url": "https://github.com/ashleygwilliams/my_package.git"
    },
    "keywords": [],
    "author": "",
    "license": "ISC",
    "bugs": {
      "url": "https://github.com/ashleygwilliams/my_package/issues"
    },
    "homepage": "https://github.com/ashleygwilliams/my_package"
  }

Default values extracted from the current directory

Setting config options for the init command

您可以为init命令设置默认配置选项. 例如,要在命令行上设置默认的作者电子邮件,作者名称和许可证,请运行以下命令:

> npm set init.author.email "[email protected]"
> npm set init.author.name "example_user"
> npm set init.license "MIT"

< Contributing packages to the registry | Creating Node.js modules >

by  ICOPY.SITE