colorls 0.1.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1466b9e0c4a5e7e722f61b3bc23c72393c84b209
-  data.tar.gz: 2e7fb89508e0e73a5ebf2c895d9054bb2961ea91
+  metadata.gz: 03284e40013cff842081767d4f8118e037ab5ecf
+  data.tar.gz: f9f342894cccb5dc7f5231e4273f8ebacf17877e
 SHA512:
-  metadata.gz: 5e9549e3bb540525c3b7118eae86ac2b77bd4d325e5c0e1764866cc82274ffc80010b997b0996c9173f9b921afdbd4afcf1c364e0e67ccee3ec77161db1b43d4
-  data.tar.gz: f8f3c48565b330c01dd075b8a1a9e056913d7d1079c196aa7adf350645c8d0fd9fc80264f3393d7334c212f8f168535cc6f8aba22ef332e1005b5cae7357a534
+  metadata.gz: 1597a907cc5fb9b4dc1a9e928d6ef514cd49d19f44ae8a9723382edb25b2652faf561fa238509351b8a0f41c94fb101c231dafe90c9368e24e2924a42a400f52
+  data.tar.gz: 9af5861331a7d00b3c3ee7336352cb17cb053b26b3d47e3fd6566950e16dcefece09b9c0e451e7e7c98dc067e85c050f46442c42d87c60980b3bea64bc58fbfe

data/.rubocop.yml

@@ -45,10 +45,13 @@ Metrics/ModuleLength:
   Max: 200
 
 Metrics/ClassLength:
-  Max: 250
+  Max: 300
 
 Metrics/ParameterLists:
-  Max: 10
+  Max: 15
+
+Naming/FileName:
+  Enabled: false
 
 Style/ParallelAssignment:
   Enabled: false
@@ -71,22 +74,22 @@ Layout/SpaceAroundOperators:
 Style/EmptyCaseCondition:
   Enabled: false
 
-Style/FileName:
-  Enabled: false
-
 Style/MultilineBlockChain:
   Enabled: false
 
 # Current preferred metrics --------------------------------------------
 # Better values are encouraged, but not required.
 Metrics/AbcSize:
-  Max: 20
+  Max: 30
 
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
 
 Metrics/CyclomaticComplexity:
-  Max: 7
+  Max: 8  
+
+Metrics/PerceivedComplexity:
+  Max: 8
 
 # TODO -----------------------------------------------------------------
 

data/.travis.yml

@@ -19,10 +19,14 @@ script:
   - colorls -f
   - colorls -l
   - colorls -l spec/fixtures/symlinks
+  - ( cd spec/fixtures ; colorls .hidden-file ) | fgrep '.hidden-file'
+  - colorls -l README.md
   - colorls -r
-  - colorls -sd
-  - colorls -sf
+  - colorls --sd
+  - colorls --sf
   - colorls -t
+  - colorls -h
+  - colorls --gs
   - colorls spec/fixtures/symlinks
   - colorls README.md
   - colorls *

data/CONTRIBUTING.md

@@ -28,6 +28,9 @@ Please proceed with a Pull Request only after you're assigned. It'd be sad if yo
 3. (Optional) To test whether `colorls` executable is working properly, do 
     ```sh
     rake install
+    ```
+    Then install the gem file in the folder `pkg`. After that to use the new binary,
+    ```sh
     colorls # start using colorls
     ```
 
