Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

file-ignore-parser

fraxken229MIT2.0.0

Parse ignore files (.gitignore and .npmignore)

file, ignore, parser, npmignore, gitignore

readme

file-ignore-parser

version Maintenance MIT

Parse ignore files (.gitignore and .npmignore)

Requirements

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i file-ignore-parser
# or
$ yarn add file-ignore-parser

Usage example

const parser = require("file-ignore-parser");

parser(".gitignore").then(console.log).catch(console.error);

If you want an Array you can convert the Set with Array.from()

API

parser(location: string): Promise< Set< string > >

Parse a given file and return a Set of unique string.

License

MIT