简介
@lerna/listable 是一个用于过滤和排序项目模块的 npm 包。它基于 lerna，并提供了一种简便的方式来列出本地已发布的模块。
安装
使用下面的命令，可以通过 npm 安装 @lerna/listable
npm install @lerna/listable --save-dev
使用
命令行中使用
在命令行中，你可以使用 lerna ls 命令并传入参数 --json 来输出 JSON 格式的模块列表。这应该是你开始使用 @lerna/listable 的地方。
在 JavaScript 中使用
使用 @lerna/listable 的 JavaScript API 的一般流程如下：
- 导入
listable模块。
const listable = require("@lerna/listable");- 通过调用
listable()函数创建一个 Listable 实例。
const options = {};
const list = listable(options);- 调用
list实例的run()函数来获取符合要求的模块列表。
const moduleList = list.run();
选项
你可以向 listable() 函数传递一个选项对象以覆盖默认选项。默认为空对象（{}）。
const options = {
scope: "@myOrg",
ignore: ["module-name", "other-module-name"],
mode: "all"
};
const list = listable(options);以下是可用选项列表：
| 选项名称 | 类型 | 描述 |
|---|---|---|
scope |
String | 可以是要列出的模块的名称或命名空间。默认为 undefined（列出所有模块）。 |
ignore |
Array | 要忽略的模块的名称或模式。默认为 undefined（不忽略任何模块）。 |
mode |
String | 用于数据的处理方式。可以为 all（列出所有数据）、list（列出所有模块名称）、json（列出 JSON 格式的模块列表）。默认为 all。 |
sort |
String | 用于根据名称、版本或时间戳排序模块列表的属性。默认为 name。 |
reverse |
Boolean | 是否反转排序模块列表的顺序。默认为 false。 |
lerna |
Object | 传递给 lerna 的其他选项。默认为空对象（{}）。 |
示例
以下是一个 JavaScript 示例演示如何使用 @lerna/listable。
-- -------------------- ---- ------- ----- -------- - --------------------------- ----- ------- - - ------ --------- ------- --------------- --------------------- ----- ------ -- ----- ---------- - ------------------------ ------------------------
这将输出一个数组，其中包含所有名称以 @myOrg/ 开头的、但不是 module-name 或 other-module-name 的本地已发布的模块名称列表，类似如下：
[ "module-1", "module-2", "module-3" ]
结论
@lerna/listable 是一个方便的 npm 包，它提供了简便的方式来列出项目中已发布的模块。本文介绍了如何安装、使用、选项和示例，并希望能够帮助你更好地使用这个包。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f006839403f2923b035bc9d