你可能不知道的package.json属性详解

那么，我们首先来讲解“你可能不知道的package.json属性详解”。在Node.js的工程中，package.json是非常重要的文件之一，它描述了我们的项目所依赖的各种模块信息，也记录了我们代码库的各种元数据。在项目构建、部署、测试以及开发中，package.json都扮演着重要的角色。接下来我们来详细讲解package.json中一些你可能不知道的属性。

name

name 是指定包名。一般情况下，你可以根据你的工程名来命名，一旦发布到npm上后，这个名称就是这个包的名字。同时我们不建议在包名里使用大写字母和空格，因为这些可以导致一些问题。

例如，一个有效的name是：

{
  "name": "my-awesome-package"
}

version

version 是指当前工程所使用的版本号，通常使用 语义化版本号 语法描述。各个字段的意义区别如下：

• 主版本号：当你做了不兼容的 API 修改，
• 次版本号：当你做了向下兼容的功能性新增，
• 修订号：当你做了向下兼容的问题修正。
• 先行版本号及元数据：用来标记早期开发阶段的版本，例如：alpha、beta、rc

例如，一个有效的 version 是：

{
  "version": "1.0.0"
}

description

description 是对该工程的简单描述。这是一个可选属性，但是我们强烈建议您提供一个简短的字符串来描述你的项目。

例如，一个有效的 description 是：

{
  "description": "A simple demo of package.json"
}

homepage

homepage 是指在 npm 上该包的主页地址。如果你将这个 package 发布到了 npm 上，那么它会自动共享到此处。同时，它也可以用于在 GitHub 或其他页面上添加徽章，宣传你的 npm 包。

例如，一个有效的 homepage 是：

{
  "homepage": "https://github.com/username/repo"
}

keywords

keywords 是指该包的关键词，以便在 npm 的搜索结果中显著地展现这些关键字。你可以添加任意多的关键字。

例如，一个有效的 keywords 是：

{
  "keywords": [
    "demo",
    "package.json"
  ]
}

repository

repository 是指存储源代码的 Git 仓库 URL。这个属性也是一个可选值，但是如果你想将这个 package 发布到 npm 上，我们建议你提供一个可以让其他人访问的 git 仓库地址。

例如，一个有效的 repository 是：

{
  "repository": {
    "type": "git",
    "url": "https://github.com/username/repo"
  }
}

author

author 是指该包的作者信息。这个属性也是一个可选值。如果你想要在共享给别人时注明作者，你可以使用这个属性。

例如，一个有效的 author 是：

{
  "author": "Your Name <[e-mail]>"
}

license

license 这个属性是指定许可证的类型。这是一个必选值。如果你没有设置这个属性，其他人在使用你的代码时可能会出错。我们建议你使用一个标准的 SPDX 许可证名称。更多细节可以在 SPDX 站点 上了解到。

例如，一个有效的 license 是：

{
  "license": "MIT"
}

dependencies

dependencies 这个属性是指该 package 所依赖的模块。这是一个至关重要的属性，因为你的 package 可能需要依赖其他 package 才能正常工作。

例如，一个有效的 dependencies 是：

{
  "dependencies": {
    "express": "^4.17.1",
    "lodash": "^4.17.20"
  }
}

devDependencies

devDependencies ：这个属性是指定义在开发中的程序使用的依赖, 比如测试和打包工具。

例如，一个有效的 devDependencies 是：

{
  "devDependencies": {
    "mocha": "^7.2.0",
    "chai": "^4.2.0"
  }
}

下面我们为你示范一个完整的 package.json 文件：

{
  "name": "my-awesome-package",
  "version": "1.0.0",
  "description": "A simple demo of package.json",
  "homepage": "https://github.com/username/repo",
  "keywords": [
    "demo",
    "package.json"
  ],
  "repository": {
    "type": "git",
    "url": "https://github.com/username/repo"
  },
  "author": "Your Name <[e-mail]>",
  "license": "MIT",
  "dependencies": {
    "express": "^4.17.1",
    "lodash": "^4.17.20"
  },
  "devDependencies": {
    "mocha": "^7.2.0",
    "chai": "^4.2.0"
  }
}

希望本篇教程详细讲解可以对您理解package.json提供帮助。