goodcheck 2.5.2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a8fa2f7ee1e8534b3495e3d77a0d0cfb8b49eeaefc77a6507fee9604e0b829a
-  data.tar.gz: 5cd0ac1288b2bb90978998410ff93e234ec08bc645b2ace741f339e0e0b811b2
+  metadata.gz: de4b1a0cef4a741eeb0307e0df5be2dcf68ad43ed59e5a9b5bf1d16e991b4c5e
+  data.tar.gz: a9a980614761ccc2bed278df1c51400878330e3ba92d5999a0133502eb8fa47c
 SHA512:
-  metadata.gz: dbadbb4097eb8ba35fff5845ade562e47830c197297176118f5144ad984132331f890ef9f7b1e30f14e66ae9d43df64819fb7794dd3059f22fe46e75fcd76a6a
-  data.tar.gz: 3728f7b3037174382675361fa05be02e0f1bf1ede5cb6aadacef2098c062568a95e560a10eed72bffd12baac171b636279738ecf3cccd78be11526922bba50bb
+  metadata.gz: 2978efccddd1d7132703a1b993aa25d9e3f588a33ed07cadce73aa514d252bdf963b537314d9d20ea509b437a88ce018ea7d7f38b7cb165572c6e8b8cef07880
+  data.tar.gz: 980698f9a9e94346cc2d727a6c8b3709281747e698e9424f95f00a5c473c75ea16de0026f879f4fde91f3a935004234c712e81913ba0ee5b092b04bef369a58f

data/CHANGELOG.md

@@ -1,10 +1,19 @@
-# CHANGELOG
+# Changelog
 
-## master
+## HEAD
+
+## 2.6.0 (2020-11-17)
+
+* Improve CLI help and error messages [#141](https://github.com/sider/goodcheck/pull/141)
+* Fail if missing rules on `goodcheck check` command [#142](https://github.com/sider/goodcheck/pull/142)
+* Reduce needless files in this gem [#143](https://github.com/sider/goodcheck/pull/143)
+* Add `Goodcheck::Error` as a base error class [#144](https://github.com/sider/goodcheck/pull/144)
+* Improve error message when config file is not found [#145](https://github.com/sider/goodcheck/pull/145)
+* Add `rules[].glob.exclude` option to `goodcheck.yml` [#146](https://github.com/sider/goodcheck/pull/146)
 
 ## 2.5.2 (2020-08-31)
 
-* Fix the pattern of disable lines for Slash-asterisk and add support for JSX [#131](https: //github.com/sider/goodcheck/pull/131)
+* Fix the pattern of disable lines for Slash-asterisk and add support for JSX [#131](https://github.com/sider/goodcheck/pull/131)
 
 ## 2.5.1 (2020-03-09)
 

data/lib/goodcheck.rb

@@ -1,5 +1,6 @@
 require "strscan"
 require "pathname"
+require "set"
 require "strong_json"
 require "yaml"
 require "json"
@@ -11,9 +12,10 @@ require "digest/sha2"
 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/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,6 +33,14 @@ 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[]
 
@@ -46,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
 

data/lib/goodcheck/config_loader.rb

@@ -2,7 +2,7 @@ module Goodcheck
   class ConfigLoader
     include ArrayHelper
 
-    class InvalidPattern < StandardError; end
+    class InvalidPattern < Error; end
 
     Schema = StrongJSON.new do
       def self.array_or(type)
@@ -22,7 +22,8 @@ module Goodcheck
       let :deprecated_token_pattern, object(token: string, case_insensitive: boolean?)
 
       let :encoding, enum(*Encoding.name_list.map {|name| literal(name) })
-      let :glob_obj, object(pattern: string, encoding: optional(encoding))
+      let :glob_obj, object(pattern: string, encoding: optional(encoding),
+                            exclude: enum?(string, array(string)))
       let :one_glob, enum(glob_obj,
                           string,
                           detector: -> (value) {
@@ -344,9 +345,9 @@ module Goodcheck
       globs.map do |glob|
         case glob
         when String
-          Glob.new(pattern: glob, encoding: nil)
+          Glob.new(pattern: glob, encoding: nil, exclude: nil)
         when Hash
-          Glob.new(pattern: glob[:pattern], encoding: glob[:encoding])
+          Glob.new(pattern: glob[:pattern], encoding: glob[:encoding], exclude: glob[:exclude])
         end
       end
     end