theme-check 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b516a7041c1025cd22bcbb4cab685b45893b38fa41ab55b539efad60cf67e100
-  data.tar.gz: 86d5d5054247c0c86b4a31b066a579fc60fbcf4f0d32940354c4fc9793667498
+  metadata.gz: 3c3c0a379dbaa7c43b75d62954952d88a57af1ba6ba028cb30a73803a45fc274
+  data.tar.gz: eef366fdb4f66ec0bf33c1d405e405ea757159295a11bac02ea6c8086e9d5342
 SHA512:
-  metadata.gz: b76463ad9ecab829705519f163745fdd7cb6dea084558983c914dd3ddf923385050da1c535ad73f48a4442dd8a67bc797fd072e293aa85befb15a141870196db
-  data.tar.gz: 67571132dcf7fd556c81d4eb7f7e15c8db6c7ccee70384bb6654915090d5c8c213dbbee9b9b36acd74f0cac02390630defe7c1de1956f41f61c9d30294cdd4a0
+  metadata.gz: ae494f6e081c0ed351d5511c2990503933b50d2b5749fd33f948770d3ffbb46fb7274b91c164731953e2d3566201b38ed09b352c02ec81091081a70c9697b4b3
+  data.tar.gz: 4ecd1ecbc3f035a60c837deb46c8174043a35cc11118fc28f70c30369c8d99d555b4432da1cd3faa662d49773457eb8f3dfad97439a5d2fcce58d45922189ec4

data/CHANGELOG.md

@@ -1,4 +1,9 @@
 
+0.7.3 / 2021-04-13
+==================
+
+  * Refactor CLI option parsing
+
 0.7.2 / 2021-04-12
 ==================
 

data/exe/theme-check

@@ -3,4 +3,4 @@
 
 require "theme_check"
 
-ThemeCheck::Cli.new.run!(ARGV)
+ThemeCheck::Cli.parse_and_run(ARGV)

data/lib/theme_check/cli.rb

@@ -1,85 +1,104 @@
 # frozen_string_literal: true
+require "optparse"
+
 module ThemeCheck
   class Cli
     class Abort < StandardError; end
 
-    USAGE = <<~END
-      Usage: theme-check [options] /path/to/your/theme
-
-      Basic Options:
-        -C, --config <path>                  Use the config provided, overriding .theme-check.yml if present
-        -c, --category <category>            Only run this category of checks
-        -x, --exclude-category  <category>   Exclude this category of checks
-        -a, --auto-correct                   Automatically fix offenses
-
-      Miscellaneous:
-        --init                               Generate a .theme-check.yml file
-        --print-config                       Output active config to STDOUT
-        -h, --help                           Show this. Hi!
-        -l, --list                           List enabled checks
-        -v, --version                        Print Theme Check version
-
-      Description:
-        Theme Check helps you follow Shopify Themes & Liquid best practices by analyzing the
-        Liquid & JSON inside your theme.
-
-        You can configure checks in the .theme-check.yml file of your theme root directory.
-    END
+    attr_accessor :path
 
-    def run(argv)
+    def initialize
       @path = "."
+      @command = :check
+      @only_categories = []
+      @exclude_categories = []
+      @auto_correct = false
+      @config_path = nil
+    end
 
