danger-ktlint 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60e18440651f2b42cb1d710fa157ee9391aa80894dd1e31bf2b43a7198cb80e3
-  data.tar.gz: b507278d2b29a2361afe704699c17c12373adb2ad82d91e7b44e44aec35dc77e
+  metadata.gz: b1f250c93c48f9c5b8a9eb7aee96760b0f7ca668be636aeaeddfac263f87a242
+  data.tar.gz: d40bed8d74888a9555fd5bb4e7619281ff38422ecc35064d4fa59f0a39e0e20e
 SHA512:
-  metadata.gz: cd061ab55bbc11530c44686f8d1d872363428624fa63065e8e2631d8f703da7d853f1abb7692bd1e8dcf65e2bb38831cd70de2d4da45c05ba2385c8a9148668d
-  data.tar.gz: 8e28ec29136da819926e73dc6e5263fb9150455caf15cffb29b6ea98cf888bd742ad660ac4466a6a96ca62cf4da0738d4981dd9d79ee4eb48c5331a0ffa76c88
+  metadata.gz: 5e819fdad3eb22599362768654c65e1657652b653d6a6268791f63aa26c03feed6fc3dab9c4dd061883d3094ecb4cbf9b704fb603122fbbe1f1cc26477b88e99
+  data.tar.gz: 817b35c9e78fce50d690c3c56b605d5bfa3e609a7b32785516001eb407e286934d6126a236c736912f153a8c04479da3945ff9b5c07135acf339545c8ccfded6

data/.github/workflows/test.yml

@@ -0,0 +1,19 @@
+name: test
+
+on: [push]
+
+jobs:
+  test:
+    name: Run spec
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+        bundler-cache: true
+    - name: Run spec
+      run: |
+        bundle exec rspec spec
+

data/CHANGELOG.md

@@ -1,11 +1,16 @@
-## 0.3.0
+## 0.0.4
+
+### Added
+- ktlint task can be skipped by specifing `ktlint.skip_task = true` and `ktlint.report_file = '...'`
+
+## 0.0.3
 ### Added
 - `limit` parameter to set the maximum number of comments of ktlint results.
 
-## 0.2.0
+## 0.0.2
 ### Added
 - Inline comment feature (`inline_mode: true` with ktlint.lint)
 
-## 0.1.0
+## 0.0.1
 ### Added
 - Run ktlint by ktlint.lint

data/README.md

@@ -5,7 +5,7 @@ Lint kotlin files only changed files in a pull request using ktlint command lint
 ## Installation
 
 ```ruby
-$ gem install danger-ktlint
+gem install danger-ktlint
 ```
 
 ## Usage
@@ -14,7 +14,7 @@ You need to install `ktlint` command and set as executable first, see: https://k
 
 ```bash
 # Example
-$ curl --output /usr/local/bin/ktlint -sL https://github.com/pinterest/ktlint/releases/download/$KTLINT_VERSION/ktlint && chmod a+x /usr/local/bin/ktlint
+curl --output /usr/local/bin/ktlint -sL https://github.com/pinterest/ktlint/releases/download/$KTLINT_VERSION/ktlint && chmod a+x /usr/local/bin/ktlint
 ```
 
 Add this to Dangerfile.
@@ -23,7 +23,7 @@ Add this to Dangerfile.
 ktlint.lint
 
 # If you want inline comments, specify `ktlint.lint` with `inline_mode: true`
-ktlint.lint(inline_mode: true)
+# ktlint.lint(inline_mode: true)
 ```
 
 ### Options
@@ -36,7 +36,6 @@ ktlint.limit = 3
 ktlint.lint
 ```
 
