typocop 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d88a12de1edbbc3c7e70471186903cf382f7af793a6ed3991c04ced1cc8783de
-  data.tar.gz: 92bae8b974bab5d365f4008681b31d44d0bb8b211ecbd74686f137504ed39eae
+  metadata.gz: 1aaf7cd87d8502a318500c3bd9e73c3652978f036e69b0f71de9f245e17a7f36
+  data.tar.gz: ae84fed93fcf1738ebc6839a3023999ac1c5837117c63fe25757a1fb76be3c0e
 SHA512:
-  metadata.gz: 3368d345b72253182408536ff51bafd36cee782f0eb68a9167a2bba243b44f01dabc28e909769c19439cd28364be4c282d85dbfa8e4f1880e71adf7faa1561e6
-  data.tar.gz: a015986b15647fbf61e72145a00e0204d3a6cb168b4aed8f5392e3c14b4c6506e4bf68e9669d521977056e11404c2ba78966d3d16931f3df9669a138df3e5111
+  metadata.gz: 663d71d39def54045124696e5644733cff5a00e1a73bd75ee3fe7eb3ee949d4d65fb3be35d482a6b5b4a6338f41882a94855b722738257430de36fb114de2dfb
+  data.tar.gz: 253b33ddd23ba64fbf41e1f600318d24076b4f27be1180d1399eac5c3b7152c5cd32707eed31005e4122dec46bda6c75a1c2eccf7e8009a43c8b69fd0b6a0c40

data/README.md

@@ -16,6 +16,11 @@ This GitHub Action automatically checks for typos in the files changed in a pull
 
 ## Usage
 
+> [!NOTE]
+> If you want GitHub Actions to approve PRs, you must grant permission to it at: project settings -> Actions -> General -> Allow GitHub Actions to create and approve pull requests.
+
+![Typocop Logo](typocop-approval.png)
+
 1. **Using Typocop GitHub Action:**
 
     1. Copy the `.github/workflows/typocop.yml` file into your project repository.
@@ -70,7 +75,7 @@ This GitHub Action automatically checks for typos in the files changed in a pull
     ```bash
     gem install typocop # install
 
-    GITHUB_TOKEN=your_token PULL_REQUEST_ID=your_pull_request_id typocop execute # run action
+    GITHUB_TOKEN=your_token PULL_REQUEST_ID=the_request_id GITHUB_BASE_REF=branch_base_name typocop execute # run action
     ```
 
     ![Typocop demo](typocop.gif "")

data/lib/typocop/client.rb

@@ -99,7 +99,7 @@ module Typocop
     end
 
     def line_content(cop)
-      patch = @repo.patch_additions.find { |patch| patch.path == cop.path }
+      patch = @repo.patch_additions.find { |p| p.path == cop.path }
       patch.added_lines.find { |line| line.new_lineno == cop.line }.content
     end
 

data/lib/typocop/settings.rb

@@ -13,12 +13,10 @@ module Typocop
     private
 
     def load_settings(setting_path)
-      begin
-        YAML.load_file(setting_path)
-      rescue StandardError => e
-        puts "Error loading YAML file: #{e.message}"
-        return {}
-      end
+      YAML.load_file(setting_path)
+    rescue StandardError => e
+      puts "Error loading YAML file: #{e.message}"
+      {}
     end
   end
 end

data/lib/typocop/version.rb

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

data/lib/typocop.rb

@@ -11,25 +11,27 @@ require 'typocop/patch'
 require 'typocop/repo'
 require 'typo_checker'
 
-GITHUB_TOKEN = ENV['GITHUB_TOKEN'] || ''
-PULL_ID = ENV['PULL_REQUEST_ID']
-GITHUB_BASE_REF = ENV['GITHUB_BASE_REF'] || 'main'
+GITHUB_TOKEN = ENV.fetch('GITHUB_TOKEN') { raise 'GITHUB_TOKEN is required' }
+PULL_ID = ENV.fetch('PULL_REQUEST_ID') { raise 'PULL_REQUEST_ID is required' }
+GITHUB_BASE_REF = ENV.fetch('GITHUB_BASE_REF') { raise 'GITHUB_BASE_REF is required' }
 BASE_BRANCH = GITHUB_BASE_REF.start_with?('origin/') ? GITHUB_BASE_REF : "origin/#{GITHUB_BASE_REF}"
 
 module Typocop
   def self.execute(settings)
+    repo = Repo.new
+    paths = repo.patch_additions.map(&:path)
+
+    return unless paths.any?
+
     excludes = settings.excludes
     skips = settings.skips
-    typo_checker = TypoChecker::Checker.new(excludes, skips, stdoutput = false)
+    typo_checker = TypoChecker::Checker.new(paths: paths, excludes: excludes, skips: skips, stdoutput: false)
     found_typos = typo_checker.scan_repo('.')
 
-    if found_typos.empty?
-      puts 'No typos.'
-    else
-      cops = Cops.new(found_typos)
-      repo = Repo.new
-      client = Client.new(repo)
-      client.execute(cops.cops)
-    end
+    puts 'No typos found' if found_typos.empty?
+
+    cops = Cops.new(found_typos)
+    client = Client.new(repo)
+    client.execute(cops.cops)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typocop
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - datpmt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-22 00:00:00.000000000 Z
+date: 2025-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -56,16 +56,16 @@ dependencies:
   name: typo_checker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '0'
 description: Typocop integrates with GitHub Actions to automatically comment on pull
   requests when typos are detected or when a PR is approved).
 email: datpmt.2k@gmail.com
@@ -109,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