theme-check 1.0.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/theme-check.yml +2 -6
  3. data/CHANGELOG.md +50 -0
  4. data/CONTRIBUTING.md +1 -1
  5. data/README.md +39 -0
  6. data/RELEASING.md +34 -2
  7. data/bin/theme-check +29 -0
  8. data/bin/theme-check-language-server +29 -0
  9. data/config/default.yml +28 -1
  10. data/config/nothing.yml +11 -0
  11. data/config/theme_app_extension.yml +168 -0
  12. data/data/shopify_liquid/objects.yml +1 -0
  13. data/docs/checks/app_block_valid_tags.md +40 -0
  14. data/docs/checks/asset_size_app_block_css.md +52 -0
  15. data/docs/checks/asset_size_app_block_javascript.md +57 -0
  16. data/docs/checks/deprecate_lazysizes.md +0 -3
  17. data/docs/checks/missing_template.md +25 -0
  18. data/docs/checks/pagination_size.md +44 -0
  19. data/docs/checks/template_length.md +1 -1
  20. data/docs/checks/undefined_object.md +5 -0
  21. data/lib/theme_check/analyzer.rb +26 -21
  22. data/lib/theme_check/asset_file.rb +3 -15
  23. data/lib/theme_check/bug.rb +3 -1
  24. data/lib/theme_check/check.rb +26 -4
  25. data/lib/theme_check/checks/app_block_valid_tags.rb +36 -0
  26. data/lib/theme_check/checks/asset_size_app_block_css.rb +44 -0
  27. data/lib/theme_check/checks/asset_size_app_block_javascript.rb +44 -0
  28. data/lib/theme_check/checks/asset_size_css.rb +3 -3
  29. data/lib/theme_check/checks/asset_size_javascript.rb +2 -2
  30. data/lib/theme_check/checks/convert_include_to_render.rb +3 -1
  31. data/lib/theme_check/checks/default_locale.rb +3 -1
  32. data/lib/theme_check/checks/deprecate_bgsizes.rb +1 -1
  33. data/lib/theme_check/checks/deprecate_lazysizes.rb +7 -4
  34. data/lib/theme_check/checks/img_lazy_loading.rb +1 -1
  35. data/lib/theme_check/checks/img_width_and_height.rb +3 -3
  36. data/lib/theme_check/checks/missing_template.rb +21 -5
  37. data/lib/theme_check/checks/pagination_size.rb +65 -0
  38. data/lib/theme_check/checks/parser_blocking_javascript.rb +1 -1
  39. data/lib/theme_check/checks/remote_asset.rb +3 -3
  40. data/lib/theme_check/checks/space_inside_braces.rb +27 -7
  41. data/lib/theme_check/checks/template_length.rb +1 -1
  42. data/lib/theme_check/checks/undefined_object.rb +1 -1
  43. data/lib/theme_check/checks/valid_html_translation.rb +1 -1
  44. data/lib/theme_check/checks.rb +11 -1
  45. data/lib/theme_check/cli.rb +52 -15
  46. data/lib/theme_check/config.rb +56 -10
  47. data/lib/theme_check/corrector.rb +9 -0
  48. data/lib/theme_check/exceptions.rb +29 -27
  49. data/lib/theme_check/file_system_storage.rb +12 -0
  50. data/lib/theme_check/html_check.rb +0 -1
  51. data/lib/theme_check/html_node.rb +37 -16
  52. data/lib/theme_check/html_visitor.rb +17 -3
  53. data/lib/theme_check/json_check.rb +2 -2
  54. data/lib/theme_check/json_file.rb +11 -27
  55. data/lib/theme_check/json_printer.rb +26 -0
  56. data/lib/theme_check/language_server/constants.rb +21 -6
  57. data/lib/theme_check/language_server/document_link_engine.rb +3 -31
  58. data/lib/theme_check/language_server/document_link_provider.rb +70 -0
  59. data/lib/theme_check/language_server/document_link_providers/asset_document_link_provider.rb +11 -0
  60. data/lib/theme_check/language_server/document_link_providers/include_document_link_provider.rb +11 -0
  61. data/lib/theme_check/language_server/document_link_providers/render_document_link_provider.rb +11 -0
  62. data/lib/theme_check/language_server/document_link_providers/section_document_link_provider.rb +11 -0
  63. data/lib/theme_check/language_server/handler.rb +7 -4
  64. data/lib/theme_check/language_server/server.rb +13 -2
  65. data/lib/theme_check/language_server.rb +5 -0
  66. data/lib/theme_check/node.rb +6 -4
  67. data/lib/theme_check/offense.rb +56 -3
  68. data/lib/theme_check/parsing_helpers.rb +4 -3
  69. data/lib/theme_check/position.rb +98 -14
  70. data/lib/theme_check/regex_helpers.rb +5 -2
  71. data/lib/theme_check/tags.rb +26 -9
  72. data/lib/theme_check/template.rb +3 -32
  73. data/lib/theme_check/theme.rb +3 -0
  74. data/lib/theme_check/theme_file.rb +40 -0
  75. data/lib/theme_check/version.rb +1 -1
  76. data/lib/theme_check.rb +16 -0
  77. data/theme-check.gemspec +1 -1
  78. metadata +24 -6
  79. data/bin/liquid-server +0 -4
