goodcheck 2.4.5 → 2.6.1

data/lib/goodcheck.rb

@@ -1,5 +1,6 @@
 require "strscan"
 require "pathname"
+require "set"
 require "strong_json"
 require "yaml"
 require "json"
@@ -8,12 +9,13 @@ require "active_support/core_ext/integer/inflections"
 require "active_support/tagged_logging"
 require "rainbow"
 require "digest/sha2"
-require "httpclient"
+require "net/http"
 
 require "goodcheck/version"
+require "goodcheck/error"
 require "goodcheck/logger"
 require "goodcheck/home_path"
-
+require "goodcheck/exit_status"
 require "goodcheck/glob"
 require "goodcheck/buffer"
 require "goodcheck/location"

data/lib/goodcheck/buffer.rb

@@ -3,6 +3,33 @@ module Goodcheck
     attr_reader :path
     attr_reader :content
 
+    DISABLE_LINE_PATTERNS = [
+      /\/\/ goodcheck-disable-line$/, #JS, Java, C, ...
+      /# goodcheck-disable-line$/, # Ruby, Python, PHP, ...
+      /-- goodcheck-disable-line$/, # Haskel, SQL, ...
+      /<!-- goodcheck-disable-line -->$/, # HTML, Markdown, ...
+      /\/\* goodcheck-disable-line \*\/$/, # CSS, SCSS,
+      /\{\s*\/\* goodcheck-disable-line \*\/\s*\}$/, # JSX, ...
+      /<%# goodcheck-disable-line %>$/, # ERB, ...
+      /' goodcheck-disable-line$/, # VB
+    ].freeze
+
+    DISABLE_NEXT_LINE_PATTERNS = [
+      /\/\/ goodcheck-disable-next-line$/, #JS, Java, C, ...
+      /# goodcheck-disable-next-line$/, # Ruby, Python, PHP, ...
+      /-- goodcheck-disable-next-line$/, # Haskel, SQL, ...
+      /<!-- goodcheck-disable-next-line -->$/, # HTML, Markdown, ...
+      /\/\* goodcheck-disable-next-line \*\/$/, # CSS, SCSS,
+      /\{\s*\/\* goodcheck-disable-next-line \*\/\s*\}$/, # JSX, ...
+      /<%# goodcheck-disable-next-line %>$/, # ERB, ...
+      /' goodcheck-disable-next-line$/, # VB
+    ].freeze
+
+    class << self
+        attr_accessor :DISABLE_LINE_PATTERNS
+        attr_accessor :DISABLE_NEXT_LINE_PATTERNS
+    end
+
     def initialize(path:, content:)
       @path = path
       @content = content
@@ -24,6 +51,18 @@ module Goodcheck
 
       @line_ranges
     end
+    
+    def line_disabled?(line_number)
+      if line_number > 1
+        return true if DISABLE_NEXT_LINE_PATTERNS.any? { |pattern| line(line_number - 1).match?(pattern) } 
+      end
+
+      if line_number <= lines.length
+        return DISABLE_LINE_PATTERNS.any? { |pattern| line(line_number).match?(pattern) }
+      end
+
+      return false
+    end
 
     def location_for_position(position)
       line_index = line_ranges.bsearch_index do |range|
@@ -35,8 +74,12 @@ module Goodcheck
       end
     end
 
+    def lines
+      @lines ||= content.lines
+    end
+
     def line(line_number)
-      content.lines[line_number-1]
+      lines[line_number-1]
     end
 
     def position_for_location(line, column)

data/lib/goodcheck/cli.rb

@@ -1,9 +1,9 @@
 require "optparse"
 
-Version = Goodcheck::VERSION
-
 module Goodcheck
   class CLI
+    include ExitStatus
+
     attr_reader :stdout
     attr_reader :stderr
 
@@ -19,8 +19,9 @@ module Goodcheck
       pattern: "Print regexp for rules",
       version: "Print version",
       help: "Show help and quit"
