typo_checker 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a70148af1265992e4ad1912242058765ec6b16079e7ec928b97ea9eef03b7c1e
-  data.tar.gz: 4577201281037b384f51b07ad7b20506ea1a2aa7e486e57cf06823448dff99f5
+  metadata.gz: 993172dbd5d6abda8122d79b5b704a3d33c62b070ec992a32a65b88796ee9a89
+  data.tar.gz: fdbf5d4104cdb99b7bd7889cb83173270db123cd171bde3702c0e8687633728b
 SHA512:
-  metadata.gz: 9b71c09497ee8dd367e99dc63e69faa599b9c9c61579d108544e066b5a6839e7fd967989d588bfeef3983c38a7c4786ef50595bf306f4cea168f1e7aba301832
-  data.tar.gz: 86f01baf7fe9e3147503f1ebbec821d9b25c78c79a3469d7288400bf95d374e97e8217d545a1a058d114aee3757c946c40ba65e6676740b1624086ba9d8b3a00
+  metadata.gz: 664b9a9f3f6123378eaa6560ee3e56753ce4deeea6dd893c45fce5585682d81c8cedf762477dce90af2154da1d6b2b4e2d5a1da91ad6f25e6b3936fb2f5e01f9
+  data.tar.gz: 85b93f37c3b1f1da7bbae9e371a872218b5bddc957c8598a13c9bd5bf23767cafbb9dc6434bb6c3cb22797a4eb135a712326e77d4642d64c7bb255151e6f503b

data/README.md

@@ -2,11 +2,16 @@
 
 TypoChecker is a tool for scanning source code files for common typographical errors. The tool checks through text-based files in a given repository to identify and suggest corrections for any matches found.
 
+<p align="center" width="100%">
+    <img src="typo_checker.png" alt="TypoChecker Image">
+</p>
+
 ## Features
 
 - **Automatic typo detection**: Scan through files in a repository for known typos.
 - **Support for multiple file types**: It checks various source code and text file extensions.
 - **Colorized output**: Provides color-coded feedback for easier identification of typos.
+- **Customization**: Allows you to exclude certain files or skip specific typos.
 
 ## Installation
 
@@ -25,6 +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 # 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
@@ -37,7 +44,7 @@ When a typo is found, the tool prints out the following information in a coloriz
 Example output:
 
 ```bash
-Typo found in /path/to/file.rb:10:15: myFuncton() -> myFunction()
+Typo found in /path/to/file.rb:10:15: myFuncton -> myFunction
 ```
 
 ## File Types Supported

data/lib/typo_checker/cli.rb

@@ -6,9 +6,16 @@ module TypoChecker
   class CLI < Thor
     desc 'scan REPO_PATH', 'Scan a repository for typos'
 
+    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
+      checker = TypoChecker::Checker.new(options[:excludes], options[:skips])
       checker.scan_repo(repo_path)
     end
+
+    def self.exit_on_failure?
+      true
+    end
   end
 end

data/lib/typo_checker/version.rb

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

data/lib/typo_checker.rb

@@ -6,30 +6,56 @@ require 'fileutils'
 
 module TypoChecker
   class Checker
-    attr_reader :typos
+    attr_reader :typos, :excludes, :skips, :found_typos, :stdoutput
 
-    def initialize
-      csv_file = File.expand_path('data/typos.csv', __dir__)
-      @typos = load_typos(csv_file)
+    def initialize(excludes = [], skips = [], stdoutput = true)
+      @excludes = excludes
+      @skips = skips.map(&:downcase)
+      @typos = load_typos
+      @found_typos = []
+      @stdoutput = stdoutput
     end
 
     def scan_repo(repo_path = Dir.pwd)
       Find.find(repo_path) do |path|
+        next if exclude_path?(path)
+
         scan_file(path) if File.file?(path) && text_file?(path)
       end
+
+      @found_typos
     end
 
     private
 
-    def load_typos(csv_file)
+    def exclude_path?(path)
+      exclude_patterns.any? { |pattern| path.match?(pattern) }
+    end
+
+    def exclude_patterns
+      @exclude_patterns ||= excludes + [
+        %r{\.git/.*},        # Skip all files and directories inside .git
+        %r{node_modules/.*}, # Skip all files and directories inside node_modules
+        %r{vendor/.*},       # Skip all files and directories inside vendor
+        %r{tmp/.*}           # Skip all files and directories inside tmp
+      ]
+    end
+
+    def load_typos
       typos = {}
+      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
     end
 
     def text_file?(path)
+      excluded_extensions = %w[.log]
+
+      return false if excluded_extensions.include?(File.extname(path))
+
       %w[
         .rb .txt .md .html .css .js .py .java .php .go .swift .ts .scala .c .cpp .csharp .h .lua .pl .rs .kt
         .d .r .m .sh .bash .bat .json .yaml .xml .scss .tsv .vb .ps1 .clj .elixir .f# .vhdl .verilog
@@ -54,8 +80,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)
@@ -72,6 +108,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.0
+  version: 0.1.2
 platform: ruby
 authors:
 - datpmt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-27 00:00:00.000000000 Z
+date: 2024-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor