typo_checker 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15d511455e488fe8175d4b8eb85f9d7a55647515d39450d1f627254ee90571a3
-  data.tar.gz: 3841f4796632094f9e8b17fb3ff9bdd219e5bb2b783ba11e1ec074788185f72e
+  metadata.gz: 5c8b3393e0c1ba03a25ec61f84423e6523e6e8b1a72cb6fd9b9fbdd2aaeec3fe
+  data.tar.gz: 1b1c5d4867edcafba3fbc9d3dc8128617581e50558ff10746d77476ca36ca133
 SHA512:
-  metadata.gz: a42eb16f7838b9e56e39a290d39682c4bb082c643526038d01b168b5f29a1a922fc8dfc6882d205684a906d0155ff96c610e4ccc9f8386b363cd560d781ef292
-  data.tar.gz: 7c097ec3e93767e28c12c414ec64cc439b06630c3d94983da15f8335ad53077938f3fbbcd240c89c482fd3e15cbeb8cafc077a85e8cd2428c3eba81208d13943
+  metadata.gz: 2034fc2e1d590444a857340da4cb62af2ba0866fc8f78f7f8bcca1e9b6fe52bc28b7707348890e0227a1b543d9741c127b5f5785554974b1b2c1f9b890e5d27e
+  data.tar.gz: f5a26daeff90580b1e2f6afd4b9c197ae62b76e420ff092cd15f3445eec448b3293711d9a6c2879a0a7744f981c72e374146174a364dce722782c96a097e8672

data/lib/data/typos.csv

@@ -36985,7 +36985,6 @@ duplifaces,duplicates
 duplucated,duplicated
 dupplicate,duplicate
 dupplicated,duplicated
-dur,due
 durabiblity,durabibility
 durabiity,durability
 durabiliy,durability
@@ -47028,7 +47027,6 @@ frezeang,freezing
 frezeing,freezing
 frezing,freezing
 frezzing,freezing
-fri,fry
 friand,friend
 fribease,firebase
 frictioin,friction
@@ -61982,7 +61980,6 @@ jamiacan,jamaican
 jamine,jasmine
 jammming,jamming
 jamsine,jasmine
-jan,jam
 janacek,janáček
 janaury,january
 janaček,janáček
@@ -69686,7 +69683,6 @@ mommentarily,momentarily
 mommentary,momentary
 momments,moments
 momories,memories
-mon,moon
 monacco,Monaco
 monagomous,monogamous
 monagomy,monogamy
@@ -85517,7 +85513,6 @@ prviously,previously
 pryamid,pyramid
 pryamids,pyramids
 pryor,prior
-ps,rs
 psasword,password
 psblogggers,psbloggers
 pschicology,psychology
@@ -97174,7 +97169,6 @@ seocondary,secondary
 seonc,second
 seond,second
 seonds,seconds
-sep,step
 sepaated,separated
 sepamns,specimens
 sepaphore,semaphore
@@ -107435,7 +107429,6 @@ tfunction,function
 tge,the
 tghe,the
 tghis,this
-th,the
 th9s,this
 thagy,shaggy
 thain,train
@@ -110181,7 +110174,6 @@ tuched,touched
 tucknolgies,tucknologies
 tucowws,tucows
 tudents,students
-tue,true
 tuesdsay,tuesdays
 tuesdsy,tuesdays
 tuitioin,tuition

data/lib/typo_checker/cli.rb

@@ -6,11 +6,12 @@ module TypoChecker
   class CLI < Thor
     desc 'scan REPO_PATH', 'Scan a repository for typos'
 
+    method_option :paths, type: :array, default: [], aliases: '-p', desc: 'Only scan the specified paths'
     method_option :excludes, type: :array, default: [], aliases: '-e', desc: 'Skip the directories'
     method_option :skips, type: :array, default: [], aliases: '-s', desc: 'Skip the typos'
 
     def scan(repo_path)