-    }
+    }.freeze
 
+    DEFAULT_CONFIG_FILE = Pathname("goodcheck.yml").freeze
 
     def run(args)
       command = args.shift&.to_sym
@@ -30,16 +31,22 @@ module Goodcheck
       elsif command == :"--version"
         version(args)
       else
-        stderr.puts "Invalid command: #{command}" if command
+        if command
+          stderr.puts "invalid command: #{command}"
+          stderr.puts ""
+        end
         help(args)
-        1
+        EXIT_ERROR
       end
+    rescue OptionParser::ParseError => exn
+      stderr.puts exn
+      EXIT_ERROR
     rescue => exn
       stderr.puts exn.inspect
       exn.backtrace.each do |bt|
         stderr.puts "  #{bt}"
       end
-      1
+      EXIT_ERROR
     end
 
     def home_path
@@ -51,32 +58,28 @@ module Goodcheck
     end
 
     def check(args)
-      config_path = Pathname("goodcheck.yml")
+      config_path = DEFAULT_CONFIG_FILE
       targets = []
       rules = []
-      format = nil
+      formats = [:text, :json]
+      format = :text
       loglevel = Logger::ERROR
       force_download = false
 
-      OptionParser.new("Usage: goodcheck check [options] dirs...") do |opts|
-        opts.on("-c CONFIG", "--config=CONFIG") do |config|
-          config_path = Pathname(config)
-        end
-        opts.on("-R RULE", "--rule=RULE") do |rule|
+      OptionParser.new("Usage: goodcheck check [options] paths...") do |opts|
+        config_option(opts) { |config| config_path = config }
+        verbose_option(opts) { |level| loglevel = level }
+        debug_option(opts) { |level| loglevel = level }
+        force_download_option(opts) { force_download = true }
+        common_options(opts)
+
+        opts.on("-R RULE", "--rule=RULE", "Only rule(s) to check") do |rule|
           rules << rule
         end
-        opts.on("--format=<text|json> [default: 'text']") do |f|
+
+        opts.on("--format=<#{formats.join('|')}>", formats, "Output format [default: '#{format}']") do |f|
           format = f
         end
-        opts.on("-v", "--verbose") do
-          loglevel = Logger::INFO
-        end
-        opts.on("-d", "--debug") do
-          loglevel = Logger::DEBUG
-        end
-        opts.on("--force") do
-          force_download = true
-        end
       end.parse!(args)
 
       Goodcheck.logger.level = loglevel
@@ -88,13 +91,12 @@ module Goodcheck
       end
 
       reporter = case format
-                 when "text", nil
+                 when :text
                    Reporters::Text.new(stdout: stdout)
-                 when "json"
+                 when :json
                    Reporters::JSON.new(stdout: stdout, stderr: stderr)
                  else
-                   stderr.puts "Unknown format: #{format}"
-                   return 1
+                   raise ArgumentError, format.inspect
                  end
 
       Goodcheck.logger.info "Configuration = #{config_path}"
@@ -108,23 +110,16 @@ module Goodcheck
     end
 
     def test(args)
-      config_path = Pathname("goodcheck.yml")
-      loglevel = Logger::ERROR
+      config_path = DEFAULT_CONFIG_FILE
+      loglevel = ::Logger::ERROR
       force_download = false
 
       OptionParser.new("Usage: goodcheck test [options]") do |opts|
-        opts.on("-c CONFIG", "--config=CONFIG") do |config|
-          config_path = Pathname(config)
-        end
-        opts.on("-v", "--verbose") do
-          loglevel = Logger::INFO
-        end
-        opts.on("-d", "--debug") do
-          loglevel = Logger::DEBUG
-        end
-        opts.on("--force") do
-          force_download = true
-        end
+        config_option(opts) { |config| config_path = config }
+        verbose_option(opts) { |level| loglevel = level }
+        debug_option(opts) { |level| loglevel = level }
+        force_download_option(opts) { force_download = true }
+        common_options(opts)
       end.parse!(args)
 
       Goodcheck.logger.level = loglevel
@@ -137,14 +132,14 @@ module Goodcheck
     end
 
     def init(args)
-      config_path = Pathname("goodcheck.yml")
+      config_path = DEFAULT_CONFIG_FILE
       force = false
 
       OptionParser.new("Usage: goodcheck init [options]") do |opts|
-        opts.on("-c CONFIG", "--config=CONFIG") do |config|
-          config_path = Pathname(config)
-        end
-        opts.on("--force") do
+        config_option(opts) { |config| config_path = config }
+        common_options(opts)
+
+        opts.on("--force", "Overwrite an existing file") do
           force = true
         end
       end.parse!(args)
@@ -152,9 +147,9 @@ module Goodcheck
       Commands::Init.new(stdout: stdout, stderr: stderr, path: config_path, force: force).run
     end
 
-    def version(args)
+    def version(_args = nil)
       stdout.puts "goodcheck #{VERSION}"
-      0
+      EXIT_SUCCESS
     end
 
     def help(args)
@@ -164,19 +159,48 @@ module Goodcheck
       COMMANDS.each do |c, msg|
         stdout.puts "  goodcheck #{c}\t#{msg}"
       end
-      0
+      EXIT_SUCCESS
     end
 
     def pattern(args)
-      config_path = Pathname("goodcheck.yml")
+      config_path = DEFAULT_CONFIG_FILE
 
-      OptionParser.new("Usage: goodcheck pattern [options] ids...") do |opts|
-        opts.on("-c CONFIG", "--config=CONFIG") do |config|
-          config_path = Pathname(config)
-        end
+      OptionParser.new do |opts|
+        opts.banner = "Usage: goodcheck pattern [options] ids..."
+        config_option(opts) { |config| config_path = config }
+        common_options(opts)
       end.parse!(args)
 
       Commands::Pattern.new(stdout: stdout, stderr: stderr, path: config_path, ids: Set.new(args), home_path: home_path).run
     end
+
+    def config_option(opts)
+      opts.on("-c CONFIG", "--config=CONFIG", "Configuration file path [default: '#{DEFAULT_CONFIG_FILE}']") do |config|
+        yield Pathname(config)
+      end
+    end
+
+    def verbose_option(opts)
+      opts.on("-v", "--verbose", "Set log level to verbose") { yield ::Logger::INFO }
+    end
+
+    def debug_option(opts)
+      opts.on("-d", "--debug", "Set log level to debug") { yield ::Logger::DEBUG }
+    end
+
+    def force_download_option(opts, &block)
+      opts.on("--force", "Download importing files always", &block)
+    end
+
+    def common_options(opts)
+      opts.on_tail("--version", COMMANDS.fetch(:version)) do
+        version
+        exit EXIT_SUCCESS
+      end
+      opts.on_tail("-h", "--help", COMMANDS.fetch(:help)) do
+        stdout.puts opts.help
+        exit EXIT_SUCCESS
+      end
+    end
   end
 end

data/lib/goodcheck/commands/check.rb

@@ -13,6 +13,9 @@ module Goodcheck
 
       include ConfigLoading
       include HomePath
+      include ExitStatus
+
+      EXIT_MATCH = 2
 
       def initialize(config_path:, rules:, targets:, reporter:, stderr:, home_path:, force_download:)
         @config_path = config_path
@@ -30,12 +33,21 @@ module Goodcheck
 
           reporter.analysis do
             load_config!(force_download: force_download, cache_path: cache_dir_path)
+
+            unless missing_rules.empty?
+              missing_rules.each do |rule|
+                stderr.puts "missing rule: #{rule}"
+              end
+              return EXIT_ERROR
+            end
+
             each_check do |buffer, rule, trigger|
               reported_issues = Set[]
 
               reporter.rule(rule) do
                 analyzer = Analyzer.new(rule: rule, buffer: buffer, trigger: trigger)
                 analyzer.scan do |issue|
