danger-luacheck 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90ae664418800c7bb1dc1cd2b73c1cb11424d20629a2f471266334a2402d57a7
+  data.tar.gz: 27cca245c74baf41b9589cd8de2c415767a40b6c5127e3e6ec5aa3932ffc2342
+SHA512:
+  metadata.gz: 004f26f10456c13a4248d8f58c603139d15c48abeaa729754291e18ed4bc4fd5b6c3cb30d9b71b1f28831c642101b901eae66ab2374baf68f2a7eb195ae05c43
+  data.tar.gz: 39e9c2dadad39789add4113fcbf68c34f9258d5e2070aa1c84cd48ffe1fe4101cc411e1e03610771e99516d6de2cf2ee935cd66667034a7e9f84c17d082bc876

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+.idea/
+.yardoc

data/.rubocop.yml

@@ -0,0 +1,148 @@
+# 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:
+  TargetRubyVersion: 2.6
+
+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/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.6
+  - 2.7
+
+script:
+    - bundle exec rake spec

data/.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+    // 使用 IntelliSense 了解相关属性。 
+    // 悬停以查看现有属性的描述。
+    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Local File",
+            "type": "Ruby",
+            "request": "launch",
+            "program": "${workspaceRoot}/exe/danger-luacheck"
+        }
+    ]
+}

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://gems.ruby-china.com"
+
+# Specify your gem's dependencies in danger-luacheck.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,177 @@
+PATH
+  remote: .
+  specs:
+    danger-luacheck (0.0.1)
+      danger-plugin-api (~> 1.0)
+      nokogiri
+
+GEM
+  remote: https://gems.ruby-china.com/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    claide (1.1.0)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.6.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (>= 1, < 4)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.5.0)
+    faraday (1.10.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-http-cache (2.4.1)
+      faraday (>= 0.8)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    git (1.12.0)
+      addressable (~> 2.8)
+      rchardet (~> 1.8)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    json (2.6.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    multipart-post (2.2.3)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    nokogiri (1.13.8-x86_64-darwin)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    open4 (1.3.4)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.0)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rchardet (1.8.0)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.35.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    shellany (0.0.1)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    unicode-display_width (2.2.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  danger-luacheck!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   2.2.11

data/Guardfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2022 baocq <baocq@yuanfudao.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,20 @@
+# danger-luacheck
+
+A description of danger-luacheck.
+
+## Installation
+
+    $ gem install danger-luacheck
+
+## Usage
+
+    Methods and attributes from this plugin are available in
+    your `Dangerfile` under the `luacheck` namespace.
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.

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/danger-luacheck.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "luacheck/gem_version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "danger-luacheck"
+  spec.version       = Luacheck::VERSION
+  spec.authors       = ["baochuquan"]
+  spec.email         = ["baochuquan@163.com"]
+  spec.description   = "A short description of danger-luacheck."
+  spec.summary       = "A longer description of danger-luacheck."
+  spec.homepage      = "https://github.com/baocchuquan/danger-luacheck"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "danger-plugin-api", "~> 1.0"
+  spec.add_runtime_dependency "nokogiri"
+
+  # General ruby development
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  # Testing support
+  spec.add_development_dependency "rspec", "~> 3.4"
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "yard"
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency "listen", "3.0.7"
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency "pry"
+end

data/exe/danger-luacheck

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require File.expand_path("../../spec/spec_helper", __FILE__)
+
+dangerfile = testing_dangerfile
+plugin = dangerfile.luacheck
+
+
+allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:added_files).and_return(['app/src/main/java/com/mataku/Model.kt'])
+allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:modified_files).and_return([])
+ 
+allow_any_instance_of(Kernel).to receive(:system).with('which ktlint > /dev/null 2>&1').and_return(true)
+allow_any_instance_of(Kernel).to receive(:`).with('ktlint app/src/main/java/com/mataku/Model.kt --reporter=json --relative').and_return(dummy_ktlint_result)
+

data/lib/danger_luacheck.rb

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

data/lib/danger_plugin.rb

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

data/lib/luacheck/gem_version.rb

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

data/lib/luacheck/plugin.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require "json"
+require "nokogiri"
+
+module Danger
+  class DangerLuacheck < Plugin
+    class UnexpectedLimitTypeError < StandardError; end
+
+    class UnsupportdServiceError < StandardError
+      def initialize(message = "Unsupported service! Currently supported services are GitHub, GitLab and BitBucket server.")
+        super(message)
+      end
+    end
+
+    AVAILABLE_SERVICES = %i(github gitlab bitbucket_server)
+
+    # TODO: Lint all files if `filtering: false`
+
+    # An attribute that you can read/write from your Dangerfile
+    #
+    # @return   [Array<String>]
+    attr_accessor :skip_lint, :report_file, :report_files_pattern
+
+    def limit
+      @limit ||= nil
+    end
+
+    def limit=(limit)
+      if !limit.nil? && limit.integer?
+        @limit = limit
+      else
+        raise UnexpectedLimitTypeError
+      end
+    end
+
+    # Run luacheck task using command lint interface
+    # Will fail if `luacheck` is not installed
+    # Skip luacheck task if files changed are empty
+    # @return (void)
+    # def lint(inlint_mode: false)
+    def lint(inline_mode: false)
+      unless supported_service?
+        raise UnsupportedServiceError
+      end
+
+      targets = target_files(git.added_files + git.modified_files)
+
+      results = luacheck_results(targets)
+      if results.nil? || results.empty?
+        return
+      end
+
+      if inline_mode
+        send_inline_comments(results, targets)
+      else
+        send_markdown_comment(results, targets)
+      end
+    end
+
+    # Comment to a PR by luacheck result json
+    def send_markdown_comment(luacheck_results, targets)
+      catch(:loop_break) do
+        count = 0
+        luacheck_results.each do |luacheck_result|
+          puts luacheck_result
+          failures = luacheck_result.xpath("//failure")
+          failures.each do |failure|
+            message = failure.attributes["message"].value
+            next unless message.split(":").size >= 2
+
+            file_path = message.split(":")[0]
+            line = message.split(":")[1]
+            next unless targets.include?(file_path)
+
+            message = "#{file_html_link(file_path, line)}: #{message}"
+            fail(message)
+            next if limit.nil?
+
+            count += 1
+            if count >= limit
+              throw(:loop_break)
+            end
+          end
+        end
+      end
+    end
+
+    def send_inline_comments(luacheck_results, targets)
+      puts "============="
+      catch(:loop_break) do
+        count = 0
+        luacheck_results.each do |luacheck_result|
+          failures = luacheck_result.xpath("//failure")
+          failures.each do |failure|
+            message = failure.attributes["message"].value
+            next unless message.split(":").size >= 2
+
+            file_path = message.split(":")[0]
+            line = message.split(":")[1]
+            next unless targets.include?(file_path)
+
+            puts message
+            puts line
+            fail(message, file: file_path, line: line)
+            next if limit.nil?
+
+            count += 1
+            if count >= limit
+              throw(:loop_break)
+            end
+          end
+        end
+      end
+    end
+
+    def target_files(changed_files)
+      changed_files.select do |file|
+        file.end_with?(".lua")
+      end
+    end
+
+    # Make it a relative path so it can compare it to git.added_files
+    def relative_file_path(file_path)
+      file_path.gsub(%r{#{pwd}/}, "")
+    end
+
+    private
+
+    def file_html_link(file_path, line_number)
+      file = if danger.scm_provider == :github
+               "#{file_path}#L#{line_number}"
+             else
+               file_path
+             end
+      scm_provider_klass.html_link(file)
+    end
+
+    # `eval` may be dangerous, but it does not accept any input because it accepts only defined as danger.scm_provider
+    def scm_provider_klass
+      @scm_provider_klass ||= eval(danger.scm_provider.to_s)
+    end
+
+    def pwd
+      @pwd ||= `pwd`.chomp
+    end
+
+    def luacheck_exists?
+      system "which luacheck > /dev/null 2>&1"
+    end
+
+    def luacheck_results(targets)
+      unless luacheck_exists?
+        fail("Couldn't find luacheck command. Install first.")
+        return
+      end
+
+      return if targets.empty?
+
+      [Nokogiri::XML(`luacheck #{targets.join(" ")} --formatter JUnit`)]
+    end
+
+    def supported_service?
+      AVAILABLE_SERVICES.include?(danger.scm_provider.to_sym)
+    end
+
+    # def luacheck_result_files
+    #   if !report_file.nil? && !report_file.empty? && File.exist?(report_file)
+    #     [report_file]
+    #   elsif !report_files_pattern.nil? && !report_files_pattern.empty?
+    #     Dir.glob(report_files_pattern)
+    #   else
+    #     fail("Couldn't find luacheck result json file.\nYou must specify it with `luacheck.report_file=...` or `luacheck.report_files_pattern=...` in your Dangerfile.")
+    #   end
+    # end
+  end
+end

data/spec/fixtures/luacheck_result_1.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="Luacheck report" tests="2">
+    <testcase name="AMClick/src/AMClickResManager.lua:1" classname="AMClick/src/AMClickResManager.lua">
+        <failure type="W614" message="AMClick/src/AMClickResManager.lua:20:30: trailing whitespace in a comment"/>
+    </testcase>
+    <testcase name="AMClick/src/AMClickResManager.lua:2" classname="AMClick/src/AMClickResManager.lua">
+        <failure type="W421" message="AMClick/src/AMClickResManager.lua:75:10: shadowing definition of variable &apos;fontString&apos; on line 66"/>
+    </testcase>
+</testsuite>

data/spec/luacheck_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+module Danger
+  describe Danger::DangerLuacheck do
+    let(:dangerfile) { testing_dangerfile }
+    let(:plugin) { dangerfile.luacheck }
+
+    it "should be a plugin" do
+      expect(Danger::DangerLuacheck.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe "#lint" do
+      before do
+        allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:added_files).and_return(["AMClick/src/AMClickResManager.lua"])
+        allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:modified_files).and_return([])
+      end
+
+      context "luacheck issues were found" do
+        before do
+          allow_any_instance_of(Kernel).to receive(:system).with("which luacheck > /dev/null 2>&1").and_return(true)
+          allow_any_instance_of(Kernel).to receive(:`).with("luacheck AMClick/src/AMClickResManager.lua --formatter JUnit").and_return(dummy_luacheck_result_1)
+          allow_any_instance_of(Danger::DangerfileGitHubPlugin).to receive(:html_link).with("AMClick/src/AMClickResManager.lua#L20").and_return("<a href='https://github.com/baochuquan/android/blob/561827e46167077b5e53515b4b7349b8ae04610b/AMClickResManager.lua'>AMClickResManager.lua</a>")
+          allow_any_instance_of(Danger::DangerfileGitHubPlugin).to receive(:html_link).with("AMClick/src/AMClickResManager.lua#L75").and_return("<a href='https://github.com/baochuquan/android/blob/561827e46167077b5e53515b4b7349b8ae04610b/AMClickResManager.lua'>AMClickResManager.lua</a>")
+        end
+
+        it "send markdown comment" do
+          plugin.lint
+          expect(dangerfile.status_report[:errors].size).to eq(2)
+        end
+      end
+
+      context "luacheck issues were found with inline_mode: true" do
+        before do
+          allow_any_instance_of(Kernel).to receive(:system).with("which luacheck > /dev/null 2>&1").and_return(true)
+          allow_any_instance_of(Kernel).to receive(:`).with("luacheck AMClick/src/AMClickResManager.lua --formatter JUnit").and_return(dummy_luacheck_result_1)
+        end
+
+        it "Sends inline comment" do
+          plugin.lint(inline_mode: true)
+          expect(dangerfile.status_report[:errors].size).to eq(2)
+        end
+      end
+    end
+
+    describe "#send_markdown_comment" do
+      let(:limit) { 1 }
+
+      before do
+        allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:added_files).and_return(["AMClick/src/AMClickResManager.lua"])
+        allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:modified_files).and_return([])
+
+        allow_any_instance_of(Kernel).to receive(:system).with("which luacheck > /dev/null 2>&1").and_return(true)
+        allow_any_instance_of(Kernel).to receive(:`).with("luacheck AMClick/src/AMClickResManager.lua --formatter JUnit").and_return(dummy_luacheck_result_1)
+        plugin.limit = limit
+      end
+
+      context "limit is set" do
+        it "equals number of luacheck results to limit" do
+          plugin.lint(inline_mode: true)
+          expect(dangerfile.status_report[:errors].size).to eq(limit)
+        end
+      end
+    end
+    #
+    # You should test your custom attributes and methods here
+    #
+    # describe "with Dangerfile" do
+    #   before do
+    #     @dangerfile = testing_dangerfile
+    #     @my_plugin = @dangerfile.luacheck
+
+    #     # mock the PR data
+    #     # you can then use this, eg. github.pr_author, later in the spec
+    #     json = File.read("#{File.dirname(__FILE__)}/support/fixtures/github_pr.json") # example json: `curl https://api.github.com/repos/danger/danger-plugin-template/pulls/18 > github_pr.json`
+    #     allow(@my_plugin.github).to receive(:pr_json).and_return(json)
+    #   end
+
+    #   # Some examples for writing tests
+    #   # You should replace these with your own.
+
+    #   it "Warns on a monday" do
+    #     monday_date = Date.parse("2016-07-11")
+    #     allow(Date).to receive(:today).and_return monday_date
+
+    #     @my_plugin.warn_on_mondays
+
+    #     expect(@dangerfile.status_report[:warnings]).to eq(["Trying to merge code on a Monday"])
+    #   end
+
+    #   it "Does nothing on a tuesday" do
+    #     monday_date = Date.parse("2016-07-12")
+    #     allow(Date).to receive(:today).and_return monday_date
+
+    #     @my_plugin.warn_on_mondays
+
+    #     expect(@dangerfile.status_report[:warnings]).to eq([])
+    #   end
+    # end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,80 @@
+require "pathname"
+ROOT = Pathname.new(File.expand_path("..", __dir__))
+$:.unshift((ROOT + "lib").to_s)
+$:.unshift((ROOT + "spec").to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ""
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+def testing_env
+  {
+    "BITRISE_PULL_REQUEST" => "4",
+    "BITRISE_IO" => "true",
+    "GIT_REPOSITORY_URL" => "git@github.com:artsy/eigen",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+def testing_env_for_gitlab
+  {
+    "BITRISE_PULL_REQUEST" => "4",
+    "BITRISE_IO" => "true",
+    "GIT_REPOSITORY_URL" => "git@gitlab.com:artsy/eigen",
+    "DANGER_GITLAB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end
+
+def testing_dangerfile_for_gitlab
+  env = Danger::EnvironmentManager.new(testing_env_for_gitlab)
+  Danger::Dangerfile.new(env, testing_ui)
+end
+
+def dummy_luacheck_result_1
+  File.read(File.expand_path("fixtures/luacheck_result_1.xml", __dir__)).chomp
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: danger-luacheck
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- baochuquan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-31 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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A short description of danger-luacheck.
+email:
+- baochuquan@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".vscode/launch.json"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-luacheck.gemspec
+- exe/danger-luacheck
+- lib/danger_luacheck.rb
+- lib/danger_plugin.rb
+- lib/luacheck/gem_version.rb
+- lib/luacheck/plugin.rb
+- spec/fixtures/luacheck_result_1.xml
+- spec/luacheck_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/baocchuquan/danger-luacheck
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: A longer description of danger-luacheck.
+test_files:
+- spec/fixtures/luacheck_result_1.xml
+- spec/luacheck_spec.rb
+- spec/spec_helper.rb