前言
在项目开发过程中，我们常常需要使用.gitignore文件来忽略一些不需要被版本控制的文件。git-ignore-parser是一个可以解析.gitignore文件的npm包。本文将会介绍如何使用git-ignore-parser。
安装
你可以通过npm来安装git-ignore-parser。
npm install git-ignore-parser
使用
引入git-ignore-parser
const Ignore = require('git-ignore-parser');Ignore类
Ignore类会接受一个.gitignore文件路径或者一个.gitignore文件的内容作为参数。在本例中，我将会使用以下的示例内容：
# 忽略所有 .txt 文件和 log 目录 *.txt log/
实例化一个Ignore类:
const ignore = new Ignore('path/to/.gitignore');或者
const ignore = new Ignore(` # 忽略所有 .txt 文件和 log 目录 *.txt log/ `);
Ignore.filter 方法
Ignore类还有一个filter(paths, {absolute = false} = {})方法，接收两个参数：
paths- (Array<string>) 需要被过滤的路径options- (Object) 选项参数对象。目前只支持absolute属性，该值为Boolean类型，默认值为false。如果为true，则返回的结果将是绝对路径。
ignore.filter返回一个被过滤后的结果数组。
下面是一个使用示例：
-- -------------------- ---- ------- ----- ------ - --- -------- - ---- ---- --- --- -- ----- ---- --- ----- ----- - --------------- ---------------- --------------- ----------------------- ----- ------------- - --------------------- --------------------------- -- ---------------- ----------------------
在这个例子中，ignore.filter方法过滤掉了path数组中的.txt文件和包含log目录的文件。
你也可以使用absolute选项来获取绝对路径的结果。
-- -------------------- ---- ------- ----- ------ - --- -------- - ---- ---- --- --- -- ----- ---- --- ----- ----- - --------------- ---------------- --------------- ----------------------- ----- ------------- - -------------------- ---------- ------- --------------------------- -- - -------------------------------- -------------------------------------- -
结论
git-ignore-parser 是一个很实用的npm包。它可以帮助项目快速的过滤掉那些不需要被版本控制的文件。本文涵盖了git-ignore-parser包的基本功能，希望这篇文章对你学习有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/git-ignore-parser