editorconfig_generator 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f17ee5e6d3ac647945821d2b8d807040cdd443b8
+  data.tar.gz: 9a37262dfc1ca05a74cf7216b70dafe8a45b4eb8
+SHA512:
+  metadata.gz: 48c3080114efb8a4cda1c96bd29180e64032001c309ad72023dda2472f7275cdb325e965e2c21712c5218c25c31ef8cc4daee3ae0c214b5c318341605f45f9d0
+  data.tar.gz: 9881bf4acf35932afbaa99b2f9b4c17ae52022c235bb8c913f82152e1b47b0eb927d02c2fd02d060466632204fb9a4b046e2a7b6caecefb93466be23e9cc9719

data/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_STORE
+/test_output
+result.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,34 @@
+require: rubocop-rspec
+
+# The EditorConfig class represents the .editorconfig file.
+#
+# This class has a fair amount of content and logic associated
+# with it that doesn't make sense elsewhere, therefore I've
+# decided to double the ClassLength requirements.
+#
+# Hopefully, this doesn't promote objects or classes that are
+# too complex.
+Metrics/ClassLength:
+  Exclude:
+  - 'lib/editorconfig/editor_config.rb'
+
+# Specs shouldn't have a length cap as they should be verbose by
+# design.
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/LineLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+# The File Generator specs usually have longer example length
+# due to string matching setup representing file content
+RSpec/ExampleLength:
+  Exclude:
+  - 'spec/editor_config_generator/file_generator_spec.rb'
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at m.oluogunleye94@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in editorconfig-generator.gemspec
+gemspec
+gem 'rspec'
+gem 'rubocop', require: false
+gem 'rubocop-rspec'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Muyiwa Olu-Ogunleye
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,2 @@
+default:
+	./install.sh

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'editorconfig/generator'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/changelog.md

