# gitignore

> Automatically fetch gitignore files for any project type from github into your new project

Latest version **0.7.0** (published 2021-07-19) · MIT license · 0 weekly downloads

## Install

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

Provides the command `gitignore`.

## 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.7.0 |
| Published | 2021-07-19 |
| First published | 2014-01-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 0 |
| Unpacked size | 7.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 205 |
| Author | Michael Feldstein |
| Maintainers | msfeldstein |

## Links

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

## Recent versions

- 0.7.0 (latest) — 2021-07-19
- 0.6.0 — 2016-07-31
- 0.5.0 — 2016-05-26
- 0.3.0 — 2016-04-05
- 0.4.0 — 2015-11-30
- 0.2.0 — 2015-05-11
- 0.1.8 — 2014-11-07
- 0.1.7 — 2014-10-17
- 0.1.6 — 2014-09-26
- 0.1.5 — 2014-09-25
- 0.1.3 — 2014-01-28
- 0.1.2 — 2014-01-28
- 0.1.1 — 2014-01-28

## README

# gitignore

Automatically fetch github's excellent `.gitignore` files for any of your new projects

[Here is the list of available types](https://github.com/github/gitignore)

## Use as a global utility

### Install

    npm install gitignore -g
    
Note: If **[NPX](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner)** (NPM's official package runner) is available in your environment you can use it to avoid a global install: ex. ```$ npx gitignore node``` is equivalent to ```npm i -g gitignore && gitignore node``` but avoids the global install step

### Usage

To list out all of the available types:

    gitignore -types

To create a `.gitignore` for rails:

    gitignore rails

That's it.

## Use programmatically as a module

### Install

    npm install gitignore

### and `require`

    var gi = require(`gitignore`);

## API

### `.getTypes(callback)`

Gets the types via `https` request to GitHub.

#### `callback(err, types)`

If an error occurred, or the request failed, an `Error` object is passed as the first parameter. If the types were successfully requested, an array of types is passed as the second parameter with `null` as the first.

### `.writeFile(options, callback)`

Gets the `.gitignore` file from GitHub of the specified `options.type` and stores it in the writable stream at `options.file` or `options.writable`.

#### `options`

`.type` (string) - The type associated with the `.gitignore` file to be fetched
`.file`, `.writable` (writable stream) - A writable stream (a file, sdtout, etc) that the results should be written to

#### `callback(err)`

If an error occurred or the request did not go through, an error obect is passed as the first parameter. If the request was successful, the first parameter is `null` or `undefined`.

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