parse-gitignore

What is parse-gitignore?

The parse-gitignore npm package is used to parse .gitignore files and return an array of patterns specified in the file. This can be useful for various tasks such as filtering files, generating ignore lists, or integrating with other tools that need to respect .gitignore rules.

What are parse-gitignore's main functionalities?

Parse .gitignore file

This feature allows you to read and parse a .gitignore file, returning an array of patterns specified in the file. This can be useful for filtering files or integrating with other tools.

const parseGitignore = require('parse-gitignore');
const fs = require('fs');

const gitignoreContent = fs.readFileSync('.gitignore', 'utf8');
const patterns = parseGitignore(gitignoreContent);
console.log(patterns);

Parse .gitignore from a string

This feature allows you to parse .gitignore content from a string, which can be useful if you have the content in memory or from another source.

const parseGitignore = require('parse-gitignore');

const gitignoreContent = 'node_modules\n.DS_Store\n';
const patterns = parseGitignore(gitignoreContent);
console.log(patterns);

Other packages similar to parse-gitignore

ignore

The 'ignore' package is a more feature-rich alternative that not only parses .gitignore files but also provides functionality to filter paths based on the parsed patterns. It supports multiple ignore file formats and is highly configurable.

gitignore-parser

The 'gitignore-parser' package is another alternative that focuses on parsing .gitignore files and provides methods to check if a given path should be ignored based on the parsed patterns. It is simpler than 'ignore' but more feature-rich than 'parse-gitignore'.

README

parse-gitignore

Parse a .gitignore or .npmignore file into an array of patterns.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save parse-gitignore

Heads up!

Breaking changes in v1.0!

Prior to v1.0, this library also attempted to convert the returned patterns into valid globs.

As of v1.0, parse-gitignore was refactored and simplified down to less than ~50 sloc and no dependencies to provide a quick and easy way of getting the array of ignore patterns from a .gitignore file. This allows you to do whatever you need to do with the patterns.

Usage

const fs = require('fs');
const parse = require('parse-gitignore');

// pass the contents of a .gitignore file as a string or buffer 
console.log(parse(fs.readFileSync('foo/bar/.gitignore')));
//=> ['*.DS_Store', 'node_modules', ...];

Example

Parses the contents of a .gitignore file, like the folowing:

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

Into an array, like the following:

[ 'logs',
  '*.log',
  'npm-debug.log*',
  'yarn-debug.log*',
  'yarn-error.log*',
  'pids',
  '*.pid',
  '*.seed',
  '*.pid.lock' ]

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

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

Building docs

(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

Related projects

You might also be interested in these projects:

• parse-author: Parse an author, contributor, maintainer or other 'person' string into an object with name, email… more | homepage
• parse-git-config: Parse .git/config into a JavaScript object. sync or async. | homepage
• parse-github-url: Parse a github URL into an object. | homepage

Contributors

Commits	Contributor
33	jonschlinkert
1	schnittstabil
1	RMacfarlane

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on July 26, 2018.