typocop 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b4458db4ca1e113cc0c856bf484d414bab714e7085536f12c4ac1d38570c455
-  data.tar.gz: 997fca369089b3c9a2c4413f2121e1c44964050b6e3865eb5843ee6109480204
+  metadata.gz: 072e1a38328ac541b281507e0cfdc838a39dc4b2df008118da6703a9b19c2962
+  data.tar.gz: 1a892bccf6ceaaf75c44dc7c57c78b2474ecc0e41feaca8ff77b7f1492f54fc8
 SHA512:
-  metadata.gz: 714d11cc4eed0f53512fd8012fd9fd83c7ff6ef4077b8d786e46624016a6fede7bf1e0e137370e4fc36a39d379e95fc60c9adea543d3245df3d3399218e23214
-  data.tar.gz: 56e320f4ddb437bc62faa320fa74687c4492742a1f7778f91f5f3bdffb00f00a637501b7396bf08954f9ee0cd1bda6a1c2c0189003ec41e4948ae47e5f97765f
+  metadata.gz: c8bb5c80daad6692b6fdbeb1fda23d4d73a4a7972427c76e3fbf8ec8536941245038eb340b0f95fc606cf54ed37886956019d8b2659bd621c7bafe626b16d13c
+  data.tar.gz: 9a50f63ebe484ea00b6f304803c4b74e43ed210caad0484bcddeb27a3f82dcaae080580c62e9ed2344dd1283aa3c61d8f9dc67cdaa0ffeac1d34166e7cb715b3

data/README.md

@@ -1,36 +1,98 @@
 # Check Typos in Pull Request
