forspell 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67422b4f2942f8a061b0551a4fa837c0c0c93140
-  data.tar.gz: b56c34d10ecd2bee9dbfa14757ec7853d8a6fe17
+SHA256:
+  metadata.gz: 16e96dc4e732badadf52412ae2cc8d2f6fd1b900e760151b8c8a8b0172eef612
+  data.tar.gz: ffbf262ff89973346045aa6e586ae0a7e31f1fbbfc284d7bd7c3448b8218ab2b
 SHA512:
-  metadata.gz: 1e2512ac8231b29ac095fdf2d71b426a82ba9365c6ae4d9cbf52f349f76b12bf7cdfe170b2001b4f0fe7b3fc4239175f59d8cec7f9742880c30d7a0bc8c88cff
-  data.tar.gz: 432eb94fcf818aba269b8292988956ba905964426e239ae35a9c3972813d6d1b7c19d9a1da2e4146d3f649bfbe13902359ba49fe532458e330e04c6cc4ad89b7
+  metadata.gz: 50ac0b2e6b5b3e243d4ee11abeb84b22374e45623d142521111ebe3bb2e81f0118b944be72099212775f9f64a9b13c0260f04b2255b5d3a541a7b03214a9db3a
+  data.tar.gz: 675033785e77aa12a510589519ee2177f126fb9cf54dab53071d6006a5114fa7fc05d12e465a08ebe8acc01135c2bdd7aad71aee9626bba96fa3ddc7a240e1bd

data/README.md

@@ -3,21 +3,21 @@
 [![Gem Version](https://badge.fury.io/rb/forspell.svg)](http://badge.fury.io/rb/forspell)
 [![Build Status](https://travis-ci.org/kkuprikov/forspell.svg?branch=master)](https://travis-ci.org/kkuprikov/forspell)
 
-**Forspell** is spellchecker for code and documentation. It uses well-known [hunspell](https://en.wikipedia.org/wiki/Hunspell) tool and dictionary, provides customizable output, and could be easily integrated into CI pipeline.
+**Forspell** is a spellchecker for code and documentation. It uses the well-known [hunspell](https://en.wikipedia.org/wiki/Hunspell) tool and dictionary, provides customizable output, and could be easily integrated into CI pipeline.
 
-Example of output:
+Here's an output example:
 
 ![](https://user-images.githubusercontent.com/713419/55152630-d775a600-5161-11e9-9c56-d9fb45d8a3a4.png)
 
 ## Features
 
-* Able to check Markdown files and comments inside Ruby, C and C++ source code;
-* Correctly skips over code examples and identifiers inside comments and Markdown most of the time;
+* Ability to check Markdown files and comments in Ruby, C and C++ code;
+* Skipping over code examples and identifiers inside comments and Markdown most of the time;
 * Distributed with latest en-US hunspell dictionaries, but can be set to use any other dictionary;
-* Includes by default custom Ruby ecosystem-related dictionary (so it will not report as misspelled words like "Gemfile", "args", "middleware" and alike);
-* It is easy to create custom dictionary for your project, so your internal terms would not be reported as misspellings;
+* Includes a custom Ruby ecosystem-related dictionary (so it will not report words like "Gemfile", "args", "middleware" and alike as misspelled);
+* Easiness to create a custom dictionary for your project, so your internal terms would not be reported as misspellings;
 * Option to auto-generate initial custom dictionary;
-* Several output formats, including pretty colorized human-readable, YAML and JSON.
+* Several output formats, including pretty print, YAML and JSON.
 
 ## Installation
 
@@ -25,7 +25,7 @@ Example of output:
 gem install forspell
 ```
 
-`forspell` requires `libhunspell` >= 1.2.0 to be installed, see [hunspell site](https://github.com/hunspell/hunspell) for installation instructions (it is probably as easy as `<yourpackagemanager> install hunspell` on most of Linuxes and MacOS).
+`forspell` requires `libhunspell` >= 1.2.0 to be installed, see [hunspell site](https://github.com/hunspell/hunspell) for installation instructions (it is probably as easy as `<yourpackagemanager> install hunspell` on most of *nix and MacOS).
 
 ## Usage
 
@@ -44,26 +44,29 @@ 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.
+With no arguments provided, a current directory will be processed.
+Supported file extensions are `.rb`, `.c`, `.cpp`, `.md`.
 
 ### Dictionaries
 
-As already said, forspell uses hunspell dictionaries to check spelling. By default, it is `en_US` modern dictionary, distributed with forspell itself, but you can specify any other with `-d` option. If you have `/some/custom/path/fr_FR.aff` and `/some/custom/path/fr_FR.dic`, than you can use it instead of `en_US` with `-d /some/custom/path/fr_FR`.
+Forspell uses hunspell dictionaries to check spelling. By default, it is the `en_US` modern dictionary, distributed with forspell itself, but you can specify any other with `-d` option. If you have `/some/custom/path/fr_FR.aff` and `/some/custom/path/fr_FR.dic`, than you can use it instead of `en_US` with `-d /some/custom/path/fr_FR`.
 
 In addition to the main dictionary, forspell also includes (and always uses) small auxiliary dictionary with words specific for Ruby ecosystem, you can review it in [forspell repo](https://github.com/kkuprikov/forspell/blob/master/lib/forspell/ruby.dict).
 
-You can also add your project's **custom dictionary** with internal terms, for them not to obstruct spellchecker's output. Custom dictionary (or several) can be passed with `-c` option. Also, `forspell.dict` would be automatically read, if present in current directory. Format of custom dictionary:
+You can also add your project's **custom dictionary** with internal terms, for them not to obstruct spellchecker's output. Custom dictionary (or several) may be passed with `-c` option. Also, `forspell.dict` will be automatically processed, if presented in current directory. Format of custom dictionary:
 
 * Each word on its own line.
 * Line contains either just `word` (means only this word in this form).
 * ...or `word: example` -- in this case, "example" should be existing word from the main dictionary, and it means your custom term can have the same forms as example word. For example, "subclass: class" will mean that "subclass", "subclasses" and "subclass'" should be considered correct.
 * `#` marks comments.
 
-For larger projects, it is handy to generate custom dictionary with `forspell your,project,pathes --gen-dictionary`. This will create `forspell.dict` with all misspelling found in your project, you can proceed by deleting genuine errors and leave what should be considered correct internal terms.
+For larger projects, it is handy to generate a custom dictionary with `forspell your,project,paths --gen-dictionary`. This will create `forspell.dict` with all misspellings found in your project, and you can proceed by deleting genuine errors and leave internal terms, which should be considered correct.
 
 ## Integration with CI
 
-Forspell return codes:
+Forspell's return codes:
 
 * 0 - when no errors found
 * 1 - when there are any errors

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/file_list.rb

@@ -36,7 +36,7 @@ module Forspell
     def expand_paths(path)
       if File.directory?(path)
         Dir.glob(File.join(path, '**', "*.{#{EXTENSION_GLOBS.join(',')}}"))
-      elsif File.exists? path
+      elsif File.exist? path
         path
       else
         raise PathLoadError, path

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.9
 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: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -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.3.1
 signing_key: 
 specification_version: 4
 summary: For spelling check