什么是 dispensary
dispensary 是一个用于管理 npm 包发布和版本控制的工具，它提供了一种简单易用的方式将代码和文档分离管理，并支持私有 npm 包的发布和管理。使用 dispensary，你可以快速、简单地创建自己的 npm 包，并发布到自己的私有注册表中，从而方便地与团队成员共享和协作。
安装 dispensary
在使用 dispensary 之前，首先需要安装 Node.js 和 npm，然后在终端中执行以下命令安装 dispensary：
--- ------- -- ----------
使用 dispensary
初始化项目
首先，在你的项目目录下执行以下命令初始化项目：
---------- ----
这将在你的项目中创建两个文件夹：src 和 docs，分别用于存放源代码和文档。
编写代码
在 src 文件夹中编写代码，可以是 JavaScript、TypeScript、CSS 等前端代码。
同时，你还需要在项目目录下创建一个 package.json 文件，用于定义你的 npm 包的基本信息和依赖：
-
------- -------------
---------- --------
-------------- --- ----- --- ---------
------- ---------------
------------- --------------------------------------------
----------- -
------
---------
--
---------- ------
--------------- -
--------- ----------
-
-其中，name 和 version 是必填项，description 和 keywords 是可选项，main 指定了入口文件路径，repository 指定了包的代码仓库地址，license 指定了使用的开源协议，dependencies 则是项目的依赖列表。
编写文档
在 docs 文件夹中编写文档，可以是 Markdown、HTML、PDF 等格式文档，例如：
- ---------- -------- ---------- ------ -- -- ------- --- ------- ----------
使用
------ - ----- - ---- ------------- ---------------
API
hello(str: string): void
输出 Hello, ${str}!
------------ ----------------------------- ----------- --- ---- -- ---------- ------ --- -------------------------- ------- ---------- ------- -----
其中，minor 表示发布一个次要版本，你还可以使用 major、patch 等参数来发布不同的版本号。
发布到注册表
使用 dispensary 发布私有 npm 包非常简单。在项目目录下执行以下命令，即可发布到你自己的注册表中：
---------- -------
然后，其他团队成员就可以通过命令行或者项目的 package.json 文件引入该包：
--- ------- ----------
-
--------------- -
------------- --------
-
-部署到静态网站
如果你使用 GitHub Pages、GitLab Pages 等在线托管服务来托管文档，那么 dispensary 可以帮助你自动部署文档。在项目目录下执行以下命令，即可将文档部署到静态网站上：
---------- ------
部署完成后，你就可以通过文档的 URl 来访问文档了，例如：https://my-username.github.io/my-package/。
总结
dispensary 是一个很不错的 npm 包工具，它简化了 npm 包的管理和发布流程，并且支持私有 npm 包的发布和管理。使用 dispensary，你可以轻松创建自己的 npm 包，并与团队成员进行协作。推荐使用。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/201491