forspell 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67422b4f2942f8a061b0551a4fa837c0c0c93140
-  data.tar.gz: b56c34d10ecd2bee9dbfa14757ec7853d8a6fe17
+SHA256:
+  metadata.gz: 9b5038eb72a4bc473d5e567d4a0f77a699f99f0452ccfe59107e999d2bc6baf4
+  data.tar.gz: 5d657cf3c28c6c01c92aa4aa57d85dbf24baf8fef9d946d2c026755b7c114e65
 SHA512:
-  metadata.gz: 1e2512ac8231b29ac095fdf2d71b426a82ba9365c6ae4d9cbf52f349f76b12bf7cdfe170b2001b4f0fe7b3fc4239175f59d8cec7f9742880c30d7a0bc8c88cff
-  data.tar.gz: 432eb94fcf818aba269b8292988956ba905964426e239ae35a9c3972813d6d1b7c19d9a1da2e4146d3f649bfbe13902359ba49fe532458e330e04c6cc4ad89b7
+  metadata.gz: 5d36717ed7a398c0d48d417177be3b16f7100aa94b803e4125fc78c0d757f7e06c0df91cb2207f38d93ad280e11e52928ea7874ffaec7ede6310089ba8b13a69
+  data.tar.gz: 88370117516966529328dcde00931879523a58876204a4450d65e12144080ab328c806cde043c8fae7182156979da9018487f5146f7778f0203426278625c533

data/README.md

@@ -44,7 +44,10 @@ Options:
     --help
 ```
 
-forspell automatically loads command-line arguments from `.forspell` file in current folder, if it is present.
+`forspell` automatically loads command-line arguments from `.forspell` file in current folder, if it is present.
+Arguments for `forspell` command are directories or separate files you want to check.
+If no arguments provided, current directory will be processed.
+Supported file extensions are `.rb`, `.c`, `.cpp`, `.md`.
 
 ### Dictionaries
 

data/lib/forspell/cli.rb

@@ -38,9 +38,9 @@ module Forspell
 
     def call
       init_options
+      init_reporter
       create_files_list
       init_speller
-      init_reporter
       run
     end
 
@@ -48,6 +48,9 @@ module Forspell
 
     def create_files_list
       @files = FileList.new(paths: @opts.arguments, exclude_paths: @opts[:exclude_paths])
+    rescue Forspell::FileList::PathLoadError => path
+      @reporter.path_load_error path
+      exit ERROR_CODE
     end
 
     def init_options
@@ -55,11 +58,7 @@ module Forspell
 
       @opts = Slop.parse(@options, &DEFINITIONS)
 
-      if @opts.arguments.empty?
-        puts 'Usage: forspell paths to check [options]'
-        puts 'Type --help for more info'
-        exit(ERROR_CODE)
-      end
+      @opts.arguments << '.' if @opts.arguments.empty?
       
       @opts[:format] = 'dictionary' if @opts[:gen_dictionary]
       @opts[:format] = @opts[:format]&.downcase
@@ -88,9 +87,6 @@ module Forspell
       runner = Forspell::Runner.new(files: @files, speller: @speller, reporter: @reporter)
       runner.call
       exit @reporter.finalize
-    rescue Forspell::FileList::PathLoadError => path
-      @reporter.path_load_error path
-      exit ERROR_CODE
     end
   end
 end

data/lib/forspell/reporter.rb

@@ -13,10 +13,16 @@ module Forspell
     ERROR_CODE = 1
     DICT_PATH = File.join(Dir.pwd, 'forspell.dict')
     DICT_OVERWRITE = 'Do you want to overwrite forspell.dict? (yN)'
+    DICT_PROMPT = <<~PROMPT 
+      # Format: one word per line. Empty lines and #-comments are supported too.
+      # If you want to add word with its forms, you can write 'word: example' (without quotes) on the line,
+      # where 'example' is existing word with the same possible forms (endings) as your word.
+      # Example: deduplicate: duplicate
+    PROMPT
     SUGGEST_FORMAT = '(suggestions: %<suggestions>s)'
     ERROR_FORMAT = '%<file>s:%<line>i: %<text>s %<suggest>s'
     SUMMARY = "Forspell inspects *.rb, *.c, *.cpp, *.md files\n"\
-              '%<files>i inspected, %<errors>s detected'
+              '%<files>i file%<files_plural>s inspected, %<errors>s error%<errors_plural>s detected'
 
     attr_accessor :progress_bar
 
@@ -51,7 +57,7 @@ module Forspell
       @logger.error "Parsing error in #{@files.last}: #{error}"
     end
 
-    def path_load_error path
+    def path_load_error(path)
       @logger.error "Path not found: #{path}"
     end
 
@@ -93,7 +99,11 @@ module Forspell
       color = err_count.positive? ? :red : :green
       total_errors_colorized = @pastel.decorate(err_count.to_s, color)
 
-      print format(SUMMARY, files: @files.size, errors: total_errors_colorized)
+      print format(SUMMARY,
+                   files: @files.size,
+                   errors: total_errors_colorized,
+                   files_plural: @files.size == 1 ? '' : 's',
+                   errors_plural: err_count == 1 ? '' : 's')
     end
 
     def print_dictionary
@@ -105,6 +115,7 @@ module Forspell
       else
         out = File.new(DICT_PATH, 'w')
       end
+      out.puts DICT_PROMPT unless out.tty?
       @errors.map(&:first)
              .group_by(&:text)
              .transform_values { |v| v.map(&:file).uniq }
@@ -117,7 +128,7 @@ module Forspell
 
     private
 
-    def print something
+    def print(something)
       $stdout.tty? ? @progress_bar&.log(something) : puts(something)
     end
   end

data/lib/forspell/speller.rb

@@ -37,12 +37,12 @@ module Forspell
         
         alterations.any?{ |w| dictionary.check?(w) }
       else
-        parts.all? { |part| correct?(part) }
+        dictionary.check?(word) || parts.all? { |part| correct?(part) }
       end
     end
 
     def suggest(word)
-      @suggestions_size.positive? ? dictionary.suggest(word).first(@suggestions_size) : []
+      @suggestions_size.positive? ? dictionary.suggest(word).first(@suggestions_size) - [word, word.capitalize] : []
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forspell
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Kirill Kuprikov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -257,8 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: For spelling check