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 directory.

Installation

• 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.

• 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.

• Link the appropriate files by running ./install.sh

• 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

• 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.

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. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.