[![CircleCI](https://circleci.com/gh/muyiwaolu/editorconfig-generator.svg?style=svg)](https://circleci.com/gh/muyiwaolu/editorconfig-generator)
# EditorConfig Generator
A command line ruby script that allows you to generate .editorconfig files quickly and easily using presets or custom options.

The source code for the script is located in the [lib](https://github.com/muyiwaolu/editorconfig-generator/tree/master/lib) directory.

## Installation

1. Clone the repository into `~/.editor-config`, e.g. `git clone https://github.com/muyiwaolu/editorconfig-generator ~/.editorconfig-generator`

__Note:__ Before the next steps, please make sure you read and understand what `install.sh` is doing. I've written this script, and will be the first to admit I am _not_ a shell script expert.

On that note, I will happily accept pull requests to improve it.

2. `cd` into the `~/.editor-config` directory and run `install.sh`. You may want to run `chmod +x install.sh` first if the command line complains about incorrect permissions.

3. Link the appropriate files by running `./install.sh`

4. If you run `generator`, you should see the following prompt:

```
Generates a .editorconfig file with settings of your choosing.

Usage: editorconfig generate
    -g, --generate                   Generate an editorconfig file.
```

## FAQ

1. Why aren't my specific file rules being recognised?

Make sure to put in the correct file matching pattern. For example, to match all files with the `.js` extension, enter `*.js`. [More information here](http://editorconfig.org/#file-format-details).

## Upgrading

Since the files are symbolically linked to your `/usr/local/bin` folder, to upgrade to the latest version, simply `cd` into `~/.editor-config` and `git pull`.

## Contributing

Bug reports and pull requests are welcome here on [GitHub](https://github.com/muyiwaolu/editorconfig-generator). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).