Netherworld's Pretend Minibar
Introducing npm Teams! Private packages + team management tools.Learn more »

ignr

1.2.0 • Public • Published

ignr

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

Travis (.org) npm node All Contributors

Usage

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

$ 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

Contributions are welcome ❤️

Contributors

Thanks goes to these wonderful people (emoji key):

Ahmed T. Ali
Ahmed T. Ali

💻 🚧 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

FAQ

What about 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 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

Install

npm i ignr

DownloadsWeekly Downloads

6

Version

1.2.0

License

MIT

Unpacked Size

10.3 kB

Total Files

20

Last publish

Collaborators

  • avatar