typo_checker 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e1e06748572f803e8d7e9a46765461b1c5780abc659f9a45287df63abf1f5ae
-  data.tar.gz: d5d762a890491d39e1fef339ce6276cb3b7ede343b278a9e0d29d27aed0ebc59
+  metadata.gz: 227145be6c56d2f94d403f2acbd64570413f24d4c5eac9e8aad209a8efbf14d7
+  data.tar.gz: f127ac80d6fa9689ffe2b838284bbeb216c2fe0932f17ba7ce06cee26436899e
 SHA512:
-  metadata.gz: b96b4c818d693060ef49262b6e8c2eb4177a5be9ae10aae6f6718b3458103dbf1156ae69d0d569de19053e576a3e9462e2d39f55ad246b11a1110e563b39c038
-  data.tar.gz: b36d80f8c86efe02e3ce38951fdb45e7a17db8c137f056e9baa79733d516506bcb39f601ac30d11251353729a386ea4b61c4174bf05d9ea313de4886f4520a66
+  metadata.gz: dde8d82fbc3010b8682589a49608fced1e035857a58d2836027a3237d17ad002ef990f013a0fb9b0e9e115f7e16fc8d03415df50286b6ef9abb9befd7921194e
+  data.tar.gz: 5399e74841b109d8b450593f7e061a7ac7a6f96556f7434ddef6a4dc770ade934e97e1623b88baad1394869da0265d6ad7a8a01f27b8a9dcea492b17d901cbb9

data/README.md

@@ -30,7 +30,8 @@ Once installed, you can use TypoChecker in your Ruby project to scan a directory
 ```bash
 # typo_checker scan /path/repo
 typo_checker scan . # current repo
-typo_checker scan . excludes node_modules .git
+typo_checker scan . --excludes node_modules .git # or typo_checker scan . -e node_modules .git
+typo_checker scan . --excludes node_modules .git --skips rspec defs # or typo_checker scan . -e node_modules .git -s rspec defs
 ```
 
 ### Output

data/lib/data/typos.csv

@@ -62986,6 +62986,7 @@ laghtest,latest
 lagre,large
 lagth,laugh
 laguage,language
+languege,language
 laguages,languages
 lagunage,language
 laiblity,laibility

data/lib/typo_checker/version.rb

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

data/lib/typo_checker.rb

@@ -6,12 +6,14 @@ require 'fileutils'
 
 module TypoChecker
   class Checker
-    attr_reader :typos, :excludes, :skips
+    attr_reader :typos, :excludes, :skips, :found_typos, :stdoutput
 
-    def initialize(excludes = [], skips = [])
+    def initialize(excludes = [], skips = [], stdoutput = true)
       @excludes = excludes
-      @skips = skips
+      @skips = skips.map(&:downcase)
       @typos = load_typos
+      @found_typos = []
+      @stdoutput = stdoutput
     end
 
     def scan_repo(repo_path = Dir.pwd)
@@ -20,6 +22,8 @@ module TypoChecker
 
         scan_file(path) if File.file?(path) && text_file?(path)
       end
+
+      @found_typos
     end
 
     private
@@ -42,6 +46,7 @@ module TypoChecker
       csv_file = File.expand_path('data/typos.csv', __dir__)
       CSV.foreach(csv_file, headers: false) do |row|
         next if skips.include?(row[0])
+
         typos[row[0]] = row[1]
       end
       typos
@@ -65,8 +70,9 @@ module TypoChecker
         words = line.split(/[^a-zA-Z0-9']+/)
         check_words = words.map { |word| split_function_name(word) }.flatten
         check_words.each do |word|
-          char_index = line.index(word)
-          check_word(word, path, line_number, char_index)
+          clean_word = word.gsub(/^[^\w]+|[^\w]+$/, '')
+          char_index = line.index(clean_word)
+          check_word(clean_word, path, line_number, char_index)
         end
       end
     end
@@ -76,8 +82,18 @@ module TypoChecker
 
       corrected_word = corrected_word(word, typos[word.downcase])
       typo_path = "#{file}:#{line_num + 1}:#{char_index + 1}"
-      puts "Typo found in #{colorize_light_blue(typo_path)}: " \
-            "#{colorize_red(word)} -> #{colorize_green(corrected_word)}"
+      typo_details = {
+        path: file,
+        line: line_num + 1,
+        typos: {
+          incorrect_word: word,
+          correct_word: corrected_word
+        }
+      }
+
+      @found_typos << typo_details
+
+      stdout(typo_path, word, corrected_word) if stdoutput
     end
 
     def split_function_name(name)
@@ -94,6 +110,11 @@ module TypoChecker
       end
     end
 
+    def stdout(typo_path, word, corrected_word)
+      puts "Typo found in #{colorize_light_blue(typo_path)}: " \
+            "#{colorize_red(word)} -> #{colorize_green(corrected_word)}"
+    end
+
     def colorize_red(text)
       "\e[31m#{text}\e[0m"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typo_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - datpmt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-30 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor