spellr 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52262546809e049a6c04f71c067d895e2cd83b865bc1371a4c9c489ca8b8b5b7
-  data.tar.gz: c75f1e3037419fb9e917cac1d808fa3f32a882f0c76bb2a871ddca8ac8b33ea3
+  metadata.gz: 80438eca6b5b281ceab331e0ab9886fcb9c622cfe1e91ca2762ed10628c44ee1
+  data.tar.gz: 434910ca88653cb6a7d4bb11dabc32e4c782b22df4e65cc488ebaf6439bb3b38
 SHA512:
-  metadata.gz: 12771b2588b7b8e2bfdfadec6c78cf4dd5f90000730451f8f8f7f066de77aba171a6227fa9c3a0ea914fb3dd7f33cd975b9dcfb2d73d0fb11a03898e460ed489
-  data.tar.gz: bfa05561e73da2b21fe6d2e7a138c8dfae8eda29dcadb83dd5c10e31b5d7b525b18161f8f9cd944b1d58ae1b46022ca2a4e4d05c7efad68d3363540714ca6b16
+  metadata.gz: b14f3fe397b01f9a7e1742246a451e68238833c98e98b6716e36a11bb38d556463d992a0cdb8577f2dac2b65bb39eb0a9f3d050f884814c7449d0b6d2239e013
+  data.tar.gz: 45fe01c33fd31faafd21248751f2a85f38c3807b75eb242fa994ffbdd14735f2dde343cf397b5f14281a24107ca5532d45b4c107b720546ac4994121c5599e58

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.8.5
+- Single line disable! use `spellr:disable-line` #25
+
 # v0.8.4
 - Update fast_ignore dependency, it's faster now (about 0.5s faster on rails codebase)
 

data/README.md

@@ -175,14 +175,21 @@ Type `e` to add this word to the english wordlist and continue on through the sp
 
 ### Disabling the tokenizer
 
-If the tokenizer finds a word you don't want to add to the wordlist (perhaps it's an intentional example of a typo, or a non-word string not excluded by the heuristic) then place on the lines before and after
+If the tokenizer finds a word you don't want to add to the wordlist (perhaps it's an intentional example of a typo, or a non-word string not excluded by the heuristic) then add any kind of comment containing `spellr:disable-line` to the line.
+```ruby
+open('mispeled_filename.txt') # spellr:disable-line
+```
+
+You can also disable multiple lines, by surrounding the offending code with `spellr:disable` and `spellr:enable`
 ```ruby
 # spellr:disable
-"Test typo of the: teh"
+it "Test typo of the: teh" do
+  fill_in(field, with: "teh")
+end
 # spellr:enable
 ```
 
-This works with any kind of comment, even in the same line
+If your language supports inline comments you can also surround with `spellr:disable` and `spellr:enable` in the same line:
 ```html
 <span><!-- spellr:disable -->nonsenseword<!-- spellr:enable --></span>
 ```

data/lib/spellr/check.rb

@@ -7,6 +7,7 @@ require_relative 'string_format'
 module Spellr
   class Check
     attr_reader :files, :reporter
+
     include StringFormat
 
     def exit_code

data/lib/spellr/token_regexps.rb

@@ -98,5 +98,6 @@ module Spellr
 
     SPELLR_DISABLE_RE = /spellr:disable/.freeze
     SPELLR_ENABLE_RE = /spellr:enable/.freeze
+    SPELLR_LINE_DISABLE_RE = /spellr:disable[-:]line/.freeze
   end
 end

data/lib/spellr/tokenizer.rb

@@ -28,7 +28,7 @@ module Spellr
 
     def each_term(&block)
       file.each_line do |line|
-        prepare_tokenizer_for_line(line).each_term(&block)
+        prepare_tokenizer_for_line(line)&.each_term(&block)
       end
     ensure
       file.close
@@ -36,7 +36,7 @@ module Spellr
 
     def each_token(skip_term_proc: nil) # rubocop:disable Metrics/MethodLength
       each_line_with_stats do |line, line_number, char_offset, byte_offset|
-        prepare_tokenizer_for_line(line).each_token(skip_term_proc: skip_term_proc) do |token|
+        prepare_tokenizer_for_line(line)&.each_token(skip_term_proc: skip_term_proc) do |token|
           token.line = prepare_line(line, line_number, char_offset, byte_offset)
 
           yield token
@@ -75,6 +75,8 @@ module Spellr
     attr_reader :line_tokenizer
 
     def prepare_tokenizer_for_line(line)
+      return if line.match?(Spellr::TokenRegexps::SPELLR_LINE_DISABLE_RE)
+
       line_tokenizer.string = line
       line_tokenizer.pos = 0
       line_tokenizer

data/lib/spellr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spellr
-  VERSION = '0.8.4'
+  VERSION = '0.8.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spellr
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2020-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -315,8 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.10
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Spell check your source code