前言
在前端开发中，我们经常需要把自己开发的 JavaScript 库发布成 npm 包，供其他开发者使用。一般情况下，我们将代码打包成 umd 格式的文件，以便在不同的环境下使用，例如在浏览器中直接引用，或者在 Node.js 中作为依赖使用。而 @yeutech-lab/rollup-umd-documentation-cli 就是一个可以帮助我们打包 JavaScript 库的 npm 包，同时还提供了生成 API 文档的功能，非常实用。
安装
安装 @yeutech-lab/rollup-umd-documentation-cli 可以使用 npm 方式：
npm install @yeutech-lab/rollup-umd-documentation-cli --save-dev
使用
打包
快速打包
可以直接使用 rupack 命令来快速打包 JavaScript 库：
npx rupack
这样将会在当前目录下生成 dist 目录，包含打包好的 JavaScript 库。
自定义配置
如果需要自定义配置，可以在项目根目录下创建一个名为 rupack.config.js 的文件，在其中编写配置信息。
-- -------------------- ---- -------
-------------- - -
------ ---------------
------- -
----- -----------------
------- ------
----- --------
--
-------- -
---- ------
--
--------- --------
--entry: 入口文件路径，默认为 src/index.js。
output: 输出配置，包括文件路径、文件格式（amd、cjs、es、iife、umd 之一）、库名称，以及一些其他选项。
globals: 全局变量配置，如果你的库依赖了其他库，可以在这里指定其全局变量名。
external: 外部依赖配置，如果你的库依赖了其他库，可以在这里进行配置。默认情况下，打包器会尝试将所有依赖库打包到输出文件中，如果指定某个库为外部依赖，则视为不需要打包在输出文件中。
配置好后，可以在命令行中运行 rupack 命令，即可进行打包。
生成 API 文档
快速生成文档
可以直接使用 rudos 命令来快速生成 API 文档：
npx rudos
这样将会在当前目录下生成 docs 目录，包含生成好的 API 文档。
自定义配置
如果需要自定义配置，可以在项目根目录下创建一个名为 rudos.config.js 的文件，在其中编写配置信息。
-- -------------------- ---- ------- -------------- - - ------- ------ ------- ------- -------- -------- ---------------- ------- ----------- ------ --- ------- --- --------------- ----- ------------------------------------- ------ ---------- --
source: 源代码目录，默认为 src。
output: 输出目录，默认为 docs。
exclude: 排除指定文件或目录，默认为 [/test/, /node_modules/]。
format: 输出格式，支持 json、markdown、html、pdf 之一，默认为 markdown。
title: 文档标题。
link: 文档链接。
theme: 文档主题，支持 default、dark、cyan 之一。
配置好后，可以在命令行中运行 rudos 命令，即可进行文档生成。
示例代码
下面是一个简单的示例代码，演示如何使用 @yeutech-lab/rollup-umd-documentation-cli 进行打包和文档生成：
-- -------------------- ---- -------
-- --------
------ --- ---- ------
------ ------- -
------------ -
---------------------------- -
--------- ------------ --------------
---
--
--
-- ----------------
-------------- - -
------ ---------------
------- -
----- -----------------
------- ------
----- --------
--
-------- -
---- ------
--
--------- --------
--
-- ---------------
-------------- - -
------- ------
------- -------
-------- -------- ----------------
------- -----------
------ --- ------- --- ---------------
----- -------------------------------------
------ ----------
--结语
@yeutech-lab/rollup-umd-documentation-cli 是一个非常好用的 npm 包，可以帮助我们更加方便地进行 JavaScript 库的打包和 API 文档的生成。希望本文能够对你有所帮助，欢迎留言讨论。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065f93238a385564ab7036