https://github.com/z0al/ignr

Automagically generate a .gitignore file that fits your needs
https://github.com/z0al/ignr

git gitignore gitignore-generator magic

Last synced: 2 months ago
JSON representation

Automagically generate a .gitignore file that fits your needs

• Host: GitHub
• URL: https://github.com/z0al/ignr
• Owner: z0al
• License: mit
• Created: 2019-02-24T15:57:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-06T15:06:21.000Z (over 7 years ago)
• Last Synced: 2026-04-26T06:13:00.549Z (2 months ago)
• Topics: git, gitignore, gitignore-generator, magic
• Language: JavaScript
• Homepage: https://npm.im/ignr
• Size: 121 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ignr

> Automagically generate a `.gitignore` file that fits your needs. Thanks to https://gitignore.io

[![Travis (.org)](https://img.shields.io/travis/z0al/ignr.svg)](https://travis-ci.org/z0al/ignr) [![npm](https://img.shields.io/npm/v/ignr.svg)](https://npm.im/ignr) [![node](https://img.shields.io/node/v/ignr.svg)](https://npm.im/ignr) [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat)](#contributors)

## Usage

To generate a `.gitignore` file for the current directory, you need to run:

```sh

$ npx ignr

```

And BOOM 🔥. That's it.

## How it works

It runs a bunch of checks, for example, the existence of certain files in the current directory, installed programs ..etc to determine what things you might need to ignore. Then it simply fetches the necessary data from https://gitignore.io.

## Supported templates

Currently we can detect and generate a `.gitignore` file for the following templates:

- Golang

- Linux

- macOS

- Node.js

- Vim

- Visual Studio Code

- Windows

- What is missing? see [here](https://github.com/dvcs/gitignore/tree/master/templates)

Contributions are welcome ❤️

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):


Ahmed T. Ali
💻 🚧 ⚠️

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## FAQ

### What about [handy-gi](npm.im/handy-gi)

Well, I've created that package a few years ago, but couldn't really keep it updated since it doesn't fetch the gitignore templates dynamically but rather uses a local copy, which doesn't make sense. I didn't know that [gitignore.io](https://gitignore.io) has a API back then. So, this package basically replaces `handy-gi` and `handy-gi-cli`. Also, I think the `ignr` name is cooler ;)

## License

MIT © Ahmed T. Ali