+                  next if issue.location && buffer.line_disabled?(issue.location.start_line)
                   if reported_issues.add?(issue)
                     issue_reported = true
                     reporter.issue(issue)
@@ -45,7 +57,14 @@ module Goodcheck
             end
           end
 
-          issue_reported ? 2 : 0
+          issue_reported ? EXIT_MATCH : EXIT_SUCCESS
+        end
+      end
+
+      def missing_rules
+        @missing_rules ||= begin
+          config_rule_ids = config.rules.map(&:id)
+          rules.reject { |rule| config_rule_ids.include?(rule) }
         end
       end
 

data/lib/goodcheck/commands/config_loading.rb

@@ -1,11 +1,26 @@
 module Goodcheck
   module Commands
     module ConfigLoading
+      class ConfigFileNotFound < Error
+        attr_reader :path
+
+        def initialize(path:)
+          @path = path
+        end
+      end
+
       attr_reader :config
 
       def load_config!(force_download:, cache_path:)
+        config_content =
+          begin
+            config_path.read
+          rescue Errno::ENOENT
+            raise ConfigFileNotFound.new(path: config_path)
+          end
+
         import_loader = ImportLoader.new(cache_path: cache_path, force_download: force_download, config_path: config_path)
-        content = JSON.parse(JSON.dump(YAML.load(config_path.read, filename: config_path.to_s)), symbolize_names: true)
+        content = JSON.parse(JSON.dump(YAML.load(config_content, filename: config_path.to_s)), symbolize_names: true)
         loader = ConfigLoader.new(path: config_path, content: content, stderr: stderr, import_loader: import_loader)
         @config = loader.load
       end
@@ -13,7 +28,9 @@ module Goodcheck
       def handle_config_errors(stderr)
         begin
           yield
-
+        rescue ConfigFileNotFound => exn
+          stderr.puts "Configuration file not found: #{exn.path}"
+          1
         rescue Psych::Exception => exn
           stderr.puts "Unexpected error happens while loading YAML file: #{exn.inspect}"
           exn.backtrace.each do |trace_loc|

data/lib/goodcheck/commands/init.rb

@@ -58,6 +58,8 @@ rules:
 #   - vendor
       EOC
 
+      include ExitStatus
+
       attr_reader :stdout
       attr_reader :stderr
       attr_reader :path
@@ -73,7 +75,7 @@ rules:
       def run
         if path.file? && !force
           stderr.puts "#{path} already exists. Try --force option to overwrite the file."
-          return 1
+          return EXIT_ERROR
         end
 
         path.open("w") do |io|
@@ -82,7 +84,7 @@ rules:
 
         stdout.puts "Wrote #{path}. ✍️"
 
-        0
+        EXIT_SUCCESS
       end
     end
   end

data/lib/goodcheck/commands/pattern.rb

@@ -9,6 +9,7 @@ module Goodcheck
 
       include ConfigLoading
       include HomePath
+      include ExitStatus
 
       def initialize(stdout:, stderr:, path:, ids:, home_path:)
         @stdout = stdout
@@ -34,7 +35,7 @@ module Goodcheck
           end
         end
 
-        0
+        EXIT_SUCCESS
       end
     end
   end

data/lib/goodcheck/commands/test.rb

@@ -3,6 +3,7 @@ module Goodcheck
     class Test
       include ConfigLoading
       include HomePath
+      include ExitStatus
 
       attr_reader :stdout
       attr_reader :stderr
@@ -24,13 +25,13 @@ module Goodcheck
 
           if config.rules.empty?
             stdout.puts "No rules."
-            return 0
+            return EXIT_SUCCESS
           end
 
-          validate_rule_uniqueness or return 1
-          validate_rules or return 1
+          validate_rule_uniqueness or return EXIT_ERROR
+          validate_rules or return EXIT_ERROR
 
-          0
+          EXIT_SUCCESS
         end
       end