ngworder 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23598b09a95c1a5d1c7362d008a6fd720abedca91cd3c3203c785184f3e44c71
-  data.tar.gz: 980852622d530f10d99555c6f7ec15d4979882ca61b1d605cd92f19af914e5d5
+  metadata.gz: 58b3776df5c32d087309ec1988bc4fdb20627dc5140f66833ed2e6fed8d6e828
+  data.tar.gz: 5cc6fbd146932a83bef18dd91f3c939ca9d7f4bb99b7270ccd29ebb27664b630
 SHA512:
-  metadata.gz: b2b577059d5e7f2c6c0491f03ac5d89dda7ae0593fee619e43918c897734330b746e170370e3602b2ac7bb7f59066370a9ce56254643df3ab511129f6acc86b3
-  data.tar.gz: 2686e87281aab43bb92e6413a502bcc1fd6d733f446f3a1d8e8438790d48dae85bcdac3f985f50ddbfe5b117170b8b3e59ee9a2dbae91f22c92375fc9958a2d9
+  metadata.gz: c628c99ca4def6086d7c1df8ccb927bcea84cb89901c967d3c1eb03a6c58b5dd0d107359118fd85e033cad7a2a0ada609b1e74d6d8d7f0a287e805c43e737ece
+  data.tar.gz: 755cb4ea9bc96a0bd62f5f40acba64d1d2c8b0fb838a8ea80eb00bb3d42753bb840ddb45e77be94cd6a5d04bbf8ca980a730a81b4cc971fe9e0dd17cf92fa850

data/README.md

@@ -38,7 +38,7 @@ Example:
 
 ## Output
 ```
-path/to/file:line:col  match  NG:<rule>
+path/to/file:line:col  match  # comment
 ```
 
 ## Performance

data/lib/ngworder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ngworder
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/ngworder.rb

@@ -5,17 +5,18 @@ require "tempfile"
 require_relative "ngworder/version"
 
 module Ngworder
-  Rule = Struct.new(:matcher, :label, :excludes)
+  Rule = Struct.new(:matcher, :label, :excludes, :comment)
   Matcher = Struct.new(:type, :pattern, :label)
 
   module Parser
     module_function
 
-    def strip_comment(line)
+    def split_comment(line)
       out = +""
       escaped = false
+      comment = nil
 
-      line.each_char do |ch|
+      line.each_char.with_index do |ch, idx|
         if escaped
           out << ch
           escaped = false
@@ -28,12 +29,15 @@ module Ngworder
           next
         end
 
-        break if ch == "#"
+        if ch == "#"
+          comment = line[(idx + 1)..-1]
+          break
+        end
 
         out << ch
       end
 
-      out
+      [out, comment]
     end
 
     def split_unescaped_bang(line)
@@ -127,7 +131,7 @@ module Ngworder
       rules = []
 
       File.readlines(path, chomp: true).each do |line|
-        content = strip_comment(line)
+        content, comment = split_comment(line)
         next if content.strip.empty?
 
         parts = split_unescaped_bang(content)
@@ -135,7 +139,9 @@ module Ngworder
         next unless base
 
         excludes = parts.map { |part| parse_matcher(part, trim: :both) }.compact
-        rules << Rule.new(base, base.label, excludes)
+        comment = comment&.strip
+        comment = nil if comment.nil? || comment.empty?
+        rules << Rule.new(base, base.label, excludes, comment)
       end
 
       rules
@@ -272,6 +278,12 @@ module Ngworder
         "\e[35m#{text}\e[0m"
       end
 
+      colorize_path = lambda do |text|
+        return text unless color_enabled
+
+        "\e[36m#{text}\e[0m"
+      end
+
       highlight_line = lambda do |line, span|
         return line unless color_enabled
 
@@ -323,7 +335,9 @@ module Ngworder
                 found = true
                 col_no = span[0] + 1
                 match_text = colorize_match.call(span[2])
-                puts "#{path}:#{line_no}:#{col_no}  #{match_text}  NG:#{rule.label}"
+                suffix = rule.comment ? "  # #{rule.comment}" : ""
+                path_text = colorize_path.call(path)
+                puts "#{path_text}:#{line_no}:#{col_no}  #{match_text}#{suffix}"
                 puts highlight_line.call(line, span) if line_enabled
               end
             end
@@ -353,7 +367,9 @@ module Ngworder
               found = true
               col_no = span[0] + 1
                 match_text = colorize_match.call(span[2])
-                puts "#{path}:#{line_no}:#{col_no}  #{match_text}  NG:#{rule.label}"
+                suffix = rule.comment ? "  # #{rule.comment}" : ""
+                path_text = colorize_path.call(path)
+                puts "#{path_text}:#{line_no}:#{col_no}  #{match_text}#{suffix}"
                 puts highlight_line.call(line, span) if line_enabled
             end
           end
@@ -372,7 +388,9 @@ module Ngworder
               found = true
               col_no = span[0] + 1
                 match_text = colorize_match.call(span[2])
-                puts "#{path}:#{line_no}:#{col_no}  #{match_text}  NG:#{rule.label}"
+                suffix = rule.comment ? "  # #{rule.comment}" : ""
+                path_text = colorize_path.call(path)
+                puts "#{path_text}:#{line_no}:#{col_no}  #{match_text}#{suffix}"
                 puts highlight_line.call(line, span) if line_enabled
             end
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ngworder
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Masanori Kado