@@ -42,3 +45,5 @@ Please proceed with a Pull Request only after you're assigned. It'd be sad if yo
     bundle exec rubocop
     bundle exec rspec
     ```
+
+6. (Required for new flags) Add command to `.travis.yml` file.

data/COVERAGES.md

@@ -0,0 +1,14 @@
+# COVERAGES
+
+A documentation of all the places on the World Wide Web, where `colorls` has been featured:
+
+- [YouTube : File Icons on Linux Terminal](https://m.youtube.com/watch?v=NESi45Q2mHg)
+- [GitHub : Awesome README](https://github.com/matiassingers/awesome-readme)
+- [HackerNews : Colorls – A Ruby script that beautifies the terminal's ls command](https://news.ycombinator.com/item?id=14717341)
+- [GitHub : A curated list of Terminal frameworks, plugins & resources for CLI lovers](https://github.com/k4m4/terminals-are-sexy)
+- [Facebook : colorls story](https://m.facebook.com/story.php?story_fbid=1972265916349994&id=1884586571784596)
+- [openruby : colorls a ruby script that beautifies the terminals ls](https://openruby.com/pages/98288680-colorls-a-ruby-script-that-beautifies-the-terminals-ls)
+- [omgubuntu : add-bling-ls-bash-command-colorls](http://www.omgubuntu.co.uk/2017/07/add-bling-ls-bash-command-colorls)
+- [GitHub : nerd-fonts](https://github.com/ryanoasis/nerd-fonts/wiki/Real-World-Mentions-&-Usage-(Sightings))
+- [GitHub : Awesome Ruby](https://github.com/markets/awesome-ruby)
+- [GitHub : Awesome Shell](https://github.com/uhub/awesome-shell)

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,12 @@
+### Description
+
+Thanks for opening this issue. Add a brief description of what this issue is, and how to recreate it. Do tag the relevant issue(s) and PR(s) below. If required, add some screenshot(s) to showcase the issue.
+
+- Relevant Issues : (none)
+- Relevant PRs : (none)
+- Type of issue :
+  - [ ] Installation
+  - [ ] Font-related
+  - [ ] Feature request
+  - [ ] Bug in existing feature
+  - [ ] Developer mode : Code quality / Tests / Documentation

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+### Description
+
+Thanks for contributing this Pull Request. Add a brief description of what this Pull Request does. Do tag the relevant issue(s) and PR(s) below. If required, add some screenshot(s) to support your changes.
+
+- Relevant Issues : (none)
+- Relevant PRs : (none)
+- Type of change :
+  - [ ] New feature
+  - [ ] Bug fix for existing feature
+  - [ ] Code quality improvement
+  - [ ] Addition or Improvement of tests
+  - [ ] Addition or Improvement of documentation

data/README.md

@@ -6,9 +6,8 @@
 [![Gem Version](https://badge.fury.io/rb/colorls.svg)](https://badge.fury.io/rb/colorls)
 [![Build Status](https://travis-ci.org/athityakumar/colorls.svg?branch=master)](https://travis-ci.org/athityakumar/colorls)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)
-[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
 
-A Ruby script that colorizes the `ls` output with color and icons. Here are the screenshots of working example on an iTerm2 terminal (Mac OS), `oh-my-zsh` with `powerlevel9k` theme and `powerline nerd-font + awesome-config` font with the `Solarized Dark` color theme. 
+A Ruby script that colorizes the `ls` output with color and icons. Here are the screenshots of working example on an iTerm2 terminal (Mac OS), `oh-my-zsh` with `powerlevel9k` theme and `powerline nerd-font + awesome-config` font with the `Solarized Dark` color theme.
 
 ![Example #1](readme/usage1.png)
 
@@ -19,6 +18,7 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the
 - [Usage](#usage)
 - [Installation](#installation)
 - [Recommended configurations](#recommended-configurations)
+- [Custom configurations](#custom-configurations)
 - [Updating](#updating)
 - [Uninstallation](#uninstallation)
 - [Contributing](#contributing)
@@ -28,15 +28,15 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the
 
 [(Back to top)](#table-of-contents)
 
-- Just `lc` : Prints all directories, files and dotfiles in current directory.
+- With `-a` : `lc` prints all directories, files and dotfiles in current directory.
 
   ![Usage #1](readme/usage1.png)
 
-- With paths : `lc path(s)` prints all directories, files and dotfiles in given directory / directories.
+- With paths : `lc path(s) -a` prints all directories, files and dotfiles in given directory / directories.
 
   ![Usage #2](readme/usage2.png)
 
-- With `--report` or `-r` flag : `lc path(s) -r` : Prints all directories, files and dotfiles in directories, along with a brief report about number of files and folders shown.
+- With `--report` or `-r` flag : `lc path(s) -r -a` : Prints all directories, files and dotfiles in directories, along with a brief report about number of files and folders shown.
 
   ![Usage #3](readme/usage3.png)
   ![Usage #4](readme/usage4.png)
@@ -55,14 +55,16 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the
 
   ![Usage #9](readme/usage9.png)
 
+- Additional flags: `--almost_all` or `-A`, `--long` or `-l`, `--tree` or `-t`
+
 # Installation
 
 [(Back to top)](#table-of-contents)
 
-1. Install Ruby (prefably, version > 2.1)
-2. Install the patched fonts of powerline nerd-font and/or font-awesome. Have a look at [nerdfont's README](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md) for more installation instructions.
+1. Install Ruby (preferably, version > 2.1)
+2. Install the patched fonts of powerline nerd-font and/or font-awesome. Have a look at the [Nerd Font README](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md) for more installation instructions.
 
-    *Note for `iTerm2` users - Please enable the nerd-font at iTerm2 > Preferences > Profiles > Text > Non-Ascii font > Knack Regular Nerd Font Complete.*
+    *Note for `iTerm2` users - Please enable the Nerd Font at iTerm2 > Preferences > Profiles > Text > Non-ASCII font > Knack Regular Nerd Font Complete.*
 
 3. Install the [colorls](https://rubygems.org/gems/colorls/) ruby gem with `gem install colorls`
 
@@ -88,9 +90,25 @@ A Ruby script that colorizes the `ls` output with color and icons. Here are the
 2. For changing the icon(s) to other unicode icons of choice (select icons from [here](https://nerdfonts.com/)), change the YAML files in a text editor of your choice (say, `subl`)
 
     ```sh
