@gotoeasy/is-ignore

0.1.0 • Public • Published

@gotoeasy/is-ignore

根据.gitignore文件的配置,判断指定文件或目录是否要忽略。
指定git仓库的文件目录即可,.gitignore文件将自动读取

NPM version License

Install

npm i @gotoeasy/is-ignore

API

  • const IsIgnore = require('@gotoeasy/is-ignore'): return the class of is-ignore
  • let ignore = new IsIgnore(opts): create instance
    • opts.path: target directory.
  • ignore.isIgnore(file): returns true if pattern is ignored, false otherwise.

Sample

D:/test/.gitignore

/node_modules
const IsIgnore = require('@gotoeasy/is-ignore');

let ignore = new IsIgnore({path: 'D:/test'});

console.log(ignore.isIgnore('D:/test/README.md'));     // false
console.log(ignore.isIgnore('D:/test/node_modules'));  // true

NOTE

  • 根目录有.gitignore文件时将被利用并忽略相关文件,但解析匹配可能有搞错的情况

Links

Package Sidebar

Install

npm i @gotoeasy/is-ignore

Weekly Downloads

5

Version

0.1.0

License

MIT

Unpacked Size

3.53 kB

Total Files

4

Last publish

Collaborators

  • rpose