typo_checker 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c08c05d34a0569f214adc5a2f01416f2ce6302aadca2dabd597bc3581ff5d8b1
-  data.tar.gz: d54006052dfbc69df8998d0c5012935c42fe14240643a058eaa0584fae829db9
+  metadata.gz: 9140408fbb85977164d301d8023bc484601d97b0b70038fb7b1a9b8163e6ddad
+  data.tar.gz: c9ac12e67b562106c2a90a30605b7c226f5d17eef2937da3461a78d07e850062
 SHA512:
-  metadata.gz: 7dd706b82d00f6f3c40bc8bc9c5ae42b04f2dc8c01b7a33732207008c39aa97a481430bb1cf76ec519cdca86e8da312eef5d278496be5a462f5b935010533050
-  data.tar.gz: bb49fd0e16e06c9fb08a396d39f4ee80ae1ba64124e336f1e2da3f957de69c8ff4ce2ccd10ec902cf590f88fdd4d2af9df7b6a5c1acd2d9963bae696131f96ee
+  metadata.gz: 0734fd66b0d6090c6197b95395d6a8ec4df494a850c5ae559a06aa591bdfbf2116a328266c981639f054c53a86e78decd0d57b02b9d5869163c39a73b0c4483a
+  data.tar.gz: 9dc0cc04ac8f7e3e9fad54a6e7c9c16733049bc77341d8b9f6ea750f673c682f7bb2a5954414b9b08b65ed45ac6e6d8072861a5ae948e697ff95687d7fcea63e

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
@@ -62567,7 +62566,6 @@ keywork,keyword
 keyworks,keywords
 keyworn,keyword
 keywrod,keyword
-kh,kc
 khachindorbatly,khachindorbately
 khaligrpah,khaligraph
 khornofuly,khornofully
@@ -85514,7 +85512,6 @@ prviously,previously
 pryamid,pyramid
 pryamids,pyramids
 pryor,prior
-ps,rs
 psasword,password
 psblogggers,psbloggers
 pschicology,psychology
@@ -86459,7 +86456,6 @@ qrite,write
 qroperly,properly
 qsueries,queries
 qtuie,quite
-qu,quo
 quacamole,guacamole
 quadran,quadrant
 quadrapole,quadrupole
@@ -107431,7 +107427,6 @@ tfunction,function
 tge,the
 tghe,the
 tghis,this
-th,the
 th9s,this
 thagy,shaggy
 thain,train

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.7'
+  VERSION = '0.1.9'
 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.7
+  version: 0.1.9
 platform: ruby
 authors:
 - datpmt
 bindir: bin
 cert_chain: []
-date: 2025-01-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: TypoChecker is a tool for scanning source code files for common typographical
   errors.