-    subl $(gem which colorls)/../yaml/
+    subl $(dirname $(gem which colorls))/yaml
     ```
 
+# Custom configurations
+
+[(Back to top)](#table-of-contents)
+
+You can overwrite the existing icons and colors mapping by creating yaml files in ~/.config/lscolors.
+
+Each .yaml file inside the lib/colorls/yaml directory of this repo can be overwrited.
+
+Let's say you want to add an icon for swift files, you might create a `files.yaml` inside `~/.config/lscolors` and add the following:
+
+```
+swift: "\uF179"
+```
+
+Which will add the Apple logo to swift files.
+
 # Updating
 
 [(Back to top)](#table-of-contents)

data/RELEASE_POLICY.md

@@ -0,0 +1,20 @@
+# Release Policy
+
+Applicable from colorls v1.0.0 onwards
+
+### Versioning
+
+Colorls follows semantic versioning whereby the version number is always in the form MAJOR.MINOR.PATCH
+
+- Patch bump : Bug fixes
+- Minor bump : New features (with backwards compatibility)
+- Major bump : API breaking changes
+
+For Major and Minor bumps release candidates should be released around 2 weeks prior to the bump and are indicated by MAJOR.MINOR.0.rc.
+
+For more information see the full semantic versioning specification at http://semver.org/.
+
+### Release Timing
+
+Patch releases should be done after every fix of a major bug (as tagged in the github issue tracker).
+Major releases should be kept to the minimum.

data/Rakefile

@@ -1,6 +1,11 @@
-require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rubygems/tasks'
+Gem::Tasks.new
+
 require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 
-RSpec::Core::RakeTask.new(:spec)
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: %w[spec rubocop]

data/colorls.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'colorls/version'
@@ -21,14 +19,29 @@ Gem::Specification.new do |spec|
   spec.executables   = 'colorls'
   spec.require_paths = ['lib']
 
+  spec.post_install_message = <<-EOF
+*************************************************************************
+  Changes introduced in colorls-v1.0.0
+
+  Sort by dirs  : -sd flag has been renamed to --sd
+  Sort by files : -sf flag has been renamed to --sf
+  Git status    : -gs flag has been renamed to --gs
+
+  Clubbed flags : `colorls -ald` works
+  Help menu     : `colorls -h` provides all possible flag options
+*************************************************************************
+EOF
+
   spec.add_runtime_dependency 'colorize'
   spec.add_runtime_dependency 'facets'
-  spec.add_runtime_dependency 'ruby-terminfo'
   spec.add_runtime_dependency 'filesize'
+  spec.add_runtime_dependency 'git'
+  spec.add_runtime_dependency 'ruby-terminfo'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'diffy'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'diffy'
+  spec.add_development_dependency 'rubygems-tasks'
 end

data/lib/colorls.rb

@@ -4,6 +4,7 @@ require 'facets'
 require 'terminfo'
 require 'etc'
 require 'filesize'
+require 'git'
 
 require 'colorls/core'
 require 'colorls/flags'

data/lib/colorls/core.rb

@@ -1,7 +1,7 @@
 module ColorLS
   class Core
     def initialize(input=nil, all: false, report: false, sort: false, show: false,
-      one_per_line: false, long: false, almost_all: false, tree: false, colors: [])
+      one_per_line: false, git_status: false,long: false, almost_all: false, tree: false, colors: [])
       @input        = input || Dir.pwd
       @count        = {folders: 0, recognized_files: 0, unrecognized_files: 0}
       @all          = all
@@ -12,6 +12,7 @@ module ColorLS
       @one_per_line = one_per_line
       @long         = long
       @tree         = tree
+      @git_status   = git_status
       @screen_width = ::TermInfo.screen_size.last
       @colors       = colors
 
@@ -33,20 +34,21 @@ module ColorLS
       end
       print "\n"
       display_report if @report
-
       true
     end
 
     private
 
     def init_contents(path)
-      @contents = if Dir.exist?(path)
+      is_directory = Dir.exist?(path)
+      @contents = if is_directory
                     Dir.entries(path)
                   else
-                    [path]
+                    @input = File.dirname(path)
+                    [File.basename(path)]
                   end
 
-      filter_hidden_contents
+      filter_hidden_contents if is_directory
       filter_contents(path) if @show
       sort_contents(path)   if @sort
 
@@ -149,8 +151,7 @@ module ColorLS
     end
 
     def in_line(chunk_size)
-      return false if @max_widths.sum + 8 * chunk_size > @screen_width
-      true
+      (@max_widths.sum + 12 * chunk_size <= @screen_width)
     end
 
     def display_report
@@ -202,27 +203,50 @@ module ColorLS
 
     def size_info(stat)
       size = Filesize.from("#{stat.size} B").pretty.split(' ')
-      "#{size[0][0..-4].rjust(3,' ')} #{size[1].ljust(3,' ')}".colorize(@colors[:normal])
+      size = "#{size[0][0..-4].rjust(3,' ')} #{size[1].ljust(3,' ')}"
+      return size.colorize(@colors[:file_large])  if stat.size >= 512 * 1024 ** 2
+      return size.colorize(@colors[:file_medium]) if stat.size >= 128 * 1024 ** 2
+      size.colorize(@colors[:file_small])
     end
 
     def mtime_info(stat)
-      mtime = stat.mtime.asctime.colorize(@colors[:no_modifier])
-      mtime = mtime.colorize(@colors[:day_old]) if Time.now - stat.mtime < 24 * 60 * 60
-      mtime = mtime.colorize(@colors[:hour_old]) if Time.now - stat.mtime < 60 * 60
-      mtime
+      mtime = stat.mtime.asctime
+      return mtime.colorize(@colors[:hour_old]) if Time.now - stat.mtime < 60 * 60
+      return mtime.colorize(@colors[:day_old])  if Time.now - stat.mtime < 24 * 60 * 60
+      mtime.colorize(@colors[:no_modifier])
+    end
+
+    def git_info(path, content)
+      return '' unless @git_status
+      until File.exist?('.git') # check whether the repository is git controlled
+        return '' if Dir.pwd=='/'
+        Dir.chdir('..')
+      end
+
+      relative_path = path.remove(Dir.pwd+'/')
+      relative_path = relative_path==path ? '' : relative_path+'/'
+
+      status = Git.open('.').status
+      return '(A)'.colorize(:green) if status.added.keys.any? { |a| a.include?("#{relative_path}#{content}") }
+      return '(U)'.colorize(:red) if status.untracked.keys.any? { |u| u.include?("#{relative_path}#{content}") }
+      return '(C)'.colorize(:yellow) if status.changed.keys.any? { |c| c.include?("#{relative_path}#{content}") }
+      '(-)'
     end
 
     def long_info(path, content)
       return '' unless @long
+      @git_status = true
       unless File.exist?("#{path}/#{content}")
         return '[No Info]'.colorize(@colors[:error]) + ' ' * (39 + @userlength + @grouplength)
       end
       stat = File.stat("#{path}/#{content}")
-      [mode_info(stat), user_info(stat), group_info(stat), size_info(stat), mtime_info(stat)].join('  ')
+      @git_status = false
+      [mode_info(stat), user_info(stat), group_info(stat), size_info(stat), mtime_info(stat),git_info(path,content)]
+        .join('  ')
     end
 
     def symlink_info(path, content)
-      return '' unless @long && File.lstat("#{path}/#{content}").symlink?
+      return '' unless @long && File.symlink?("#{path}/#{content}")
       if File.exist?("#{path}/#{content}")
         " ⇒ #{File.readlink("#{path}/#{content}")}/".colorize(@colors[:link])
       else
@@ -241,9 +265,10 @@ module ColorLS
 
       [
         long_info(path, content),
+        "#{git_info(path,content)} ",
         logo.colorize(color),
-        "#{content.colorize(color)}#{slash?(path, content)}#{symlink_info(path, content)}"
-      ].join('  ')
+        "  #{content.colorize(color)}#{slash?(path, content)}#{symlink_info(path, content)}"
+      ].join
     end
 
     def ls_line(chunk)

data/lib/colorls/flags.rb

@@ -1,30 +1,42 @@
+require 'optparse'
+require 'colorls/version'
+
 module ColorLS
   class Flags
     def initialize(*args)
       @args = args
-      set_color_opts
+      @light_colors = false
+      @mode = :one_per_line unless STDOUT.tty?
 
       @opts = {
-        show: fetch_show_opts,
-        sort: fetch_sort_opts,
-        all: flag_given?(%w[-a --all]),
-        almost_all: flag_given?(%w[-A --almost-all]),
-        report: flag_given?(%w[-r --report]),
-        one_per_line: flag_given?(%w[-1]) || !STDOUT.tty?,
-        long: flag_given?(%w[-l --long]),
-        tree: flag_given?(%w[-t --tree]),
-        colors: @colors
+        show: false,
+        sort: false,
+        all: false,
+        almost_all: false,
+        report: false,
+        git_status: false,
+        colors: []
       }
 
-      @args.keep_if { |arg| !arg.start_with?('-') }
+      parse_options
+
+      # handle mutual exclusive options
+      %i[tree long one_per_line].each do |value|
+        @opts[value] = @mode == value
+      end
+
+      return unless @mode == :tree
+
+      # FIXME: `--all` and `--tree` do not work together, use `--almost-all` instead
+      @opts[:almost_all] = true if @opts[:all]
+      @opts[:all] = false
+
+      # `--tree` does not support reports
+      @opts[:report] = false
     end
 
     def process
-      incompatible = report_incompatible_flags
-      return STDERR.puts "\n   #{incompatible}".colorize(:red) if incompatible
-
       return Core.new(@opts).ls if @args.empty?
-
       @args.each do |path|
         next STDERR.puts "\n   Specified path '#{path}' doesn't exist.".colorize(:red) unless File.exist?(path)
         Core.new(path, @opts).ls
@@ -33,66 +45,89 @@ module ColorLS
 
     private
 
-    def flag_given?(flags)
-      flags.each { |flag| return true if @args.include?(flag) }
-      false
+    def add_sort_options(options)
+      options.separator ''
+      options.separator 'sorting options:'
+      options.separator ''
+      options.on('--sd', '--sort-dirs', '--group-directories-first', 'sort directories first') { @opts[:sort] = :dirs }
+      options.on('--sf', '--sort-files', 'sort files first')                                   { @opts[:sort] = :files }
     end
 
-    def set_color_opts
-      light_colors = flag_given? %w[--light]
-      dark_colors  = flag_given? %w[--dark]
-
-      if light_colors && dark_colors
-        @colors = ColorLS.load_from_yaml('dark_colors.yaml', true)
-        STDERR.puts "\n Restrain from using --light and --dark flags together."
-          .colorize(@colors[:error])
-      elsif light_colors
-        @colors = ColorLS.load_from_yaml('light_colors.yaml', true)
-      else # default colors
-        @colors = ColorLS.load_from_yaml('dark_colors.yaml', true)
-      end
-
-      @colors
+    def add_common_options(options)
+      options.on('-a', '--all', 'do not ignore entries starting with .')  { @opts[:all] = true }
+      options.on('-A', '--almost-all', 'do not list . and ..')            { @opts[:almost_all] = true }
+      options.on('-l', '--long', 'use a long listing format')             { @mode = :long }
+      options.on('-t', '--tree', 'shows tree view of the directory')      { @mode = :tree }
+      options.on('-r', '--report', 'show brief report')                   { @opts[:report] = true }
+      options.on('-1', 'list one file per line')                          { @mode = :one_per_line }
+      options.on('-d', '--dirs', 'show only directories')                 { @opts[:show] = :dirs }
+      options.on('-f', '--files', 'show only files')                      { @opts[:show] = :files }
+      options.on('--gs', '--git-status', 'show git status for each file') { @opts[:git_status] = true }
     end
 
-    def fetch_show_opts
-      show_dirs_only   = flag_given? %w[-d --dirs]
-      show_files_only  = flag_given? %w[-f --files]
-
-      if show_files_only && show_dirs_only
-        STDERR.puts "\n  Restrain from using -d and -f flags together."
-          .colorize(@colors[:error])
-        return nil
-      else
-        return :files if show_files_only
-        return :dirs  if show_dirs_only
-        false
-      end
+    def add_general_options(options)
+      options.separator ''
+      options.separator 'general options:'
+
+      options.separator ''
+      options.on('--light', 'use light color scheme') { @light_colors = true }
+      options.on('--dark', 'use dark color scheme') { @light_colors = false }
     end
 
-    def fetch_sort_opts
-      sort_dirs_first  = flag_given? %w[-sd --sort-dirs]
-      sort_files_first = flag_given? %w[-sf --sort-files]
-
-      if sort_dirs_first && sort_files_first
-        STDERR.puts "\n  Restrain from using -sd and -sf flags together."
-          .colorize(@colors[:error])
-        return nil
-      else
-        return :files if sort_files_first
-        return :dirs  if sort_dirs_first
-        false
-      end
+    def show_examples
+      puts <<EXAMPLES.gsub(/^  /, '')
+
+  examples:
+
+    * show the given file:
+
+      #{'colorls README.md'.colorize(:green)}
+
+    * show matching files and list matching directories:
+
+      #{'colorls *'.colorize(:green)}
+
+    * filter output by a regular expression:
+
+      #{'colorls | grep PATTERN'.colorize(:green)}
+
+    * several short options can be combined:
+
+      #{'colorls -d -l -a'.colorize(:green)}
+      #{'colorls -dla'.colorize(:green)}
+
+EXAMPLES
     end
 
-    def report_incompatible_flags
-      return '' if @opts[:show].nil? || @opts[:sort].nil?
+    def parse_options
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage:  colorls [OPTION]... [FILE]...'
+        opts.separator ''
+
+        add_common_options(opts)
+        add_sort_options(opts)
+        add_general_options(opts)
+
+        opts.separator ''
+        opts.on_tail('-h', '--help', 'prints this help') do
+          puts parser
+          show_examples
+          exit
+        end
+        opts.on_tail('--version', 'show version') do
+          puts ColorLS::VERSION
+          exit
+        end
+      end
 
-      return 'Restrain from using -t (--tree) and -r (--report) flags together.' if @opts[:tree] && @opts[:report]
+      parser.parse!(@args)
 
-      return 'Restrain from using -t (--tree) and -a (--all) flags together.' if @opts[:tree] && @opts[:all]
+      set_color_opts
+    end
 
-      nil
+    def set_color_opts
+      color_scheme_file = @light_colors ? 'light_colors.yaml' : 'dark_colors.yaml'
+      @opts[:colors] = ColorLS.load_from_yaml(color_scheme_file, true)
     end
   end
 end

data/lib/colorls/load_from_yaml.rb

@@ -1,11 +1,22 @@
 module ColorLS
   def self.load_from_yaml(filename, aliase=false)
-    filepath = File.join(File.dirname(__FILE__),"../yaml/#{filename}")
-    yaml     = YAML.safe_load(File.read(filepath)).symbolize_keys
+    user_config_filepath = File.join(Dir.home, ".config/colorls/#{filename}")
+    filepath             = File.join(File.dirname(__FILE__),"../yaml/#{filename}")
+    yaml                 = read_file(filepath)
+
+    if File.exist?(user_config_filepath)
+      user_config_yaml = read_file(user_config_filepath)
+      yaml             = yaml.merge(user_config_yaml)
+    end
+
     return yaml unless aliase
     yaml
       .to_a
       .map! { |k, v| [k, v.to_sym] }
       .to_h
   end
+
+  def self.read_file(filepath)
+    YAML.safe_load(File.read(filepath)).symbolize_keys
+  end
 end

data/lib/colorls/version.rb

@@ -1,3 +1,3 @@
 module ColorLS
-  VERSION = '0.1.7'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/yaml/dark_colors.yaml

@@ -18,6 +18,11 @@ day_old:     yellow
 hour_old:    green
 no_modifier: white
 
+# File Size
+file_large:  red
+file_medium: yellow
+file_small:  green
+
 # Random
 report: white
 user:   green

data/lib/yaml/file_aliases.yaml

@@ -3,6 +3,8 @@ gradle:           android
 ds_store:         apple
 localized:        apple
 mp3:              audio
+ogg:              audio
+editorconfig:     conf
 scss:             css
 docx:             doc
 gdoc:             doc
@@ -11,7 +13,7 @@ eot:              font
 otf:              font
 ttf:              font
 woff:             font
-editorconfig:     git
+woff2:            font
 gitconfig:        git
 gitignore:        git
 gitignore_global: git
@@ -25,6 +27,7 @@ png:              image
 svg:              image
 jar:              java
 properties:       json
+tsx:              jsx
 license:          md
 markdown:         md
 mkd:              md
@@ -45,6 +48,8 @@ rspec:            rb
 rspec_parallel:   rb
 rspec_status:     rb
 ru:               rb
+erb:              rubydoc
+slim:             rubydoc
 bash:             shell
 bash_history:     shell
 bash_profile:     shell
@@ -54,8 +59,13 @@ sh:               shell
 zsh:              shell
 zsh-theme:        shell
 zshrc:            shell
+stylus:           styl
 cls:              tex
+avi:              video
+mkv:              video
 mp4:              video
+ogv:              video
+webm:             video
 bat:              windows
 exe:              windows
 ini:              windows

data/lib/yaml/files.yaml

@@ -15,6 +15,7 @@ db:           "\uf1c0"
 diff:         "\uf440"
 doc:          "\uf1c2"
 ebook:        "\ue28b"
+env:          "\uf462"
 epub:         "\ue28a"
 erl:          "\ue7b1"
 file:         "\uf15b"
@@ -22,7 +23,7 @@ font:         "\uf031"
 gform:        "\uf298"
 git:          "\uf1d3"
 go:           "\ue626"
-gruntfile.js: "\ue74c" 
+gruntfile.js: "\ue74c"
 hs:           "\ue777"
 html:         "\uf13b"
 image:        "\uf1c5"
@@ -30,6 +31,7 @@ iml:          "\ue7b5"
 java:         "\ue204"
 js:           "\ue74e"
 json:         "\ue60b"
+jsx:          "\ue7ba"
 less:         "\ue758"
 log:          "\uf18d"
 lua:          "\ue620"
@@ -46,6 +48,8 @@ r:            "\uf25d"
 rb:           "\ue21e"
 rdb:          "\ue76d"
 rss:          "\uf09e"
+rubydoc:      "\ue73b"
+sass:         "\ue603"
 scala:        "\ue737"
 shell:        "\uf489"
 sqlite3:      "\ue7c4"

data/lib/yaml/folders.yaml

@@ -1,8 +1,11 @@
-.git:     "\uf408"
+.atom:    "\ue764"
+.git:     "\uf1d3"
+.github:  "\uf408"
 .rvm:     "\ue21e"
 .Trash:   "\uf1f8"
+.vscode:  "\ue70c"
 config:   "\ue5fc"
 folder:   "\uf115"
 hidden:   "\uf023"
 lib:      "\uf121"
-node_modules: "\ue718"
+node_modules: "\ue718"

data/lib/yaml/light_colors.yaml

@@ -18,6 +18,11 @@ day_old:     yellow
 hour_old:    green
 no_modifier: black
 
+# File Size
+file_large:  red
+file_medium: yellow
+file_small:  green
+
 # Random
 report: black
 user:   green

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colorls
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Athitya Kumar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-14 00:00:00.000000000 Z
+date: 2017-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-terminfo
+  name: filesize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: filesize
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-terminfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: diffy
+  name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -149,9 +177,13 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- COVERAGES.md
 - Gemfile
+- ISSUE_TEMPLATE.md
 - LICENSE.md
+- PULL_REQUEST_TEMPLATE.md
 - README.md
+- RELEASE_POLICY.md
 - Rakefile
 - colorls.gemspec
 - exe/colorls
@@ -180,7 +212,17 @@ homepage: https://github.com/athityakumar/colorls
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |
+  *************************************************************************
+    Changes introduced in colorls-v1.0.0
+
+    Sort by dirs  : -sd flag has been renamed to --sd
+    Sort by files : -sf flag has been renamed to --sf
+    Git status    : -gs flag has been renamed to --gs
+
+    Clubbed flags : `colorls -ald` works
+    Help menu     : `colorls -h` provides all possible flag options
+  *************************************************************************
 rdoc_options: []
 require_paths:
 - lib