@@ -52,8 +52,19 @@ module ThemeCheck
52
52
  response_body = JSON.dump(response)
53
53
  log(JSON.pretty_generate(response)) if $DEBUG
54
54
 
55
- @out.write("Content-Length: #{response_body.bytesize}\r\n")
56
- @out.write("\r\n")
55
+ # Because programming is fun,
56
+ #
57
+ # Ruby on Windows turns \n into \r\n. Which means that \r\n
58
+ # gets turned into \r\r\n. Which means that the protocol
59
+ # breaks on windows unless we turn STDOUT into binary mode and
60
+ # set the encoding manually (yuk!) or we do this little hack
61
+ # here and put \n which gets transformed into \r\n on windows
62
+ # only...
63
+ #
64
+ # Hours wasted: 8.
65
+ eol = Gem.win_platform? ? "\n" : "\r\n"
66
+ @out.write("Content-Length: #{response_body.bytesize}#{eol}")
67
+ @out.write(eol)
57
68
  @out.write(response_body)
58
69
  @out.flush
59
70
  end
@@ -8,6 +8,7 @@ require_relative "language_server/variable_lookup_finder"
8
8
  require_relative "language_server/completion_helper"
9
9
  require_relative "language_server/completion_provider"
10
10
  require_relative "language_server/completion_engine"
11
+ require_relative "language_server/document_link_provider"
11
12
  require_relative "language_server/document_link_engine"
12
13
  require_relative "language_server/diagnostics_tracker"
13
14
 
@@ -15,6 +16,10 @@ Dir[__dir__ + "/language_server/completion_providers/*.rb"].each do |file|
15
16
  require file
16
17
  end
17
18
 
19
+ Dir[__dir__ + "/language_server/document_link_providers/*.rb"].each do |file|
20
+ require file
21
+ end
22
+
18
23
  module ThemeCheck
19
24
  module LanguageServer
20
25
  def self.start
@@ -22,9 +22,7 @@ module ThemeCheck
22
22
  end
23
23
 
24
24
  def markup=(markup)
25
- if tag?
26
- @value.raw = markup
27
- elsif @value.instance_variable_defined?(:@markup)
25
+ if @value.instance_variable_defined?(:@markup)
28
26
  @value.instance_variable_set(:@markup, markup)
29
27
  end
30
28
  end
@@ -127,7 +125,11 @@ module ThemeCheck
127
125
  end
128
126
 
129
127
  def position
130
- @position ||= Position.new(markup, template&.source, line_number)
128
+ @position ||= Position.new(
129
+ markup,
130
+ template&.source,
131
+ line_number_1_indexed: line_number
132
+ )
131
133
  end
132
134
 
133
135
  def start_index
@@ -1,11 +1,32 @@
1
1
  # frozen_string_literal: true
2
2
  module ThemeCheck
3
3
  class Offense
4
+ include PositionHelper
5
+
4
6
  MAX_SOURCE_EXCERPT_SIZE = 120
5
7
 
6
8
  attr_reader :check, :message, :template, :node, :markup, :line_number, :correction
7
9
 
8
- def initialize(check:, message: nil, template: nil, node: nil, markup: nil, line_number: nil, correction: nil)
10
+ def initialize(
11
+ check:, # instance of a ThemeCheck::Check
12
+ message: nil, # error message for the offense
13
+ template: nil, # Template
14
+ node: nil, # Node or HtmlNode
15
+ markup: nil, # string
16
+ line_number: nil, # line number of the error (1-indexed)
17
+ # node_markup_offset is the index inside node.markup to start
18
+ # looking for markup :mindblow:.
19
+ # This is so we can accurately highlight node substrings.
20
+ # e.g. if we have the following scenario in which we
21
+ # want to highlight the middle comma
22
+ # * node.markup == "replace ',',', '"
23
+ # * markup == ","
24
+ # Then we need some way of telling our Position class to start
25
+ # looking for the second comma. This is done with node_markup_offset.
26
+ # More context can be found in #376.
27
+ node_markup_offset: 0,
28
+ correction: nil # block
29
+ )
9
30
  @check = check
10
31
  @correction = correction
11
32
 
@@ -39,7 +60,13 @@ module ThemeCheck
39
60
  @node.line_number
40
61
  end
41
62
 
42
- @position = Position.new(@markup, @template&.source, @line_number)
63
+ @position = Position.new(
64
+ @markup,
65
+ @template&.source,
66
+ line_number_1_indexed: @line_number,
67
+ node_markup_offset: node_markup_offset,
68
+ node_markup: node&.markup
69
+ )
43
70
  end
44
71
 
45
72
  def source_excerpt
@@ -103,8 +130,13 @@ module ThemeCheck
103
130
  tokens.join(":") if tokens.any?
104
131
  end
105
132
 
133
+ def location_range
134
+ tokens = [template&.relative_path, start_index, end_index].compact
135
+ tokens.join(":") if tokens.any?
136
+ end
137
+
106
138
  def correctable?
107
- line_number && correction
139
+ !!correction
108
140
  end
109
141
 
110
142
  def correct
@@ -139,5 +171,26 @@ module ThemeCheck
139
171
  message
140
172
  end
141
173
  end
174
+
175
+ def to_s_range
176
+ if template
177
+ "#{message} at #{location_range}"
178
+ else
179
+ message
180
+ end
181
+ end
182
+
183
+ def to_h
184
+ {
185
+ check: check.code_name,
186
+ path: template&.relative_path,
187
+ severity: check.severity_value,
188
+ start_line: start_line,
189
+ start_column: start_column,
190
+ end_line: end_line,
191
+ end_column: end_column,
192
+ message: message,
193
+ }
194
+ end
142
195
  end
143
196
  end
@@ -5,15 +5,16 @@ module ThemeCheck
5
5
  def outside_of_strings(markup)
6
6
  scanner = StringScanner.new(markup)
7
7
 
8
- while scanner.scan(/.*?("|')/)
9
- yield scanner.matched[0..-2]
8
+ while scanner.scan(/.*?("|')/m)
9
+ chunk_start = scanner.pre_match.size
10
+ yield scanner.matched[0..-2], chunk_start
10
11
  quote = scanner.matched[-1] == "'" ? "'" : "\""
11
12
  # Skip to the end of the string
12
13
  # Check for empty string first, since follow regexp uses lookahead
13
14
  scanner.skip(/#{quote}/) || scanner.skip_until(/[^\\]#{quote}/)
14
15
  end
15
16
 
16
- yield scanner.rest if scanner.rest?
17
+ yield scanner.rest, scanner.charpos if scanner.rest?
17
18
  end
18
19
  end
19
20
  end
@@ -4,42 +4,64 @@ module ThemeCheck
4
4
  class Position
5
5
  include PositionHelper
6
6
 
7
- def initialize(needle, contents, line_number_1_indexed)
8
- @needle = needle
9
- @contents = contents
7
+ def initialize(
8
+ needle_arg,
9
+ contents_arg,
10
+ line_number_1_indexed: nil,
11
+ node_markup: nil,
12
+ node_markup_offset: 0 # the index of markup inside the node_markup
13
+ )
14
+ @needle = needle_arg
15
+ @contents = contents_arg
10
16
  @line_number_1_indexed = line_number_1_indexed
11
- @start_row_column = nil
12
- @end_row_column = nil
17
+ @node_markup_offset = node_markup_offset
18
+ @node_markup = node_markup
19
+ @strict_position = StrictPosition.new(
20
+ needle,
21
+ contents,
22
+ start_index,
23
+ )
13
24
  end
14
25
 
15
- def start_line_index
26
+ def start_line_offset
16
27
  from_row_column_to_index(contents, line_number, 0)
17
28
  end
18
29
 
30
+ def start_offset
31
+ return start_line_offset if @node_markup.nil?
32
+ node_markup_start = contents.index(@node_markup, start_line_offset)
33
+ return start_line_offset if node_markup_start.nil?
34
+ node_markup_start + @node_markup_offset
35
+ end
36
+
19
37
  # 0-indexed, inclusive
20
38
  def start_index
21
- contents.index(needle, start_line_index) || start_line_index
39
+ contents.index(needle, start_offset)
22
40
  end
23
41
 
24
42
  # 0-indexed, exclusive
25
43
  def end_index
26
- start_index + needle.size
44
+ @strict_position.end_index
27
45
  end
28
46
 
47
+ # 0-indexed, inclusive
29
48
  def start_row
30
- start_row_column[0]
49
+ @strict_position.start_row
31
50
  end
32
51
 
52
+ # 0-indexed, inclusive
33
53
  def start_column
34
- start_row_column[1]
54
+ @strict_position.start_column
35
55
  end
36
56
 
57
+ # 0-indexed, exclusive (both taken together are) therefore you
58
+ # might end up on a newline character or the next line
37
59
  def end_row
38
- end_row_column[0]
60
+ @strict_position.end_row
39
61
  end
40
62
 
41
63
  def end_column
42
- end_row_column[1]
64
+ @strict_position.end_column
43
65
  end
44
66
 
45
67
  private
@@ -55,15 +77,77 @@ module ThemeCheck
55
77
  end
56
78
 
57
79
  def needle
58
- if @needle.nil? && !contents.empty? && !@line_number_1_indexed.nil?
59
- contents.lines(chomp: true)[line_number] || ''
80
+ if has_content_and_line_number_but_no_needle?
81
+ entire_line_needle
60
82
  elsif contents.empty? || @needle.nil?
61
83
  ''
84
+ elsif !can_find_needle?
85
+ entire_line_needle
62
86
  else
63
87
  @needle
64
88
  end
65
89
  end
66
90
 
91
+ def has_content_and_line_number_but_no_needle?
92
+ @needle.nil? && !contents.empty? && @line_number_1_indexed.is_a?(Integer)
93
+ end
94
+
95
+ def can_find_needle?
96
+ !!contents.index(@needle)
97
+ end
98
+
99
+ def entire_line_needle
100
+ contents.lines(chomp: true)[line_number] || ''
101
+ end
102
+ end
103
+
104
+ # This method is stricter than Position in the sense that it doesn't
105
+ # accept invalid inputs. Makes for code that is easier to understand.
106
+ class StrictPosition
107
+ include PositionHelper
108
+
109
+ attr_reader :needle, :contents
110
+
111
+ def initialize(needle, contents, start_index)
112
+ raise ArgumentError, 'Bad start_index' unless start_index.is_a?(Integer)
113
+ raise ArgumentError, 'Bad contents' unless contents.is_a?(String)
114
+ raise ArgumentError, 'Bad needle' unless needle.is_a?(String) || !contents.index(needle, start_index)
115
+
116
+ @needle = needle
117
+ @contents = contents
118
+ @start_index = start_index
119
+ @start_row_column = nil
120
+ @end_row_column = nil
121
+ end
122
+
123
+ # 0-indexed, inclusive
124
+ def start_index
125
+ @contents.index(needle, @start_index)
126
+ end
127
+
128
+ # 0-indexed, exclusive
129
+ def end_index
130
+ start_index + needle.size
131
+ end
132
+
133
+ def start_row
134
+ start_row_column[0]
135
+ end
136
+
137
+ def start_column
138
+ start_row_column[1]
139
+ end
140
+
141
+ def end_row
142
+ end_row_column[0]
143
+ end
144
+
145
+ def end_column
146
+ end_row_column[1]
147
+ end
148
+
149
+ private
150
+
67
151
  def start_row_column
68
152
  return @start_row_column unless @start_row_column.nil?
69
153
  @start_row_column = from_index_to_row_column(contents, start_index)
@@ -2,8 +2,11 @@
2
2
 
3
3
  module ThemeCheck
4
4
  module RegexHelpers
5
- VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
5
+ LIQUID_TAG = /#{Liquid::TagStart}.*?#{Liquid::TagEnd}/om
6
+ LIQUID_VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
7
+ LIQUID_TAG_OR_VARIABLE = /#{LIQUID_TAG}|#{LIQUID_VARIABLE}/om
6
8
  START_OR_END_QUOTE = /(^['"])|(['"]$)/
9
+
7
10
  def matches(s, re)
8
11
  start_at = 0
9
12
  matches = []
@@ -16,7 +19,7 @@ module ThemeCheck
16
19
 
17
20
  def href_to_file_size(href)
18
21
  # asset_url (+ optional stylesheet_tag) variables
19
- if href =~ /^#{VARIABLE}$/o && href =~ /asset_url/ && href =~ Liquid::QuotedString
22
+ if href =~ /^#{LIQUID_VARIABLE}$/o && href =~ /asset_url/ && href =~ Liquid::QuotedString
20
23
  asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
21
24
  asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
22
25
  return if asset.nil?
@@ -169,14 +169,31 @@ module ThemeCheck
169
169
 
170
170
  class Stylesheet < Liquid::Raw; end
171
171
 
172
- Liquid::Template.register_tag('form', Form)
173
- Liquid::Template.register_tag('layout', Layout)
174
- Liquid::Template.register_tag('render', Render)
175
- Liquid::Template.register_tag('paginate', Paginate)
176
- Liquid::Template.register_tag('section', Section)
177
- Liquid::Template.register_tag('style', Style)
178
- Liquid::Template.register_tag('schema', Schema)
179
- Liquid::Template.register_tag('javascript', Javascript)
180
- Liquid::Template.register_tag('stylesheet', Stylesheet)
172
+ class << self
173
+ attr_writer :register_tags
174
+
175
+ def register_tags?
176
+ @register_tags
177
+ end
178
+
179
+ def register_tag(name, klass)
180
+ Liquid::Template.register_tag(name, klass)
181
+ end
182
+
183
+ def register_tags!
184
+ return if !register_tags? || (defined?(@registered_tags) && @registered_tags)
185
+ @registered_tags = true
186
+ register_tag('form', Form)
187
+ register_tag('layout', Layout)
188
+ register_tag('render', Render)
189
+ register_tag('paginate', Paginate)
190
+ register_tag('section', Section)
191
+ register_tag('style', Style)
192
+ register_tag('schema', Schema)
193
+ register_tag('javascript', Javascript)
194
+ register_tag('stylesheet', Stylesheet)
195
+ end
196
+ end
197
+ self.register_tags = true
181
198
  end
182
199
  end
@@ -1,25 +1,7 @@
1
1
  # frozen_string_literal: true
2
- require "pathname"
3
2
 
4
3
  module ThemeCheck
5
- class Template
6
- def initialize(relative_path, storage)
7
- @storage = storage
8
- @relative_path = relative_path
9
- end
10
-
11
- def path
12
- @storage.path(@relative_path)
13
- end
14
-
15
- def relative_path
16
- @relative_pathname ||= Pathname.new(@relative_path)
17
- end
18
-
19
- def source
20
- @source ||= @storage.read(@relative_path)
21
- end
22
-
4
+ class Template < ThemeFile
23
5
  def write
24
6
  content = updated_content
25
7
  if source != content
@@ -28,14 +10,6 @@ module ThemeCheck
28
10
  end
29
11
  end
30
12
 
31
- def name
32
- relative_path.sub_ext('').to_s
33
- end
34
-
35
- def json?
36
- false
37
- end
38
-
39
13
  def liquid?
40
14
  true
41
15
  end
@@ -88,16 +62,13 @@ module ThemeCheck
88
62
  parse.root
89
63
  end
90
64
 
91
- def ==(other)
92
- other.is_a?(Template) && relative_path == other.relative_path
93
- end
94
- alias_method :eql?, :==
95
-
96
65
  def self.parse(source)
66
+ Tags.register_tags!
97
67
  Liquid::Template.parse(
98
68
  source,
99
69
  line_numbers: true,
100
70
  error_mode: :warn,
71
+ disable_liquid_c_nodes: true,
101
72
  )
102
73
  end
103
74
  end