-      command = :check
-      only_categories = []
-      exclude_categories = []
-      auto_correct = false
-      config_path = nil
-
-      args = argv.dup
-      while (arg = args.shift)
-        case arg
-        when "--help", "-h"
-          raise Abort, USAGE
-        when "--version", "-v"
-          command = :version
-        when "--config", "-C"
-          config_path = Pathname.new(args.shift)
-        when "--category", "-c"
-          only_categories << args.shift.to_sym
-        when "--exclude-category", "-x"
-          exclude_categories << args.shift.to_sym
-        when "--list", "-l"
-          command = :list
-        when "--auto-correct", "-a"
-          auto_correct = true
-        when "--init"
-          command = :init
-        when "--print"
-          command = :print
-        else
-          @path = arg
-        end
-      end
+    def option_parser(parser = OptionParser.new, help: true)
+      return @option_parser if @option_parser
+      @option_parser = parser
+      @option_parser.banner = "Usage: theme-check [options] [/path/to/your/theme]"
+
+      @option_parser.separator("")
+      @option_parser.separator("Basic Options:")
+      @option_parser.on(
+        "-C", "--config PATH",
+        "Use the config provided, overriding .theme-check.yml if present"
+      ) { |path| @config_path = path }
+      @option_parser.on(
+        "-c", "--category CATEGORY",
+        "Only run this category of checks"
+      ) { |category| @only_categories << category.to_sym }
+      @option_parser.on(
+        "-x", "--exclude-category CATEGORY",
+        "Exclude this category of checks"
+      ) { |category| @exclude_categories << category.to_sym }
+      @option_parser.on(
+        "-a", "--auto-correct",
+        "Automatically fix offenses"
+      ) { @auto_correct = true }
+
+      @option_parser.separator("")
+      @option_parser.separator("Miscellaneous:")
+      @option_parser.on(
+        "--init",
+        "Generate a .theme-check.yml file"
+      ) { @command = :init }
+      @option_parser.on(
+        "--print",
+        "Output active config to STDOUT"
+      ) { @command = :print }
+      @option_parser.on(
+        "-h", "--help",
+        "Show this. Hi!"
+      ) { @command = :help } if help
+      @option_parser.on(
+        "-l", "--list",
+        "List enabled checks"
+      ) { @command = :list }
+      @option_parser.on(
+        "-v", "--version",
+        "Print Theme Check version"
+      ) { @command = :version }
+
+      @option_parser.separator("")
+      @option_parser.separator(<<~EOS)
+        Description:
+            Theme Check helps you follow Shopify Themes & Liquid best practices by analyzing the
+            Liquid & JSON inside your theme.
+
+            You can configure checks in the .theme-check.yml file of your theme root directory.
+      EOS
+
+      @option_parser
+    end
+
+    def parse(argv)
+      @path = option_parser.parse(argv).first || "."
+    end
 
-      unless [:version, :init].include?(command)
-        @config = if config_path
+    def run!
+      unless [:version, :init, :help].include?(@command)
+        @config = if @config_path
           ThemeCheck::Config.new(
             root: @path,
-            configuration: ThemeCheck::Config.load_file(config_path)
+            configuration: ThemeCheck::Config.load_file(@config_path)
           )
         else
           ThemeCheck::Config.from_path(@path)
         end
-        @config.only_categories = only_categories
-        @config.exclude_categories = exclude_categories
-        @config.auto_correct = auto_correct
+        @config.only_categories = @only_categories
+        @config.exclude_categories = @exclude_categories
+        @config.auto_correct = @auto_correct
       end
 
-      send(command)
+      send(@command)
     end
 
-    def run!(argv)
-      run(argv)
+    def run
+      run!
     rescue Abort => e
       if e.message.empty?
         exit(1)
@@ -88,6 +107,18 @@ module ThemeCheck
       end
     end
 
+    def self.parse_and_run!(argv)
+      cli = new
+      cli.parse(argv)
+      cli.run!
+    end
+
+    def self.parse_and_run(argv)
+      cli = new
+      cli.parse(argv)
+      cli.run
+    end
+
     def list
       puts @config.enabled_checks
     end
@@ -111,12 +142,16 @@ module ThemeCheck
       puts YAML.dump(@config.to_h)
     end
 
+    def help
+      puts option_parser.to_s
+    end
+
     def check
       puts "Checking #{@config.root} ..."
       storage = ThemeCheck::FileSystemStorage.new(@config.root, ignored_patterns: @config.ignored_patterns)
       theme = ThemeCheck::Theme.new(storage)
       if theme.all.empty?
-        raise Abort, "No templates found.\n#{USAGE}"
+        raise Abort, "No templates found."
       end
       analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_theme

data/lib/theme_check/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ThemeCheck
-  VERSION = "0.7.2"
+  VERSION = "0.7.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid