npm 包 dotignore 使用教程

在开发前端项目时，我们通常需要将一些文件或目录排除在版本控制之外，例如 .gitignore 文件中所定义的那些。然而，有时候我们需要额外排除一些文件或目录，这时候就可以使用 npm 包 dotignore 来实现。

安装

使用 npm 安装 dotignore：

npm install dotignore --save

安装完成后，可以在项目中引入这个包：

const dotignore = require('dotignore');

使用

dotignore 提供了一个 match 方法，用来判断一个路径是否应该被排除。该方法需要传入两个参数：

• path：要判断的路径；
• options：配置项对象，可选。

基本使用

// 判断路径是否被排除
const isIgnored = dotignore.match('/path/to/file', {});

其中，/path/to/file 是要被判断的路径。

如果该路径符合某个排除规则，则 isIgnored 会返回 true，否则返回 false。例如，我们可以使用以下规则将所有 node_modules 目录排除：

node_modules

如果我们要判断某个路径是否要被排除，可以这样写：

const isIgnored = dotignore.match('/path/to/node_modules', {});
console.log(isIgnored); // true

配置项

dotignore 的配置项对象 options 可以包含以下属性：

• cwd：所要匹配路径的目录路径；
• ignorePath：自定义忽略文件的路径；
• ignore：所要忽略的文件或路径，如果存在则覆盖读取的忽略文件。

默认情况下，options 为空对象。

cwd

该属性表示当前工作目录（Current Working Directory），它是用来确定所要匹配路径的目录路径的。

const isIgnored = dotignore.match('file', { cwd: '/path/to/directory' });

在上面的例子中，file 是我们要匹配的路径，而 /path/to/directory 就是所要匹配路径的目录路径。

ignorePath

该属性表示要使用的忽略文件的路径。如果不指定该属性，则 dotignore 会按顺序从当前工作目录往上找忽略文件，找到第一个即使用。如果都找不到，则不会忽略任何文件。

const isIgnored = dotignore.match('file', { ignorePath: '/path/to/.myignore' });

在上面的例子中，/path/to/.myignore 就是要使用的忽略文件的路径。如果要使用多个忽略文件，可以设置一个数组：

const isIgnored = dotignore.match('file', { ignorePath: ['/path/to/.myignore1', '/path/to/.myignore2'] });

在这种情况下，dotignore 会按数组的顺序查找忽略文件，找到第一个即使用。

ignore

该属性表示要忽略的文件或路径。如果该属性存在，则会覆盖读取的忽略文件。它应该是一个忽略规则列表或多个忽略规则列表构成的数组。忽略规则列表可以是一个字符串数组或字符串。例如：

const isIgnored = dotignore.match('file', { ignore: 'node_modules' });

在上面的例子中，node_modules 就是所要忽略的文件或路径。

如果要忽略多个文件或路径，可以将它们放在一个数组中：

const isIgnored = dotignore.match('file', { ignore: ['node_modules', '.cache', 'logs'] });

在这个例子中，node_modules、.cache 和 logs 都会被忽略掉。

示例代码

假设我们的项目结构如下：

my-project
├── node_modules
├── src
│   └── index.js
└── package.json

我们的需求是判断 src/index.js 是否应该被排除。考虑到 node_modules 目录应该被排除，但是不想编辑 .gitignore 文件，我们可以使用 dotignore 来实现。

首先，我们可以在项目根目录下新建一个名为 .myignore 的文件，用来记录哪些路径应该排除：

node_modules
logs
.cache

然后，我们可以在 src/index.js 中使用 dotignore 来判断该文件是否应该被排除：

const dotignore = require('dotignore');

const isIgnored = dotignore.match('src/index.js', { cwd: `${__dirname}/..` });
console.log(isIgnored); // false

在上面的代码中，首先我们引入了 dotignore 包。然后，我们使用 match 方法来判断 src/index.js 是否应该被排除。由于我们要匹配的是一个相对路径，所以需要使用 cwd 属性来指定相对路径的起始目录。最后，如果 isIgnored 为 true，则说明该文件应该被排除了，否则不应该被排除。

总结

dotignore 是一个非常实用的 npm 包，可以帮助我们在前端项目中更好地管理文件。通过本文的介绍，相信大家已经了解了 dotignore 的基本用法和相关配置项，希望大家可以在以后的项目中充分运用它！

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