# ignoreme

> Automatically git-ignore common files

Latest version **0.0.4** (published 2017-01-19) · ISC license · 0 weekly downloads

## Install

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

Provides the command `ignoreme`.

## 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.0.4 |
| Published | 2017-01-19 |
| First published | 2017-01-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 2 |
| Author | ben-z |
| Maintainers | benzhang |
| Keywords | gitignore, git, ignore, commandline, command |

## Links

- npm: https://www.npmjs.com/package/ignoreme
- Repository: https://github.com/ben-z/ignoreme
- Homepage: https://github.com/ben-z/ignoreme#readme
- Issues: https://github.com/ben-z/ignoreme/issues
- npm.io page: https://npm.io/package/ignoreme

## Dependencies (3)

- [dedupe](https://npm.io/package/dedupe.md) ^2.1.0
- [winston](https://npm.io/package/winston.md) ^2.3.0
- [commander](https://npm.io/package/commander.md) ^2.9.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2017-01-19
- 0.0.3 — 2017-01-19
- 0.0.2 — 2017-01-19
- 0.0.1 — 2017-01-19

## README

# IgnoreMe

If you are like me, you'd do lots and lots of small projects to learn just about anything. Lots of projects means lots of boilerplates, and out of all the boilerplates, the one we have to create the most often is more or less the `.gitignore` file.

IgnoreMe makes the process of maintaining `.gitignore` files quick and easy.

# Get Started

```bash
$ yarn global add ignoreme # or npm i -g ignoreme
$ ignoreme vim node macos
# 3 gitignore(s) added: vim, node, macos
```

# Usage

To add ignores:
```bash
$ ignoreme add <language1, language2, editor1, ...>
```

To remove ignores:

```bash
$ ignoreme remove <language1, language2, editor1, ...>
```

To list ignores:

```bash
$ ignoreme list
```

# Examples

To ignore all `vim`, `node`, and `macos` temporary files:

```bash
$ ignoreme add vim node macos
# 3 gitignore(s) added: vim, node, macos

$ ignoreme list
# 3 complete gitignore(s):
#   |-- macos
#   |-- node
#   |-- vim
```

To un-ignore `node` temporary files

```bash
$ ignoreme remove node
# 1 gitignore(s) removed: node

$ ignoreme list
# 2 complete gitignore(s):
#   |-- macos
#   |-- vim
```

Let's say you forgot that you have `macos` ignores...

```bash
$ ignoreme add macos
# 1 gitignore(s) already exist(s): macos
```

...or that you misspelt `vim` (to be improved)

```bash
$ ignoreme add vym
# 1 gitignore(s) not found: vym
# Please refer to https://github.com/github/gitignore for a list of available gitignores
```

# Todo

This project is still WIP. Major things left to do:

- [x] `ignoreme add`
- [x] `ignoreme remove`
- [x] `ignoreme list`
- [x] avoid duplicate adds (recognize existing ignored files)
- [ ] tests
- [ ] a better UI (with colours and everything)
- [ ] automatically suggest possible typo fixes

# Contributing

[Issues](https://github.com/ben-z/ignoreme/issues), [PRs](https://github.com/ben-z/ignoreme/pulls). You know the drill.

# License

ISC

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