npm 笔记 - HelloWorld开发者社区

NPM

npm stands for "Node Package Manager"

包管理器可以把库，框架作为 Nodejs 模块引入。

package.json

package.json 文件是所有 Node.js 项目和 npm 包的枢纽，它存储项目的相关信息。它由单个 JSON 对象组成，并以键值对的形式存储项目信息，且至少包含两个必填字段：“name”和“version”——但是最好提供有关项目的其他信息，这将对用户或者维护者有所帮助。

添加作者 Author

在这个文件中最常见的信息之一是 author 字段，它说明了项目的创建者，它可以是字符串，也可以是带有联系人详细信息的对象。对于较大的项目，建议使用对象；比如下面的例子：

"author": "Mitchell"

注意： 正在修改的是一个 JSON，所有的字段名必须用双引号（"）包裹，也必须用逗号（,）分割。

添加描述 Description

一个完整的 package.json 文件的下一部分就是 description 字段——简短精悍的的项目描述。

如果计划将来把这个包发布到 npm，请注意 description 字段的作用是告知用户这个包的用途，这样用户就可以决定是否要安装。然而，这并不是使用描述的唯一场景：它也是一种很好的总结项目的方式，可以帮助其它开发者、维护者甚至自己在未来快速地了解项目，对于任何一个 Node.js 项目来说都非常重要。

无论项目计划是什么，都建议使用描述。类似这样：

"description": "A project that does something awesome

添加关键字 Keywords

在 keywords 字段中可以使用相关的关键字描述项目。下面是一个示例：

"keywords": [ "descriptive", "related", "words" ],

这个字段的结构是一个由双引号字符串组成的数组。

添加许可证 License

给 package.json 添加许可证

license 字段将告知用户允许他们拿这个项目干什么。

开源项目常见的协议有 MIT 和 BSD 等。许可证信息并不是必须的。大多数国家的版权法会默认开发者拥有自己创作的作品的所有权。但是，明确说明用户可以做什么和不能做什么会是一个很好的做法。这里有一个 license 字段的例子：

"license": "MIT",

添加版本号 Version

version 是 package.json 文件中必填字段之一，这个字段描述了当前项目的版本，下面是一个示例：

"version": "1.2.0",

使用外部包（依赖） Dependencies

强大的依赖管理特性是使用包管理器的重要原因之一。每当在新的计算机上开始一个项目时，无需手动，npm 会自动安装所有的依赖项。但是 npm 如何准确地知道项目需要哪些依赖呢？来看看 package.json 文件中 dependencies 这一部分。在这部分，需要按照下面这种格式来存储依赖包：

"dependencies": {
  "package-name": "version",
  "express": "4.14.0"
}

通过语义化来管理 npm 依赖 Semantic

在 package.json 文件的依赖项中，npm 包的 Versions 遵循语义化版本（SemVer，Semantic Versioning），它是一种旨在使管理依赖项更加容易的软件版本控制的行业标准。在 npm 上发布的库、框架或其它工具都应该使用语义化版本，以便让用户清晰地知道如果项目升级将带来哪些改变。在使用外部依赖项（大多数情况都是这样）进行软件开发时，了解语义化版本会很有用。这些数字保存着项目的偶然发生的破坏性改变，不会让人对项目昨天还正常，今天却无法运行而百思不解。根据官网，这是语义化版本的工作方式：

"package": "MAJOR.MINOR.PATCH"

当做了不兼容的 API 修改，应该增加主版本号（MAJOR）；当新增了向下兼容的新功能时，应该增加次版本号（MINOR）；当修复了向下兼容的 bug 时，应该增加修订号（PATCH）。这意味着修订号是用来修复错误的，次版本号则是添加了新功能，但它们都没有破坏之前的功能。主版本号（MAJOR）是添加了不兼容早期版本的更改。