ArtiExtractor 是一个非常实用的 npm 包。它可以自动从你的代码仓库中提取出特定的关键词和术语，方便你更好地了解你的代码。同时，它还可以输出一个专业的术语词典，可以将术语用作 API 接口，提升代码的可读性和可维护性。本文将详细介绍 ArtiExtractor 的使用方法和一些注意事项。
安装 ArtiExtractor
通过 npm 进行安装：
npm install --save-dev arti-extractor
或者通过 yarn 进行安装：
yarn add -D arti-extractor
安装完成后，你便可以开始使用 ArtiExtractor 了。
使用 ArtiExtractor
首先，在你的代码仓库的根目录中建立一个名为 .arti-extractor.json 的配置文件。在该文件中定义你想要提取的术语和关键词。例如：
-- -------------------- ---- -------
-
-------- -
-
------- --------
----------- ------------ ------ --------
--
-
------- ----------
----------- ------------- -------- ----
-
--
----------- --------- -------- ------- ------
-在上面的示例中，我们定义了两个术语：React 和 Angular。其中，每个术语包含一个名称和一个同义词列表。此外，我们还定义了四个关键词。
接下来，在你的项目代码中，你可以使用 ArtiExtractor 提供的 API 来提取术语和关键词：
-- -------------------- ---- -------
----- --------- - --------------------------
----- ---- - -
----- --- - ---------------------
-------------------- ----- ----- ---- -- -
----- ------ - --------------
----- ---- - ----- ------------------------
---------------
---
--
----- ------ - --------------
--------------------在上面的示例中，我们将一段包含了两个关键词（async 和 await）和一个术语（express）的代码传递给 ArtiExtractor。它将解析这些术语，并输出以下结果：
-- -------------------- ---- -------
-
-------- -
-
------- ----------
----------- --
-
--
----------- --------- --------
-如你所见，ArtiExtractor 只提取了我们在 .arti-extractor.json 文件中定义的 express 术语和两个关键词。它还忽略了 User 和 findById，因为它们没有在我们的配置文件中定义为术语或关键词。
注意事项
小写术语
在配置 .arti-extractor.json 文件时，请确保所有术语都以小写形式定义。这是因为 ArtiExtractor 在处理你的代码时，会将其全部转换为小写字母。
例如，如果你的 .arti-extractor.json 文件中定义了 Node.js，而你的代码中使用了 node.js，那么 ArtiExtractor 将识别不到 Node.js。
一次只能解析一个文件
目前，ArtiExtractor 只能解析一个文件。如果你想在多个文件中使用 ArtiExtractor，你需要多次调用 extract 函数，并将要解析的代码传递给它。
不支持多个同义词
在 .arti-extractor.json 文件中，你可以定义多个同义词，但是 ArtiExtractor 目前仅支持使用一个同义词来匹配术语。
只适用于 JavaScript
ArtiExtractor 目前仅适用于 JavaScript 代码。它不支持其他编程语言。
结语
ArtiExtractor 是一个非常实用的工具，它可以使你的代码更加易读和易于维护。希望本文能够帮助你更好地使用 ArtiExtractor。如果你在使用中遇到任何问题，请查看官方文档或提交 issue。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055f1c81e8991b448dcb52