# dotignore

> ignorefile/includefile matching .gitignore spec

Latest version **0.1.2** (published 2020-01-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install dotignore
pnpm add dotignore
yarn add dotignore
bun add dotignore
```

Provides the command `ignored`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2020-01-08 |
| First published | 2013-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | bradleymeck |
| Maintainers | bradleymeck, ljharb |
| Keywords | ignore, gitignore, npmignore, glob, pattern |

## Links

- npm: https://www.npmjs.com/package/dotignore
- Repository: https://github.com/bmeck/dotignore
- Homepage: https://github.com/bmeck/dotignore#readme
- Issues: https://github.com/bmeck/dotignore/issues
- npm.io page: https://npm.io/package/dotignore

## Dependencies (1)

- [minimatch](https://npm.io/package/minimatch.md) ^3.0.4

## Recent versions

- 0.1.2 (latest) — 2020-01-08
- 0.1.1 — 2014-08-19
- 0.1.0 — 2014-08-10
- 0.0.1 — 2014-03-10
- 0.0.0 — 2013-02-22

## README

# dotignore

## `ignored $IGNOREFILE`

Check the ignorefile against the current directory.
Print out if a file should be ignored by prefixing with a `-`.
If the file should not be ignored prefix it with a `+`.

## API

### exports.createMatcher(str)

Return a `Matcher` that fully matches the `str` argument.

`str` should conform to the `.gitignore` specification.

### Matcher.shouldIgnore(name)

Test that all the rules provided to create the matcher match the name given.
`/` is expected as the path delimiter.
Returns `true` if the name should be ignored.

## LICENSE

MIT

---
_Source: https://npm.io/package/dotignore · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._