Package Exports
- gitignore-fs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gitignore-fs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
gitignore-fs
Determine if any file is gitignored. This is intended to be a complete implementation of the gitignore spec, including $GIT_DIR, $GIT_DIR/info/excludes, and the core.excludesFile configuration variable.
Requires Node >= 8.
Getting started
npm install --save gitignore-fsconst Gitignore = require('gitignore-fs')
const gitignore = new Gitignore()
console.log(gitignore.ignores('node_modules')) // true or false depending on your configAPI
class Gitignore
Each instance of this class keeps a separate cache of gitignore rules.
new Gitignore([options])
Creates a new Gitignore instance.
options.initialRules (string[], optional)
These rules will be applied at lowest precedence (lower than rules from core.excludesFile).
Paths with a slash in the beginning or middle are relative to the closest enclosing git directory.
options.finalRules (string[], optional)
These rules will be applied at highest precedence (higher than .gitignore files).
Paths with a slash in the beginning or middle are relative to the closest enclosing git directory.
.ignores(path)
Determines if the given path is gitignored asynchronously.
path (string, required)
The path to test. Must end with / if it is a directory!
Returns (Promise<boolean>)
A promise that will resolve to true if path is gitignored, false otherwise
.ignoresSync(path)
Determines if the given path is gitignored synchronously.
path (string, required)
The path to test. Must end with / if it is a directory!
Returns (boolean)
true if path is gitignored, false otherwise
.clearCache()
Clears the entire gitignore rule cache.