danger-typos 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ca58a8024d01464f7d5f9b3849b6fc4ee9917864415af35b4c3e46df7eed4c4
+  data.tar.gz: 2e651317a64d71f85634a1dcab2b9ad31e447d9ddc335694cdb3c529715fc028
+SHA512:
+  metadata.gz: 3b27895cc1ad3b248bc8594374f5832c244368daa950f350dc8e36f68ca5be2940116b263340892599083ac22ac448a4ad16573e5b573c42035cbfc2b311ceee
+  data.tar.gz: b4c12aacdde430d2d523f807dfb9f49bc36f5c79fb9aa21bf0937b9d3363a075a285fc86655e4c7cc2801932c0cb30b17ec2d3ac038e58dc2b98442e7bbe1c3a

data/.rubocop.yml

@@ -0,0 +1,149 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+# If you don't like these settings, just delete this file :)
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Layout/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# FIXME: 25
+Metrics/BlockLength:
+  Max: 345
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/MixinGrouping:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%":  ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+Security/YAMLLoad:
+  Enabled: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2025 Kyosuke Takayama <loiseau@gmail.com>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# danger-typos
+
+[Danger](http://danger.systems/ruby/) plugin for [typos](https://github.com/crate-ci/typos).
+
+## Installation
+
+    $ gem install danger-typos
+
+`typos` also needs to be installed before you run Danger.
+
+## Usage
+
+Add this to Dangerfile.
+
+```
+typos.run
+```
+
+If you want to specify typos bin file, you can set a bin path to the binary_path parameter.
+
+```
+typos.binary_path = "path/to/typos"
+typos.run
+```
+
+
+### GitHub actions
+
+```yaml
+name: Danger
+
+on: [pull_request]
+
+jobs:
+  danger:
+    runs-on: ubuntu-latest
+    if: github.event_name  == 'pull_request'
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+        bundler-cache: true
+
+    - name: Install typos
+      uses: baptiste0928/cargo-install@v3
+      with:
+        crate: typos-cli
+        version: 1.29.7
+
+    - run: bundle exec danger
+      env:
+        DANGER_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+
+### GitHub actions 
+
+directly install typos from binary
+
+```yaml
+name: Danger
+
+on: [pull_request]
+
+jobs:
+  danger:
+    runs-on: ubuntu-latest
+    if: github.event_name  == 'pull_request'
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+        bundler-cache: true
+
+    - name: Install typos
+      run: |
+        wget https://github.com/crate-ci/typos/releases/download/v1.29.7/typos-v1.29.7-x86_64-unknown-linux-musl.tar.gz
+        tar xf typos-v1.29.7-x86_64-unknown-linux-musl.tar.gz
+        mkdir -p $HOME/.cargo/bin
+        mv typos $HOME/.cargo/bin/
+        echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+        typos --version
+
+    - run: bundle exec danger
+      env:
+        DANGER_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task["specs"].invoke
+  Rake::Task["rubocop"].invoke
+  Rake::Task["spec_docs"].invoke
+end
+
+desc "Run RuboCop on the lib/specs directory"
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ["lib/**/*.rb", "spec/**/*.rb"]
+end
+
+desc "Ensure that the plugin passes `danger plugins lint`"
+task :spec_docs do
+  sh "bundle exec danger plugins lint"
+end

data/lib/danger_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "typos/plugin"

data/lib/danger_typos.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "typos/gem_version"

data/lib/typos/gem_version.rb

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

data/lib/typos/plugin.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "json"
+require "open3"
+
+module Danger
+  # [Danger](http://danger.systems/ruby/) plugin for [typos](https://github.com/crate-ci/typos).
+  #
+  # @example Run typos and send warn comment.
+  #
+  #          typos.binary_path = "path/to/typos"
+  #          typos.run
+  #
+  # @see  ktakayama/danger-typos
+  # @tags typos
+  #
+  class DangerTypos < Plugin
+    # typos path
+    # @return [String]
+    attr_accessor :binary_path
+
+    # Execute typos
+    # @return [void]
+    def run
+      return if target_files.empty?
+
+      args = ["--force-exclude", "--format", "json"] + target_files
+      stdout, = Open3.capture3(cmd_path, *args)
+
+      stdout.split("\n").each do |result|
+        data = JSON.parse(result)
+        next if data["type"] != "typo"
+
+        warn(
+          "`#{data['typo']}` should be `#{data['corrections'].first}`",
+          file: data["path"],
+          line: data["line_num"]
+        )
+      end
+    end
+
+    private
+
+    def cmd_path
+      return binary_path if binary_path
+
+      cmd = File.expand_path("~/.cargo/bin/typos")
+      File.exist?(cmd) ? cmd : "typos"
+    end
+
+    def target_files
+      ((git.added_files + (git.modified_files - git.deleted_files)) - git.renamed_files.map { |r| r[:before] } + git.renamed_files.map { |r| r[:after] }).uniq
+    end
+  end
+end

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ]
+}

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: danger-typos
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyosuke Takayama
+bindir: exe
+cert_chain: []
+date: 2025-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Danger plugin for typos.
+email:
+- loiseau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/danger_plugin.rb
+- lib/danger_typos.rb
+- lib/typos/gem_version.rb
+- lib/typos/plugin.rb
+- renovate.json
+homepage: https://github.com/ktakayama/danger-typos
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ktakayama/danger-typos
+  source_code_uri: https://github.com/ktakayama/danger-typos
+  changelog_uri: https://github.com/ktakayama/danger-typos
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Danger plugin for typos.
+test_files: []