@@ -0,0 +1,34 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+### Added
+
+## [0.2.3] - 18/03/2017
+### Added
+- Fix issue with the parser not running due to missing parameter
+- Improve `install.sh`, do a few defensive checks
+- Add support for `make`
+
+## [0.2.2] - 13/03/2017
+### Added
+- Add rubocop support for the project 
+- Refactor each file that reports a rubocop violation 
+- Add support for continuous integration with rubocop 
+- Removed Travis CI and use Circle CI instead
+
+## [0.2.1] - 02/12/2016
+### Added
+- Updated readme to add FAQ section
+- Added FAQ question about file types
+- Added ability for EditorConfig object to know if it is a 'minimum' object (where minimum is if only the `root` and `file_type` are not nil
+- Added a changelog
+- Improved the EditorConfig object to initialise all instance variables
+
+[Unreleased]: https://github.com/muyiwaolu/editorconfig-generator/compare/v0.2.2...HEAD
+[0.2.1]: https://github.com/muyiwaolu/editorconfig-generator/compare/v0.2.0...v0.2.1
+[0.2.2]: https://github.com/muyiwaolu/editorconfig-generator/compare/v0.2.1...v0.2.2
+[0.2.3]: https://github.com/muyiwaolu/editorconfig-generator/compare/v0.2.2...v0.2.3

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  post:
+    - bundle exec rubocop

data/editorconfig-generator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'editorconfig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'editorconfig_generator'
+  spec.version       = EditorConfigGenerator::VERSION
+  spec.authors       = ['Muyiwa Olu-Ogunleye']
+  spec.email         = ['hello@muyiwa.me']
+
+  spec.summary       = 'Allow users to generate .editorconfig files.'
+  spec.description   = 'Allow users to generate .editorconfig files quickly and
+                        easily using presets or custom options.'
+  spec.homepage      = 'https://github.com/muyiwaolu/editorconfig_generator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.required_ruby_version = '~> 2.0'
+end

data/install.sh

@@ -0,0 +1,74 @@
+#!/usr/bin/env bash
+EDITORCONFIG_PATH="$HOME/.editorconfig-generator"
+EDITORCONFIG_LIBRARY_DIR="$EDITORCONFIG_PATH/lib/editorconfig"
+EDITORCONFIG_SCRIPT_FILE="$EDITORCONFIG_PATH/lib/generator.rb"
+BIN_DIRECTORY="/usr/local/bin"
+GENERATOR_LOCATION="$BIN_DIRECTORY/generator"
+
+function echo_message() {
+    echo "$1"
+}
+
+function remove_existing_generator() {
+    if [ -f "$GENERATOR_LOCATION" ] ; then
+      echo_message "Removing existing generator binary located at: [$GENERATOR_LOCATION]"
+      if rm "$GENERATOR_LOCATION" ; then
+        echo_message "Removed existing generator binary successfully."
+      else
+        echo_message "Unable to remove existing generator binary."
+      fi
+    else
+      echo_message "[$GENERATOR_LOCATION] does not exist. Skipping removing binary..."
+    fi
+}
+
+function link_generator() {
+    if [ -f "$EDITORCONFIG_SCRIPT_FILE" ] && [ -d "$BIN_DIRECTORY" ] ; then
+        echo_message "Symbolically linking [$EDITORCONFIG_SCRIPT_FILE] to [$GENERATOR_LOCATION]"
+        if ln -sf "$EDITORCONFIG_SCRIPT_FILE" "$GENERATOR_LOCATION" ; then
+            echo_message "Successfully linked the files"
+        else
+            echo_message "Unable to link the files"
+        fi
+    else
+        echo_message "[$EDITORCONFIG_SCRIPT_FILE] or [$BIN_DIRECTORY] does not exist..."
+    fi
+}
+
+function link_generator_directory() {
+    if [ -d "$EDITORCONFIG_LIBRARY_DIR" ] && [ -d "$BIN_DIRECTORY" ] ; then
+        echo_message "Symbolically linking [$EDITORCONFIG_LIBRARY_DIR] to [$BIN_DIRECTORY]"
+        if ln -sf "$EDITORCONFIG_LIBRARY_DIR" "$BIN_DIRECTORY" ; then
+            echo_message "Successfully linked the directories"
+        else
+            echo_message "Unable to link the directories"
+        fi
+    else
+        echo_message "[$EDITORCONFIG_LIBRARY_DIR] or [$BIN_DIRECTORY] does not exist..."
+    fi
+}
+
+function write_permissions_to_generator() {
+
+    if [ -f "$GENERATOR_LOCATION" ] ; then
+      if chmod +x "$GENERATOR_LOCATION" ; then
+          echo_message "Sucessfully given write permissions to [$GENERATOR_LOCATION]"
+      else
+          echo_message "Unable to give write permissions to [$GENERATOR_LOCATION]"
+      fi
+    else
+      echo_message "[$GENERATOR_LOCATION] doesn't exist"
+    fi
+
+
+}
+
+remove_existing_generator
+link_generator
+link_generator_directory
+write_permissions_to_generator
+
+#ln -sf ~/.editorconfig-generator/lib/generator.rb /usr/local/bin/generator # Link the generator script to the bin path
+#chmod +x /usr/local/bin/generator # Give the script appropriate permissions
+#
+#ln -sf ~/.editorconfig-generator/lib/editorconfig /usr/local/bin # Link the supporting files to the binary location

data/lib/editorconfig/argument_parser.rb

@@ -0,0 +1,112 @@
+require 'optparse'
+require_relative './option_transformer'
+require_relative './editor_config'
+require_relative './file_generator'
+
+module EditorConfigGenerator
+  # Parses the arguments passed to the Editor Configurator
+  class ArgumentParser
+    def self.ask_user(options)
+      ask_file_type(options)
+      ask_indent_style(options)
+      ask_indent_size(options)
+      ask_end_of_line(options)
+      ask_charset(options)
+      ask_trailing_whitespace(options)
+      ask_insert_newline(options)
+      ask_question('Would you like to add another (file specific) section
+                   (y/n) [n]', %w(y n), 'n')
+    end
+
+    def self.ask_insert_newline(options)
+      options[:insert_final_newline] = ask_question('Would you like to insert
+                                                    a final newline? (y/n)',
+                                                    %w(y n))
+    end
+
+    def self.ask_trailing_whitespace(options)
+      options[:trim_trailing_whitespace] = ask_question('Would you like to trim
+                                                        trailing whitespace?
+                                                        (y/n)', %w(y n))
+    end
+
+    def self.ask_charset(options)
+      options[:charset] = ask_question('What is the character set of the
+                                       project? (latin1/utf-8/utf-8-bom
+                                       /utf-16be/utf-16le)',
+                                       %w(latin utf-8 utf-8-bom
+                                          utf-16be utf-16le))
+    end
+
+    def self.ask_end_of_line(options)
+      options[:end_of_line] = ask_question('What character would you like to
+                                           use to represent the end of line?
+                                           (lf/cr/ctrlf)', %w(cr lf ctrlf))
+    end
+
+    def self.ask_indent_size(options)
+      options[:indent_size] = ask_question('What size would you like
+                                           indentations to be? ', %w(2 4))
+    end
+
+    def self.ask_indent_style(options)
+      options[:indent_style] = ask_question('What indent style do you use
+                                             (space/tabs)', %w(space tabs))
+    end
+
+    def self.ask_file_type(options)
+      options[:file_type] = ask_question('What is the filetype for these rules?
+                                         [*]', nil, '*')
+    end
+
+    def self.ask_question(question, valid_answers, default_value = nil)
+      loop do
+        print "#{question}: "
+        answer = STDIN.gets.chomp
+        return default_value if answer.chomp == ''
+        return answer if !valid_answers.nil? && valid_answers.include?(answer)
+        return answer if valid_answers.nil?
+      end
+    end
+
+    def self.parse(args)
+      option_parser = OptionParser.new do |options|
+        options.banner = "Generates a .editorconfig file with settings of your
+                          choosing.
+                        \nUsage: editorconfig generate "
+        parse_options(options)
+      end
+      option_parser.parse!(args)
+    end
+
+    def self.parse_options(options)
+      option_prompt = 'Generate an editorconfig file.'
+      options.on('-g', '--generate', option_prompt) do |_answer|
+        configs = []
+        options = {}
+        options[:root] = ask_question('Is this for the topmost .editorconfig
+                                      file? (y/n) [y]', %w(y n), 'y')
+        ask_questions(options)
+        file_generator = FileGenerator.new(configs)
+        file_generator.generate_config_file
+      end
+    end
+
+    def ask_questions(options, configs)
+      loop do
+        add_another_config = ask_user(options)
+        e = EditorConfig.new(options)
+        configs.push(e)
+        options = {}
+        warn_user_bare_minimum(add_another_config, e)
+        break if add_another_config == 'n'
+      end
+    end
+
+    def warn_user_bare_minimum(add_another_config, e)
+      return unless add_another_config == 'n' && e.minimum?
+      puts 'Warning: you have selected the bare minimum options for the
+              file'
+    end
+  end
+end

data/lib/editorconfig/editor_config.rb

@@ -0,0 +1,155 @@
+module EditorConfigGenerator
+  # Object representation of an EditorConfig file
+  # rubocop:disable Style/AccessorMethodName
+  class EditorConfig
+    attr_reader :root, :indent_style, :indent_size,
+                :end_of_line, :charset, :trim_trailing_whitespace,
+                :insert_final_newline, :file_type
+
+    def initialize(options = {})
+      @root = nil
+      @file_type = :*
+      @indent_style = nil
+      @end_of_line = nil
+      @charset = nil
+      @trim_trailing_whitespace = nil
+      @insert_final_newline = nil
+
+      OptionTransformer.transform_options(options)
+      set_options(options)
+    end
+
+    def set_options(options)
+      set_root_option(options)
+      set_indent_style_option(options)
+      set_indent_size_option(options)
+      set_end_of_line_option(options)
+      set_charset_option(options)
+      set_trailing_space_option(options)
+      set_final_newline_option(options)
+      set_file_type_option(options)
+    end
+
+    def set_file_type_option(options)
+      return if options[:file_type].nil?
+      @file_type = options[:file_type]
+    end
+
+    def set_final_newline_option(options)
+      return if options[:insert_final_newline].nil?
+      @insert_final_newline = options[:insert_final_newline]
+    end
+
+    def set_trailing_space_option(options)
+      return if options[:trim_trailing_whitespace].nil?
+      @trim_trailing_whitespace = options[:trim_trailing_whitespace]
+    end
+
+    def set_charset_option(options)
+      return if options[:charset].nil?
+      @charset = options[:charset]
+    end
+
+    def set_end_of_line_option(options)
+      return if options[:end_of_line].nil?
+      @end_of_line = options[:end_of_line]
+    end
+
+    def set_indent_size_option(options)
+      return if options[:indent_size].nil?
+      @indent_size = options[:indent_size]
+    end
+
+    def set_indent_style_option(options)
+      return if options[:indent_style].nil?
+      @indent_style = options[:indent_style]
+    end
+
+    def set_root_option(options)
+      return if options[:root].nil?
+      @root = options[:root]
+    end
+
+    def to_s
+      config_string = ''
+      append_root_to_s(config_string)
+      append_file_type_to_s(config_string)
+      append_indent_style_to_s(config_string)
+      append_indent_size_to_s(config_string)
+      append_end_of_line_to_s(config_string)
+      append_charset_to_s(config_string)
+      append_whitespace_to_s(config_string)
+      append_final_newline_to_s(config_string)
+      config_string
+    end
+
+    def append_final_newline_to_s(config_string)
+      return if @insert_final_newline.nil?
+      config_string << "insert_final_newline = #{@insert_final_newline}\n"
+    end
+
+    def append_whitespace_to_s(config_string)
+      return if @trim_trailing_whitespace.nil?
+      config_string << 'trim_trailing_whitespace ' \
+                       "= #{@trim_trailing_whitespace}\n"
+    end
+
+    def append_charset_to_s(config_string)
+      return if @charset.nil?
+      config_string << "charset = #{@charset}\n"
+    end
+
+    def append_end_of_line_to_s(config_string)
+      return if @end_of_line.nil?
+      config_string << "end_of_line = #{@end_of_line}\n"
+    end
+
+    def append_indent_size_to_s(config_string)
+      return if @indent_size.nil?
+      config_string << "indent_size = #{@indent_size}\n"
+    end
+
+    def append_indent_style_to_s(config_string)
+      return if @indent_style.nil?
+      config_string << "indent_style = #{@indent_style}\n"
+    end
+
+    def append_file_type_to_s(config_string)
+      config_string << "[#{@file_type}]\n"
+    end
+
+    def append_root_to_s(config_string)
+      return if @root.nil?
+      config_string << "root = #{@root}\n"
+    end
+
+    def to_s_without_root
+      lines = to_s.lines
+      lines.delete_at 0
+      lines.join
+    end
+
+    def to_s_without_line(line_identifier)
+      lines = to_s.lines
+      index = lines.index(line_identifier)
+      lines.delete_at index
+      lines.join
+    end
+
+    def minimum?
+      # The minimum editor config file is one with only root and file_type set
+      @indent_style.nil? &&
+        @indent_size.nil? &&
+        @end_of_line.nil? &&
+        @charset.nil? &&
+        @trim_trailing_whitespace.nil? &&
+        @insert_final_newline.nil?
+    end
+
+    def defaults?
+      minimum? &&
+        @file_type == :* &&
+        @root.nil?
+    end
+  end
+end

data/lib/editorconfig/file_generator.rb

@@ -0,0 +1,29 @@
+module EditorConfigGenerator
+  # Generates a .editorconfig file when given a valid configuration object
+  class FileGenerator
+    def initialize(configs)
+      @configs = configs
+    end
+
+    def preview_output
+      output = ''
+      @configs.each do |config|
+        if output.include? 'root='
+          output << config.to_s_without_root
+          next
+        end
+        output << config.to_s
+      end
+      return output.rstrip if @configs.size > 1
+      output
+    end
+
+    def generate_config_file(location = '.editorconfig')
+      File.delete(location) if File.exist? location
+      file = File.new(location, 'w')
+      file.print(preview_output)
+      file.close
+      file
+    end
+  end
+end

data/lib/editorconfig/option_transformer.rb

@@ -0,0 +1,34 @@
+module EditorConfigGenerator
+  # Transforms options given to an EditorConfig object
+  class OptionTransformer
+    def self.transform_options(options)
+      transform_root_option(options)
+      transform_whitespace_option(options)
+      transform_final_newline_option(options)
+    end
+
+    def self.transform_final_newline_option(options)
+      if options[:insert_final_newline] == 'y'
+        options[:insert_final_newline] = true
+      elsif options[:insert_final_newline] == 'n'
+        options[:insert_final_newline] = false
+      end
+    end
+
+    def self.transform_whitespace_option(options)
+      if options[:trim_trailing_whitespace] == 'y'
+        options[:trim_trailing_whitespace] = true
+      elsif options[:trim_trailing_whitespace] == 'n'
+        options[:trim_trailing_whitespace] = false
+      end
+    end
+
+    def self.transform_root_option(options)
+      if options[:root] == 'y'
+        options[:root] = true
+      elsif options[:root] == 'n'
+        options[:root] = false
+      end
+    end
+  end
+end

data/lib/editorconfig/version.rb

@@ -0,0 +1,3 @@
+module EditorConfigGenerator
+  VERSION = '0.2.3'.freeze
+end

data/lib/generator.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require_relative './editorconfig/argument_parser'
+
+# The module that encapsulates all of the EditorConfig logic
+module EditorConfigGenerator
+  # Automatically load the help if invalid arguments are given.
+  ARGV.push('-h') if ARGV.empty? || ARGV != '-g' || ARGV != '--generate'
+  ArgumentParser.parse(ARGV)
+end

data/readme.md

@@ -0,0 +1,45 @@
+[![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).

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: editorconfig_generator
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+platform: ruby
+authors:
+- Muyiwa Olu-Ogunleye
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: |-
+  Allow users to generate .editorconfig files quickly and
+                          easily using presets or custom options.
+email:
+- hello@muyiwa.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- Makefile
+- Rakefile
+- bin/console
+- bin/setup
+- changelog.md
+- circle.yml
+- editorconfig-generator.gemspec
+- install.sh
+- lib/editorconfig/argument_parser.rb
+- lib/editorconfig/editor_config.rb
+- lib/editorconfig/file_generator.rb
+- lib/editorconfig/option_transformer.rb
+- lib/editorconfig/version.rb
+- lib/generator.rb
+- readme.md
+homepage: https://github.com/muyiwaolu/editorconfig_generator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Allow users to generate .editorconfig files.
+test_files: []