想必大家都知道，npm 是一个用于管理和分发 JavaScript 包的工具，而在 npm 生态中，npm 包 descriptors 是一个十分实用的工具。它可以让开发者更加方便地对 npm 包进行描述，方便其他开发者理解和使用你的包。本文将为您详细介绍如何使用 npm 包 descriptors，包含如下内容：
- npm 包 descriptors 模块的介绍
- 如何创建和更新 npm 包的 descriptors
- descriptors 的使用场景
- 描述符的样式和规则
1. npm 包 descriptors 模块的介绍
npm 包 descriptors 模块是 npm 官方公布的一个工具，它专门用于对 npm 包进行描述。它为 npm 包提供了一种简单而又表达力极强的描述方式，可以让人们更好的了解和使用这些包。使用描述符模块，开发者可以用一种简单而又灵活的方式，对其提供的 npm 包进行描述。
npm 包 descriptors 的官方文档：https://docs.npmjs.com/files/package.json
2. 如何创建和更新 npm 包的 descriptors
首先，我们需要明确一个概念，那就是 npm 包 descriptors 是基于 package.json 文件的。因此，在创建一个新的 npm 包时，我们可以在 package.json 文件中添加一些属性，来更好地描述该包。如下所示：
-- -------------------- ---- -------
-
------- -------------
---------- --------
-------------- ---------
------- -----------
---------- -
-------- ----- ---------
--
--------------- -
---------- ---------
-
-其中，name、version、description 和 dependencies properties 都是常用的 package 描述信息，用于描述自己的包的基本属性和依赖的其他包的信息。
除此之外，我们还可以使用 keywords、homepage、bugs、repository 和 author 等 properties 来更好地描述和介绍自己的包。这些信息可以通过 npmjs.com 上的搜索功能被其他人查找到。如下所示：
-- -------------------- ---- -------
-
------- -------------
---------- --------
-------------- ---------
------- -----------
---------- -
-------- ----- ---------
--
----------- -
------
-------------
-----
--
----------- ---------------------------------------------
------- -
------ ---------------------------------------------------
--
------------- -
------- ------
------ ----------------------------------------------------
--
--------- ----------
--------------- -
--------- - ---------
-
-在更新 package 描述信息时，只需要修改相应的属性即可，具体操作和修改方法与创建类似。
3. descriptors 的使用场景
npm 包 descriptors 的使用场景非常广泛，下面我们介绍一些典型的案例。
- 让他人了解你的包： 如果你有一个开源的 npm 包，那么你一定希望让更多的人去了解它。在 package.json 文件中添加描述信息，可以让其他开发者更好地了解并使用你的包。
- 查阅依赖信息： 在开发 npm 包时，我们经常会依赖其他的 npm 包。如果我们在 package.json 文件中添加了说明性的信息，则其他人也可以很方便地了解你的包的依赖信息，从而使用你的包更为顺畅。
- 为了自己更好地了解自己的包： 当开发者编写一个 npm 包时，他们通常需要写一些文档来解释如何使用他的 npm 包。然而，写文档需要耗费大量时间和精力。使用 package.json 文件，开发者可以在该文件中添加简单而又强有力的描述信息，使得他们自己和其他人都可以更好地了解这个包。
在描述自己的包时，要考虑到其他开发者，尽可能多的提供设计和使用者便利的信息。
4. 描述符的样式和规则
在写描述符时，要遵守一些规则，下面是一些常用的样式和规则：
-- -------------------- ---- -------
-
------- -------------
---------- --------
-------------- ---------
------- -----------
---------- -
-------- ----- ---------
--
----------- -
------
-------------
-----
--
----------- ---------------------------------------------
------- -
------ ---------------------------------------------------
--
------------- -
------- ------
------ ----------------------------------------------------
--
--------- -----------
---------- ------
--------------- -
--------- - ---------
--
------------------ -
-------- --------
--
------------------- -
-------- ---------
--
---------- -
------- ----------
-
-- name: 包的名称，必填。
- version: 包的版本，必填。
- description: 包的描述信息，可选。
- main: 包的主入口，可选。
- scripts: 在预定义的钩子函数前执行的命令，例如 npm run test，可选。
- keywords: 将包与其他相关包联系起来的标记列表，可选。
- homepage: 包所在主页的 URL，可选。
- bugs: 在哪里提交 bug 的位置（通常用于 GitHub），可选。
- repository: 包代码的 Git 存储库可选。
- author: 包的作者，可选。
- license: 包的版权协议，可选。
- dependencies: 包依赖的其他包的版本信息，必填。
- devDependencies: 包作为开发时的依赖的其他包的版本信息，可选。
- peerDependencies: 包需要在运行时与之兼容的其他包的版本信息，可选。
- engines: 包可以使用的运行时环境（node.js 版本信息），可选。
到此为止，本文对 npm 包 descriptors 的使用教程就结束了。希望读者在日常开发中，能够加强对 npm 包 descriptors 的使用。描述信息本身并不难写，但是它可以帮助你的库得到更好的性能、支持、良好的文档和测试等优秀的品牌形象。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/71480