npm 包 ignoramus 使用教程

在开发前端项目时，我们经常会遇到需要忽略某些文件或目录的情况，例如打包后的文件、测试用例目录、文档等。如何实现忽略呢？这时一个非常实用的工具出现了——ignoramus。

ignoramus 是一个 npm 包，可以帮助我们生成 .gitignore 和 .npmignore 文件，并允许我们在其中添加需要忽略的文件和目录。

安装

首先，我们需要在项目中使用 npm 安装 ignoramus：

npm install ignoramus --save-dev

安装后，我们就可以开始使用 ignoramus 了。

使用

ignoramus 提供了一个命令行工具，可以很方便地生成 .gitignore 和 .npmignore 文件。

生成 .gitignore 文件

我们首先来生成 .gitignore 文件。

在命令行中输入：

npx ignoramus gitignore

这个命令会在项目根目录下生成一个名为 .gitignore 的文件。我们可以通过编辑这个文件，来告诉 Git 哪些文件或目录应该被忽略。例如，以下内容将忽略所有 .DS_Store 文件、node_modules 目录和 .env 文件：

.DS_Store
node_modules/
.env

生成 .npmignore 文件

接着，我们来生成 .npmignore 文件。

在命令行中输入：

npx ignoramus npmignore

这个命令会在项目根目录下生成一个名为 .npmignore 的文件。我们可以通过编辑这个文件，来告诉 npm 哪些文件或目录应该被忽略。例如，以下内容将忽略所有测试用例、文档相关的文件和目录：

/tests
/docs

需要注意的是，.npmignore 文件的作用范围比 .gitignore 更加广泛，它会影响到 npm 包发布时的文件和目录，因此需要谨慎设置。

自定义规则

ignoramus 的默认配置已经包含了很多常见的忽略规则，但有时候我们需要自定义规则来适应自己的项目。

ignoramus 允许我们在项目根目录下创建一个名为 .ignoramus 文件，来定义我们自己的忽略规则。

以忽略 test 目录和 .eslintrc.js 文件为例，.ignoramus 文件应该包含以下内容：

test
.eslintrc.js

然后，我们运行以下命令来生成 .gitignore 和 .npmignore 文件：

npx ignoramus

注意，如果同时存在 .gitignore 和 .npmignore 文件，ignoramus 会合并它们的内容。

示例代码

以下是一个使用 ignoramus 的示例，它帮助我们忽略了 node_modules 目录和 .env 文件。

1. 安装 ignoramus

   npm install ignoramus --save-dev

2. 在 .ignoramus 文件中定义忽略规则

   node_modules
   .env

3. 运行 ignoramus 命令生成 .gitignore 和 .npmignore 文件

   npx ignoramus

4. 编辑 .gitignore 和 .npmignore 文件

   node_modules/
   .env

   node_modules/
   .env

现在，我们就可以轻松地忽略 node_modules 和 .env 了。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600562dc81e8991b448e04aa