-      checker = TypoChecker::Checker.new(options[:excludes], options[:skips])
+      checker = TypoChecker::Checker.new(paths: options[:paths], excludes: options[:excludes], skips: options[:skips])
       checker.scan_repo(repo_path)
     end
 

data/lib/typo_checker/configuration.rb

@@ -1,11 +1,12 @@
 module TypoChecker
   class Configuration
-    attr_reader :excludes, :skips, :stdoutput
+    attr_reader :paths, :excludes, :skips, :stdoutput
 
-    def initialize(excludes = nil, skips = nil, stdoutput = true)
+    def initialize(paths: [], excludes: [], skips: [], stdoutput: true)
+      @paths = paths || []
       @excludes = excludes || []
       @skips = (skips || []).map(&:downcase)
-      @stdoutput = stdoutput.nil? ? true : stdoutput
+      @stdoutput = stdoutput.nil? || stdoutput
     end
   end
 end

data/lib/typo_checker/file_scanner.rb

@@ -63,7 +63,7 @@ module TypoChecker
       return unless @stdoutput
 
       puts "Typo found in #{colorize_light_blue(typo_path)}: " \
-            "#{colorize_red(word)} -> #{colorize_green(corrected_word)}"
+           "#{colorize_red(word)} -> #{colorize_green(corrected_word)}"
     end
 
     def colorize_red(text)

data/lib/typo_checker/repository_scanner.rb

@@ -9,20 +9,46 @@ module TypoChecker
     end
 
     def scan
-      result = {}
-      Find.find(@repo_path) do |path|
-        next if exclude_path?(path)
+      cops = {}
+      paths = @configuration.paths
 
-        @file_scanner.scan_file(path, result) if File.file?(path) && text_file?(path)
+      if paths.empty?
+        # Find all files in the repository
+        Find.find(@repo_path) do |path|
+          next if exclude_path?(path)
+
+          find_cops(cops, path)
+        end
+      else
+        paths.each do |pattern|
+          # Find files based on the pattern
+          Dir.glob(File.join(@repo_path, pattern)) do |path|
+            next if exclude_path?(path)
+
+            find_cops(cops, path)
+          end
+        end
       end
-      result.map do |path, data|
+      scan_result(cops)
+    end
+
+    private
+
+    def scan_result(cops)
+      cops.map do |path, data|
         data[:typos].map do |entry|
           { path: path, line: entry[:line], typos: entry[:typos] }
         end
       end.flatten
     end
 
-    private
+    def find_cops(cops, path)
+      @file_scanner.scan_file(path, cops) if valid_text_file?(path)
+    end
+
+    def valid_text_file?(path)
+      File.file?(path) && text_file?(path)
+    end
 
     def exclude_path?(path)
       exclude_patterns.any? { |pattern| path.match?(pattern) }

data/lib/typo_checker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TypoChecker
-  VERSION = '0.1.6'
+  VERSION = '0.1.8'
 end

data/lib/typo_checker.rb

@@ -10,8 +10,13 @@ require_relative 'typo_checker/repository_scanner'
 
 module TypoChecker
   class Checker
-    def initialize(excludes = [], skips = [], stdoutput = true)
-      @configuration = Configuration.new(excludes, skips, stdoutput)
+    def initialize(paths: [], excludes: [], skips: [], stdoutput: true)
+      raise ArgumentError, '`paths` must be an Array' unless paths.instance_of?(Array)
+      raise ArgumentError, '`excludes` must be an Array' unless excludes.instance_of?(Array)
+      raise ArgumentError, '`skips` must be an Array' unless skips.instance_of?(Array)
+      raise ArgumentError, '`stdoutput` must be a Boolean' unless [TrueClass, FalseClass].include?(stdoutput.class)
+
+      @configuration = Configuration.new(paths: paths, excludes: excludes, skips: skips, stdoutput: stdoutput)
     end
 
     def scan_repo(repo_path = Dir.pwd)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: typo_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - datpmt
 bindir: bin
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor