typocop 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 072e1a38328ac541b281507e0cfdc838a39dc4b2df008118da6703a9b19c2962
-  data.tar.gz: 1a892bccf6ceaaf75c44dc7c57c78b2474ecc0e41feaca8ff77b7f1492f54fc8
+  metadata.gz: 1aaf7cd87d8502a318500c3bd9e73c3652978f036e69b0f71de9f245e17a7f36
+  data.tar.gz: ae84fed93fcf1738ebc6839a3023999ac1c5837117c63fe25757a1fb76be3c0e
 SHA512:
-  metadata.gz: c8bb5c80daad6692b6fdbeb1fda23d4d73a4a7972427c76e3fbf8ec8536941245038eb340b0f95fc606cf54ed37886956019d8b2659bd621c7bafe626b16d13c
-  data.tar.gz: 9a50f63ebe484ea00b6f304803c4b74e43ed210caad0484bcddeb27a3f82dcaae080580c62e9ed2344dd1283aa3c61d8f9dc67cdaa0ffeac1d34166e7cb715b3
+  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.
@@ -37,7 +42,7 @@ This GitHub Action automatically checks for typos in the files changed in a pull
                   fetch-depth: 0
 
               - name: Run Typocop Action
-                uses: datpmt/typocop@v1.0.2
+                uses: datpmt/typocop@main
                 with:
                   github_token: ${{ secrets.GITHUB_TOKEN }}
                   pull_request_id: ${{ github.event.pull_request.number }}
@@ -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
 
@@ -165,7 +165,8 @@ module Typocop
       @client.create_pull_request_review(
         @repo_name,
         PULL_ID,
-        event: 'APPROVE'
+        event: 'APPROVE',
+        body: 'Checked for typos — Everything looks great! :star: :tada: :sparkles:'
       )
     rescue Octokit::UnprocessableEntity => e
       puts e

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.2'
+  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.2
+  version: 0.1.4
 platform: ruby
 authors:
 - datpmt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-31 00:00:00.000000000 Z
+date: 2025-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit