Class: ThemeCheck::Cli

Inherits:
Object
  • Object
show all
Defined in:
lib/theme_check/cli.rb

Defined Under Namespace

Classes: Abort

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Cli

Returns a new instance of Cli.



10
11
12
13
14
15
16
17
 
# File 'lib/theme_check/cli.rb', line 10

def initialize
  @path = "."
  @command = :check
  @only_categories = []
  @exclude_categories = []
  @auto_correct = false
  @config_path = nil
end

Instance Attribute Details

#path ⇒ Object

Returns the value of attribute path.



8
9
10
 
# File 'lib/theme_check/cli.rb', line 8

def path
  @path
end

Class Method Details

.parse_and_run(argv) ⇒ Object 



116
117
118
119
120
 
# File 'lib/theme_check/cli.rb', line 116

def self.parse_and_run(argv)
  cli = new
  cli.parse(argv)
  cli.run
end

.parse_and_run!(argv) ⇒ Object 



110
111
112
113
114
 
# File 'lib/theme_check/cli.rb', line 110

def self.parse_and_run!(argv)
  cli = new
  cli.parse(argv)
  cli.run!
end

Instance Method Details

#check ⇒ Object

Raises:



149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/theme_check/cli.rb', line 149

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."
  end
  analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
  analyzer.analyze_theme
  analyzer.correct_offenses
  ThemeCheck::Printer.new.print(theme, analyzer.offenses, @config.auto_correct)
  raise Abort, "" if analyzer.uncorrectable_offenses.any?
end

#help ⇒ Object 



145
146
147
 
# File 'lib/theme_check/cli.rb', line 145

def help
  puts option_parser.to_s
end

#init ⇒ Object 



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/theme_check/cli.rb', line 130

def init
  dotfile_path = ThemeCheck::Config.find(@path)
  if dotfile_path.nil?
    File.write(File.join(@path, ThemeCheck::Config::DOTFILE), File.read(ThemeCheck::Config::DEFAULT_CONFIG))

    puts "Writing new #{ThemeCheck::Config::DOTFILE} to #{@path}"
  else
    raise Abort, "#{ThemeCheck::Config::DOTFILE} already exists at #{@path}."
  end
end

#list ⇒ Object 



122
123
124
 
# File 'lib/theme_check/cli.rb', line 122

def list
  puts @config.enabled_checks
end

#option_parser(parser = OptionParser.new, help: true) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/theme_check/cli.rb', line 19

def option_parser(parser = OptionParser.new, help: true)
  return @option_parser if defined?(@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

#parse(argv) ⇒ Object 



78
79
80
 
# File 'lib/theme_check/cli.rb', line 78

def parse(argv)
  @path = option_parser.parse(argv).first || "."
end

#print ⇒ Object 



141
142
143
 
# File 'lib/theme_check/cli.rb', line 141

def print
  puts YAML.dump(@config.to_h)
end

#run ⇒ Object 



100
101
102
103
104
105
106
107
108
 
# File 'lib/theme_check/cli.rb', line 100

def run
  run!
rescue Abort => e
  if e.message.empty?
    exit(1)
  else
    abort(e.message)
  end
end

#run! ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/theme_check/cli.rb', line 82

def run!
  unless [:version, :init, :help].include?(@command)
    @config = if @config_path
      ThemeCheck::Config.new(
        root: @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
  end

  send(@command)
end

#version ⇒ Object 



126
127
128
 
# File 'lib/theme_check/cli.rb', line 126

def version
  puts ThemeCheck::VERSION
end