+[![Gem Version](https://badge.fury.io/rb/typocop.svg)](https://badge.fury.io/rb/typocop)
 
-![image](https://github.com/user-attachments/assets/bbcdcedb-cf0b-4cc0-959a-fe5caa71f833)
+![Typocop Logo](typocop.png)
 
 This GitHub Action automatically checks for typos in the files changed in a pull request. It comments on the pull request with any detected typos and provides suggestions for corrections.
 
 ## Features
 
-- Detects typos in files that are part of the pull request.
-- Provides a brief output of typos found in each file.
-- Comments on the pull request with the results.
-- Supports all programing languages.
+- Automatically detects typos in files changed in a pull request.
+- Comments on the pull request with a list of typos found and suggested corrections.
+- Approves the pull request if no typos are detected.
+- Dismisses PR approvals if a new commit contains a typo.
+- Removes outdated typo comments when new commits are made.
+- Supports all programming languages.
 
 ## Usage
 
-- Copy content `.github/workflows/typos-check.yml` and `typos-check.js` into your project.
-- Create new PR.
+1. **Using Typocop GitHub Action:**
 
-## Contributors
+    1. Copy the `.github/workflows/typocop.yml` file into your project repository.
+
+        ```yaml
+        # .github/workflows/typocop.yml
+        name: Check Typos in Pull Request
+
+        on: [pull_request]
+
+        jobs:
+          typocop:
+            permissions: write-all
+            runs-on: ubuntu-latest
+            steps:
+              - name: Checkout repository
+                uses: actions/checkout@v3
+                with:
+                  fetch-depth: 0
+
+              - name: Run Typocop Action
+                uses: datpmt/typocop@v1.0.2
+                with:
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  pull_request_id: ${{ github.event.pull_request.number }}
+                  github_base_ref: ${{ github.base_ref }}
+                  setting: .github/typocop/setting.yml # Optional: Path to your custom settings file
+        ```
+
+    2. Customize settings (optional):
+
+        By default, Typocop uses predefined settings, but you can create a custom settings file in your repository. For example, create .github/typocop/setting.yml to specify exclusion rules and skip lists.
+
+        Example `.github/typocop/setting.yml`:
+
+          ```yaml
+          excludes:  # Files and directories to exclude
+            - excludes/exclude.rb
+            - excludes/test/*
 
-- [datpmt](https://github.com/datpmt)
+          skips:  # Words or patterns to skip during typo detection
+            - rspec
+            - eligible
+          ```
 
-I welcome contributions to this project.
+        - **excludes**: Specifies files or directories to exclude from typo checking.
+        - **skips**: Specifies words or patterns to skip checking (useful for technical terms or domain-specific language).
+
+    3. Create a new Pull Request (PR) to trigger the action.
+2. **Using Typocop command line**
+
+    ```bash
+    gem install typocop # install
+
+    GITHUB_TOKEN=your_token PULL_REQUEST_ID=your_pull_request_id typocop execute # run action
+    ```
+
+    ![Typocop demo](typocop.gif "")
+
+## Contributing
+
+We welcome contributions to this project! To contribute:
+
+1. Fork the repository.
+2. Create a new feature branch (git checkout -b your-feature).
+3. Commit your changes (git commit -am 'Add some feature').
+4. Push the changes to your fork (git push origin your-feature).
+5. Open a pull request.
+
+## Contributors
 
-1.  Fork it.
-2.  Create your feature branch (`git checkout -b your-feature`).
-3.  Commit your changes (`git commit -am 'Add some feature'`).
-4.  Push to the branch (`git push origin your-feature`).
-5.  Create a new pull request.
+- Tran Dang Duc Dat ([datpmt](https://github.com/datpmt))
+- Hoang Duc Quan ([BlazingRockStorm](https://github.com/BlazingRockStorm))
 
 ## References
-1. https://github.com/crate-ci/typos
-2. https://github.com/prontolabs/pronto
+- [Typo Checker](https://github.com/datpmt/typo_checker)
+- [Pronto Labs](https://github.com/prontolabs/pronto)
 
 ## License
 The gem is available as open source under the terms of the [MIT License](LICENSE).

data/lib/typocop/cli.rb

@@ -1,11 +1,15 @@
 require 'thor'
+require_relative 'settings'
 
 module Typocop
   class CLI < Thor
     require 'typocop'
+    method_option :config, type: :string, default: '.github/typocop/setting.yml', aliases: '-c', desc: 'Load setting.'
+
     desc 'execute', 'Run typocop'
     def execute
-      Typocop.execute
+      settings = Settings.new(options[:config])
+      Typocop.execute(settings)
     end
   end
 end

data/lib/typocop/settings.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+
+module Typocop
+  class Settings
+    attr_reader :excludes, :skips
+
+    def initialize(setting_path)
+      @settings = load_settings(setting_path)
+      @excludes = @settings['excludes'] || []
+      @skips = @settings['skips'] || []
+    end
+
+    private
+
+    def load_settings(setting_path)
+      begin
+        YAML.load_file(setting_path)
+      rescue StandardError => e
+        puts "Error loading YAML file: #{e.message}"
+        return {}
+      end
+    end
+  end
+end

data/lib/typocop/version.rb

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

data/lib/typocop.rb

@@ -9,6 +9,7 @@ require 'typocop/cop'
 require 'typocop/cops'
 require 'typocop/patch'
 require 'typocop/repo'
+require 'typo_checker'
 
 GITHUB_TOKEN = ENV['GITHUB_TOKEN'] || ''
 PULL_ID = ENV['PULL_REQUEST_ID']
@@ -16,45 +17,19 @@ GITHUB_BASE_REF = ENV['GITHUB_BASE_REF'] || 'main'
 BASE_BRANCH = GITHUB_BASE_REF.start_with?('origin/') ? GITHUB_BASE_REF : "origin/#{GITHUB_BASE_REF}"
 
 module Typocop
-  def self.execute
-    typo_outputs = `typos --format brief`
-    typo_outputs = typo_outputs.split("\n")
-
-    if typo_outputs.empty?
-      puts 'No typo output.'
+  def self.execute(settings)
+    excludes = settings.excludes
+    skips = settings.skips
+    typo_checker = TypoChecker::Checker.new(excludes, skips, stdoutput = false)
+    found_typos = typo_checker.scan_repo('.')
+
+    if found_typos.empty?
+      puts 'No typos.'
     else
-      result = typo_outputs.each_with_object({}) do |output, hash|
-        path, line, _column, typo_detail = output.split(':')
-        typo_match = /`(.*?)` -> `(.*?)`/.match(typo_detail)
-        incorrect_word, correct_word = typo_match ? typo_match.captures : []
-
-        path = path.start_with?('./') ? path[2..] : path
-        line = line.to_i
-
-        hash[path] ||= {}
-
-        hash[path][:typos] ||= []
-
-        existing_entry = hash[path][:typos].find { |typo| typo[:line] == line }
-
-        if existing_entry
-          existing_entry[:typos] << { incorrect_word: incorrect_word, correct_word: correct_word }
-        else
-          hash[path][:typos] << { line: line, typos: [{ incorrect_word: incorrect_word, correct_word: correct_word }] }
-        end
-      end
-
-      result = result.map do |path, data|
-        data[:typos].map do |entry|
-          { path: path, line: entry[:line], typos: entry[:typos] }
-        end
-      end.flatten
-
-      cops = Cops.new(result)
-      cops_data = cops.cops
+      cops = Cops.new(found_typos)
       repo = Repo.new
       client = Client.new(repo)
-      client.execute(cops_data)
+      client.execute(cops.cops)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typocop
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - datpmt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-07 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -52,9 +52,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: typo_checker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Typocop integrates with GitHub Actions to automatically comment on pull
-  requests when typos are detected or when a PR is approved, based on [Crate CI's
-  Typos](https://github.com/crate-ci/typos).
+  requests when typos are detected or when a PR is approved).
 email: datpmt.2k@gmail.com
 executables:
 - typocop
@@ -73,6 +86,8 @@ files:
 - lib/typocop/cops.rb
 - lib/typocop/patch.rb
 - lib/typocop/repo.rb
+- lib/typocop/settings.rb
+- lib/typocop/version.rb
 homepage: https://rubygems.org/gems/typocop
 licenses:
 - MIT
@@ -94,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Comment on PRs with typos or approvals