goodcheck 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b382336bf78153607e3951bdafe7d819ebac80b080df118fcf3c2b15a25040db
-  data.tar.gz: b17ec056b4d49b70d777a90142b40dd4d17dcb50d9e5861f88cdb37c0eaeff0e
+  metadata.gz: c52f33a7ac472299ab9acdfe418c10f14d7e36c1d709118484ed89bc4c336597
+  data.tar.gz: 9b2021e6127d5f4d5892ac248b04d612ee88d6efb2e0237d54e3e17a25b5ab67
 SHA512:
-  metadata.gz: 5eaa08336a26a7adb83a0100dd48937395b11a3ee0da758a869940d0e741fa515c5eabc9bef9bf6f6eb1d39d69141014e5c64b0868594fb2bf983ccec7f203c9
-  data.tar.gz: 52a89b2342b9d6785d7ecfb847174d36cccba6bbd33c073520dcc4f65569a2579fb0879e59048aa41de8cd5cd00bc1b07c95784fe53f4b2ed2e1cb05417b4ff8
+  metadata.gz: eb9085ae8573a2c07a29e7a75f0dd3f3b56340e1cde25ff10fb369c4eb4f1592f3101fc7bcb93a596d2a69fe3b69e0b4e2d35a81cbf65624fa4d471e7853e42e
+  data.tar.gz: 4eb596ffc6d63a26ef61b3b437b363eb517ff4d0923973b484b587ef39026475d927a408f9ab33c29eb72b207f072d844a12135a96dbd3040be9c5f73a8cf2d4

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## HEAD
 
+## 3.1.0 (2021-07-15)
+
+* Improve coloring for text format [#208](https://github.com/sider/goodcheck/pull/208)
+* Output justification with text format [#210](https://github.com/sider/goodcheck/pull/210)
+
 ## 3.0.3 (2021-06-25)
 
 * Fix HTTP GET retrying [#203](https://github.com/sider/goodcheck/pull/203)

data/README.md

@@ -37,12 +37,12 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 To release a new version, follows the steps below:
 
-1. Update the version number in [`version.rb`](lib/goodcheck/version.rb).
-2. Add the new version's entry to the [changelog](CHANGELOG.md).
-3. Update the documentation via `bundle exec rake docs:update_version`.
-4. Commit the above changes like `git commit -m 'Version 1.2.3'`.
-5. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-6. Publish the updated documentation like `GIT_USER=some_user [USE_SSH=true] bundle exec rake docs:publish`.
+1. Update [`lib/goodcheck/version.rb`](lib/goodcheck/version.rb).
+2. Update [CHANGELOG.md](CHANGELOG.md).
+3. Run `bundle exec rake docs:update_version`.
+4. Run `git add . && git commit -m 'Version <new_version>'`.
+5. Run `bundle exec rake release`, which will create a tag, push the commit and tag, and publish the gem to [RubyGems.org](https://rubygems.org).
+6. Run `GIT_USER=<your_nickname> [USE_SSH=true] bundle exec rake docs:publish`.
 
 ## Contributing
 

data/lib/goodcheck/reporters/text.rb

@@ -25,7 +25,16 @@ module Goodcheck
       def issue(issue)
         @issue_count += 1
 
-        message = issue.rule.message.lines.first.chomp
+        format_line = lambda do |line:, column:|
+          format_args = {
+            path: Rainbow(issue.path).cyan,
+            location: Rainbow(":#{line}:#{column}:").dimgray,
+            message: issue.rule.message.lines.first.chomp,
+            rule: Rainbow("(#{issue.rule.id})").dimgray,
+            severity: issue.rule.severity ? Rainbow("[#{issue.rule.severity}]").magenta : ""
+          }
+          format("%<path>s%<location>s %<message>s  %<rule>s  %<severity>s", format_args).strip
+        end
 
         if issue.location
           start_line = issue.location.start_line
@@ -37,13 +46,21 @@ module Goodcheck
                         else
                           line.bytesize - start_column
                         end
-          rule = Rainbow("(#{issue.rule.id})").darkgray
-          severity = issue.rule.severity ? Rainbow("[#{issue.rule.severity}]").magenta : ""
-          stdout.puts "#{Rainbow(issue.path).cyan}:#{start_line}:#{start_column}: #{message}  #{rule}  #{severity}".strip
+          stdout.puts format_line.call(line: start_line, column: start_column)
           stdout.puts line.chomp
           stdout.puts (" " * start_column_index) + Rainbow("^" + "~" * (column_size - 1)).yellow
         else
-          stdout.puts "#{Rainbow(issue.path).cyan}:-:-: #{message}"
+          stdout.puts format_line.call(line: "-", column: "-")
+        end
+
+        justifications = issue.rule.justifications
+        unless justifications.empty?
+          stdout.puts ""
+          stdout.puts "  #{Rainbow('Justifications').dimgray.underline.italic}:"
+          justifications.each do |justification|
+            stdout.puts "    • #{Rainbow(justification).dimgray.italic}"
+          end
+          stdout.puts ""
         end
       end
 

data/lib/goodcheck/version.rb

@@ -1,3 +1,3 @@
 module Goodcheck
-  VERSION = "3.0.3".freeze
+  VERSION = "3.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goodcheck
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Sider Corporation
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-25 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.21
+rubygems_version: 3.2.23
 signing_key:
 specification_version: 4
 summary: Regexp based customizable linter.