在开发过程中，我们经常需要使用各种第三方模块，而 npm 是最常用的包管理工具之一。npm 包的名称应该是简明易懂的，要遵循一些命名规则，以便其他开发者可以更容易地找到和使用它们。本篇文章将介绍如何使用一个名为 "namingly" 的 npm 包来帮助您更好地命名您自己的 npm 包。
什么是 namingly？
namingly 是一个用于生成 npm 包名称的命令行工具。它可以生成有意义的名称，遵循 npm 包命名规则，并且不会与已有的 npm 包名称冲突。同时，它还可以生成一些额外的信息，例如描述和关键字，方便其他开发者更容易地找到和使用您的 npm 包。
安装和使用
在本地安装 namingly：
npm install -g namingly
然后，在您的项目目录中使用以下命令来生成一个新的 npm 包名称：
namingly
它将返回一个随机生成的 npm 包名称：
"shallow-ocean-719"
可选的语言参数可以用来生成一个特定语言的名称。目前支持的语言有英语（"en"）、法语（"fr"）、德语（"de"）和西班牙语（"es"）。例如：
namingly en
它将返回一个英语名称：
"dynamic-arrow-845"
生成的名称解释
namingly 生成的名称由以下几个部分组成：
- 一个随机的形容词或动词
- 一个随机的名词
- 一个随机的三位数字
例如，在上面的示例中，"shallow-ocean-719" 的 "shallow" 是形容词，"ocean" 是名词，"719" 是随机的三位数字。
遵循命名规则
在对您的 npm 包进行命名时，建议遵循一些命名规则，以便其他开发者可以更轻松地找到和使用它们。以下是一些常见规则：
- 使用小写字母和连字符。
- 避免使用特殊字符和空格。
- 包名称应该简短明了，并且符合所描述的模块的作用。
- 重复的模块名称应该具有不同的版本号。
通过使用 namingly 工具来生成名称，您可以轻松遵循这些规则并生成一个有意义的包名称。
包描述和关键字
生成的名称只是您 npm 包中的一部分，您还需要提供其他信息，以便其他开发者更容易地找到和使用您的包。在创建一个新的 npm 包时，请确保您还包括以下信息：
- 描述：一个简短的描述，描述您的包是用来做什么的。
- 关键字：一些关键词，描述您的包的主要功能。
例如，以下是一个包含完整描述和关键字的 package.json 文件：
-- -------------------- ---- ------- - ------- -------------------- ---------- -------- -------------- -- ----- ------- -- -- --------- --------- ------- ----------- ----------- ----------- ---------- ------------ --------- ----- ---- ------------------------ ---------- ----- -
结论
使用 namingly 工具可以帮助您更好地命名您的 npm 包，遵循 npm 包命名规则，并且不会与已有的 npm 包名称冲突。除了名称外，还要确保包含完整的描述和关键词，以便其他开发者更容易地找到和使用您的包。希望这篇文章能够帮助您更好地管理 npm 包名称，并使您的 npm 包更加具备吸引力和易用性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056c9a81e8991b448e60b1