parse-gitignore
Advanced tools
Readme
Parse a gitignore file into an array of patterns. Comments and empty lines are stripped.
Install with npm:
$ npm install --save parse-gitignore
var gitignore = require('parse-gitignore');
// pass a filepath
var patterns = gitignore('.gitignore');
//=> ['*.DS_Store', 'node_modules', ...];
Pass additional patterns
Since the function already does unique-ifying on patterns, you can optionally pass an additional array of patterns to add to the patterns parsed from .gitignore:
gitignore('.gitignore', ['foo', 'bar']);
//=> ['*.DS_Store', 'node_modules', 'foo', 'bar', ...]
Configure options
You can also pass options to the function to change its behavior. By default, the results of parsing a file are cached. To disable this, set the cache option:
gitignore('.gitignore', [], { cache: false });
//=> ['*.DS_Store', 'node_modules', ...]
.git/config into a JavaScript object. sync or async. | homepagePull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor |
|---|---|
| 26 | jonschlinkert |
| 1 | schnittstabil |
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.4.3, on April 02, 2017.
FAQs
Parse a .gitignore or .npmignore file into an array of patterns.
The npm package parse-gitignore receives a total of 307,458 weekly downloads. As such, parse-gitignore popularity was classified as popular.
We found that parse-gitignore demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.
Security News
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.