-
 ## CHANGELOG
 
 See [CHANGELOG.md](https://github.com/mataku/danger-ktlint/blob/master/CHANGELOG.md).
@@ -44,6 +43,7 @@ See [CHANGELOG.md](https://github.com/mataku/danger-ktlint/blob/master/CHANGELOG
 ## TODO
 
 - filtering: false (default: filtering: true behavior)
+- XML report_file (Currently only JSON is supported.)
 
 ## Development
 

data/lib/ktlint/gem_version.rb

@@ -1,3 +1,3 @@
 module Ktlint
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.4".freeze
 end

data/lib/ktlint/plugin.rb

@@ -9,6 +9,8 @@ module Danger
     # TODO: Lint all files if `filtering: false`
     attr_accessor :filtering
 
+    attr_accessor :skip_lint, :report_file
+
     def limit
       @limit ||= nil
     end
@@ -33,15 +35,16 @@ module Danger
       end
 
       targets = target_files(git.added_files + git.modified_files)
-      return if targets.empty?
 
-      results = JSON.parse(`ktlint #{targets.join(' ')} --reporter=json --relative`)
-      return if results.empty?
+      results = ktlint_results(targets)
+      if results.nil? || results.empty?
+        return
+      end
 
       if inline_mode
-        send_inline_comments(results)
+        send_inline_comments(results, targets)
       else
-        send_markdown_comment(results)
+        send_markdown_comment(results, targets)
       end
     end
 
@@ -61,12 +64,14 @@ module Danger
     # 		]
     # 	}
     # ]
-    def send_markdown_comment(results)
+    def send_markdown_comment(results, targets)
       catch(:loop_break) do
         count = 0
         results.each do |result|
           result['errors'].each do |error|
-            file = "#{result['file']}#L#{error['line']}"
+            file_path = relative_file_path(result['file'])
+            next unless targets.include?(file_path)
+            file = "#{file_path}#L#{error['line']}"
             message = "#{github.html_link(file)}: #{error['message']}"
             fail(message)
             unless limit.nil?
@@ -80,12 +85,14 @@ module Danger
       end
     end
 
-    def send_inline_comments(results)
+    def send_inline_comments(results, targets)
       catch(:loop_break) do
         count = 0
         results.each do |result|
           result['errors'].each do |error|
-            file = result['file']
+            file_path = relative_file_path(result['file'])
+            next unless targets.include?(file_path)
+
             message = error['message']
             line = error['line']
             fail(message, file: result['file'], line: line)
@@ -106,10 +113,47 @@ module Danger
       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(/#{pwd}\//, '')
+    end
+
     private
 
+    def pwd
+      @pwd ||= `pwd`.chomp
+    end
+
     def ktlint_exists?
       system 'which ktlint > /dev/null 2>&1' 
     end
+
+    def ktlint_results(targets)
+      if skip_lint
+        # TODO: Allow XML
+        if report_file.nil? || report_file.empty?
+          fail("If skip_lint is specified, You must specify ktlint report json file with `ktlint.report_file=...` in your Dangerfile.")
+          return
+        end
+
+        unless File.exists?(report_file)
+          fail("Couldn't find ktlint result json file.\nYou must specify it with `ktlint.report_file=...` in your Dangerfile.")
+          return
+        end
+
+        File.open(report_file) do |f|
+          JSON.load(f)
+        end
+      else
+        unless ktlint_exists?
+          fail("Couldn't find ktlint command. Install first.")
+          return
+        end
+
+        return if targets.empty?
+
+        JSON.parse(`ktlint #{targets.join(' ')} --reporter=json --relative`)
+      end
+    end
   end
 end

data/spec/ktlint_spec.rb

@@ -9,6 +9,10 @@ module Danger
       expect(Danger::DangerKtlint.new(nil)).to be_a Danger::Plugin
     end
 
+    before do
+      allow_any_instance_of(Kernel).to receive(:`).with('pwd').and_return('/home/mataku')
+    end
+
     describe '#lint' do
       before do
         allow_any_instance_of(Danger::DangerfileGitPlugin).to receive(:added_files).and_return(['app/src/main/java/com/mataku/Model.kt'])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-ktlint
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - mataku
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-13 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -129,7 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -150,7 +150,7 @@ homepage: https://github.com/mataku/danger-ktlint
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,8 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Lint kotlin files using ktlint command line interface.
 test_files:

data/.circleci/config.yml

@@ -1,27 +0,0 @@
-version: 2
-jobs:
-  build:
-    docker:
-      - image: ruby:2.5.3
-    steps:
-      - checkout
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "Gemfile.lock" }}
-              # fallback to using the latest cache if no exact match is found
-            - v1-dependencies-
-      
-      - run:
-          name: Install Dependencies
-          command: |
-            bundle install --jobs=4 --path vendor/bundle
-      
-      - save_cache:
-          paths: 
-          - vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      - run:
-          name: Run RSpec
-          command: |
-            bundle exec rspec