typo_checker 0.1.0

data/lib/typo_checker/cli.rb

@@ -0,0 +1,14 @@
+# lib/typo_checker/cli.rb
+require 'thor'
+require 'typo_checker'
+
+module TypoChecker
+  class CLI < Thor
+    desc 'scan REPO_PATH', 'Scan a repository for typos'
+
+    def scan(repo_path)
+      checker = TypoChecker::Checker.new
+      checker.scan_repo(repo_path)
+    end
+  end
+end

data/lib/typo_checker/version.rb

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

data/lib/typo_checker.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'find'
+require 'fileutils'
+
+module TypoChecker
+  class Checker
+    attr_reader :typos
+
+    def initialize
+      csv_file = File.expand_path('data/typos.csv', __dir__)
+      @typos = load_typos(csv_file)
+    end
+
+    def scan_repo(repo_path = Dir.pwd)
+      Find.find(repo_path) do |path|
+        scan_file(path) if File.file?(path) && text_file?(path)
+      end
+    end
+
+    private
+
+    def load_typos(csv_file)
+      typos = {}
+      CSV.foreach(csv_file, headers: false) do |row|
+        typos[row[0]] = row[1]
+      end
+      typos
+    end
+
+    def text_file?(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
+        .ada .ml .lisp .prolog .tcl .rexx .awk .sed .coffee .groovy .dart .haxe .zig .nim .crystal .reason .ocaml
+        .forth .v .xhtml .julia .racket .scheme .rust .graphql
+      ].include? File.extname(path)
+    end
+
+    def scan_file(path)
+      File.foreach(path).with_index do |line, line_number|
+        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)
+        end
+      end
+    end
+
+    def check_word(word, file, line_num, char_index)
+      return unless typos.key?(word.downcase)
+
+      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)}"
+    end
+
+    def split_function_name(name)
+      name.gsub(/([a-z])([A-Z])/, '\1 \2').split(/[\s_]+/)
+    end
+
+    def corrected_word(word, typo_correct_word)
+      if word == word.capitalize
+        typo_correct_word.capitalize
+      elsif word == word.upcase
+        typo_correct_word.upcase
+      else
+        typo_correct_word
+      end
+    end
+
+    def colorize_red(text)
+      "\e[31m#{text}\e[0m"
+    end
+
+    def colorize_green(text)
+      "\e[32m#{text}\e[0m"
+    end
+
+    def colorize_light_blue(text)
+      "\e[94m#{text}\e[0m"
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: typo_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- datpmt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+description: 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.
+email: datpmt.2k@gmail.com
+executables:
+- typo_checker
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/typo_checker
+- lib/data/typos.csv
+- lib/typo_checker.rb
+- lib/typo_checker/cli.rb
+- lib/typo_checker/version.rb
+homepage: https://rubygems.org/gems/typo_checker
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/datpmt/typo_checker
+  changelog_uri: https://github.com/datpmt/typo_checker/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: TypoChecker is a tool for scanning source code files for common typographical
+  errors.
+test_files: []