theme-check 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 960f944628496ea317205e34678a78ec1e560dbfb48f40cfa33be2d82ebe4770
-  data.tar.gz: 66e2abe15609c6e5a40d13d05aa0daedf9fbd783e31226bbfb0c6961c1d89ad6
+  metadata.gz: 713459ed0c35e11e175e51d42237fceb583184af08a00f8f56cdecbbb1c494b8
+  data.tar.gz: aa2059da0b820755eee1a8778748d7c7758fef705e29f5def5c74905743553d8
 SHA512:
-  metadata.gz: d920362e7729fc739c0a0202e00a605025db3d80c2fdfac5be9d6d9ea6c74bc4922baa82e093851432417863106c14964f6fdc76f66e55fd7947f33887b989c1
-  data.tar.gz: 26eb4ba427e8380ece15160c2c27cd052802ec233bb61a4a17e36dcf7f008cc7bc569b71649c525c6d57a7d79654469af65ec664726665584806928cf7258483
+  metadata.gz: fa6216908fb067365d11ef7c0ea1c2e0a847de124f81ad43824eb49f9373093b6fc54dabbc1062dd9068af11724abc9dad020c6bebc2c71702f4750a8829aa78
+  data.tar.gz: f0412fbb0407d75e33ac96f66c760dd39ddb5cd18c751b8f6cb8a6edb4da1d0867147d929b7bae1401eb5837ee1c4aa0f40f60340d70c4a75c5f47a0753ebf58

data/.github/workflows/theme-check.yml

@@ -8,15 +8,23 @@ jobs:
 
     strategy:
       matrix:
-        platform: [ubuntu-latest, windows-latest]
+        platform:
+          - ubuntu-latest
+          - windows-latest
         version:
           - 3.0.0
           - 2.6.6
+        theme:
+          - Shopify/dawn
 
     name: Ruby ${{ matrix.platform }} ${{ matrix.version }}
 
     steps:
     - uses: actions/checkout@v2
+    - uses: actions/checkout@v2
+      with:
+        repository: ${{ matrix.theme }}
+        path: ./crash-test-theme
     - name: Set up Ruby ${{ matrix.version }}
       uses: ruby/setup-ruby@v1
       with:
@@ -30,6 +38,6 @@ jobs:
       run: bundle install --jobs=3 --retry=3 --path=vendor/bundle
     - name: Run tests
       run: bundle exec rake
-    - name: Test runtime
-      # Testing that runtime can execute, not testing the results themselves
-      run: bundle exec theme-check ./test/theme | grep -q "files inspected"
+    - name: Crash test
+      run: |
+        bundle exec theme-check --fail-level crash ./crash-test-theme

data/CHANGELOG.md

@@ -1,4 +1,21 @@
 
+v1.6.0 / 2021-09-14
+===================
+
+### Features
+
+  * Add `--auto-correct` support to `TranslationKeyExists` (add missing translation as TODO to default locale) ([#422](https://github.com/shopify/theme-check/issues/422))
+  * Add `--auto-correct` support to `UnusedSnippet` (delete unused file) ([#416](https://github.com/shopify/theme-check/issues/416))
+  * Add `--auto-correct` support to `MissingRequiredTemplateFiles` (create missing files) ([#385](https://github.com/shopify/theme-check/issues/385))
+
+### Fixes
+
+  * Fix `undefined method [] of nil` in `replace_placeholders` ([#441](https://github.com/shopify/theme-check/issues/441), [#444](https://github.com/shopify/theme-check/issues/444))
+  * Disable ConvertIncludeToRender corrector until we fix [#445](https://github.com/shopify/theme-check/issues/445) ([#446](https://github.com/shopify/theme-check/issues/446))
+  * Fix a couple of correction bugs ([#442](https://github.com/shopify/theme-check/issues/442), [#439](https://github.com/shopify/theme-check/issues/439))
+  * Fix `AssetSizeCSS` error when size is nil ([#419](https://github.com/shopify/theme-check/issues/419))
+  * Write JSON to file, not a Ruby Hash. ([#434](https://github.com/shopify/theme-check/issues/434), [#432](https://github.com/shopify/theme-check/issues/432))
+
 v1.5.2 / 2021-09-09
 ===================
 

data/lib/theme_check/analyzer.rb

@@ -86,6 +86,11 @@ module ThemeCheck
     def correct_offenses
       if @auto_correct
         offenses.each(&:correct)
+      end
+    end
+
+    def write_corrections
+      if @auto_correct
         @theme.liquid.each(&:write)
         @theme.json.each(&:write)
       end

data/lib/theme_check/asset_file.rb

@@ -9,10 +9,21 @@ module ThemeCheck
       @content = nil
     end
 
-    alias_method :content, :source
+    def rewriter
+      @rewriter ||= TemplateRewriter.new(@relative_path, source)
+    end
+
+    def write
+      content = rewriter.to_s
+      if source != content
+        @storage.write(@relative_path, content.gsub("\n", @eol))
+        @source = content
+        @rewriter = nil
+      end
+    end
 
     def gzipped_size
-      @gzipped_size ||= Zlib.gzip(content).bytesize
+      @gzipped_size ||= Zlib.gzip(source).bytesize
     end
 
     def name

data/lib/theme_check/check.rb

@@ -46,7 +46,7 @@ module ThemeCheck
       end
 
       def severity_value(severity)
-        SEVERITY_VALUES[severity]
+        SEVERITY_VALUES[severity] || -1
       end
 
       def categories(*categories)

data/lib/theme_check/checks/asset_size_css.rb

@@ -22,5 +22,20 @@ module ThemeCheck
         node: node
       )
     end
+
+    def href_to_file_size(href)
+      # asset_url (+ optional stylesheet_tag) variables
+      if href =~ /^#{LIQUID_VARIABLE}$/o && href =~ /asset_url/ && href =~ Liquid::QuotedString
+        asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
+        asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
+        return if asset.nil?
+        asset.gzipped_size
+
+      # remote URLs
+      elsif href =~ %r{^(https?:)?//}
+        asset = RemoteAssetFile.from_src(href)
+        asset.gzipped_size
+      end
+    end
   end
 end

data/lib/theme_check/checks/asset_size_css_stylesheet_tag.rb

@@ -13,12 +13,29 @@ module ThemeCheck
     def on_variable(node)
       used_filters = node.value.filters.map { |name, *_rest| name }
       return unless used_filters.include?("stylesheet_tag")
-      file_size = href_to_file_size('{{' + node.markup + '}}')
+      file_size = stylesheet_tag_pipeline_to_file_size(node.markup)
+      return if file_size.nil?
       return if file_size <= @threshold_in_bytes
       add_offense(
         "CSS on every page load exceeding compressed size threshold (#{@threshold_in_bytes} Bytes).",
         node: node
       )
     end
+
+    def stylesheet_tag_pipeline_to_file_size(href)
+      # asset_url
+      if href =~ /asset_url/ && href =~ Liquid::QuotedString
+        asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
+        asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
+        return if asset.nil?
+        asset.gzipped_size
+
+      # remote URLs
+      elsif href =~ %r{(https?:)?//[^'"]+}
+        url = Regexp.last_match(0)
+        asset = RemoteAssetFile.from_src(url)
+        asset.gzipped_size
+      end
+    end
   end
 end

data/lib/theme_check/checks/convert_include_to_render.rb

@@ -8,7 +8,8 @@ module ThemeCheck
 
     def on_include(node)
       add_offense("`include` is deprecated - convert it to `render`", node: node) do |corrector|
-        corrector.replace(node, "render \'#{node.value.template_name_expr}\' ")
+        # We need to fix #445 and pass the variables from the context or don't replace at all.
+        # corrector.replace(node, "render \'#{node.value.template_name_expr}\' ")
       end
     end
   end

data/lib/theme_check/checks/missing_required_template_files.rb

@@ -9,19 +9,33 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     REQUIRED_LIQUID_FILES = %w(layout/theme)
-    REQUIRED_TEMPLATE_FILES = %w(
-      index product collection cart blog article page list-collections search 404
+
+    REQUIRED_LIQUID_TEMPLATE_FILES = %w(
       gift_card customers/account customers/activate_account customers/addresses
-      customers/login customers/order customers/register customers/reset_password password
-    )
-      .map { |file| "templates/#{file}" }
+      customers/login customers/order customers/register customers/reset_password
+    ).map { |file| "templates/#{file}" }
+
+    REQUIRED_JSON_TEMPLATE_FILES = %w(
+      index product collection cart blog article page list-collections search 404
+      password
+    ).map { |file| "templates/#{file}" }
+
+    REQUIRED_TEMPLATE_FILES = (REQUIRED_LIQUID_TEMPLATE_FILES + REQUIRED_JSON_TEMPLATE_FILES)
 
     def on_end
       (REQUIRED_LIQUID_FILES - theme.liquid.map(&:name)).each do |file|
-        add_offense("'#{file}.liquid' is missing")
+        add_offense("'#{file}.liquid' is missing") do |corrector|
+          corrector.create(@theme, "#{file}.liquid", "")
+        end
       end
       (REQUIRED_TEMPLATE_FILES - (theme.liquid + theme.json).map(&:name)).each do |file|
-        add_offense("'#{file}.liquid' or '#{file}.json' is missing")
+        add_offense("'#{file}.liquid' or '#{file}.json' is missing") do |corrector|
+          if REQUIRED_LIQUID_TEMPLATE_FILES.include?(file)
+            corrector.create(@theme, "#{file}.liquid", "")
+          else
+            corrector.create(@theme, "#{file}.json", "")
+          end
+        end
       end
     end
   end

data/lib/theme_check/checks/translation_key_exists.rb

@@ -29,7 +29,9 @@ module ThemeCheck
           "'#{key_node.value}' does not have a matching entry in '#{@theme.default_locale_json.relative_path}'",
           node: node,
           markup: key_node.value,
-        )
+        ) do |corrector|
+          corrector.add_default_translation_key(@theme.default_locale_json, key_node.value.split("."), "TODO")
+        end
       end
     end
 

data/lib/theme_check/checks/unused_snippet.rb

@@ -24,7 +24,9 @@ module ThemeCheck
 
     def on_end
       missing_snippets.each do |template|
-        add_offense("This template is not used", template: template)
+        add_offense("This template is not used", template: template) do |corrector|
+          corrector.remove(@theme, template.relative_path.to_s)
+        end
       end
     end
 

data/lib/theme_check/cli.rb

@@ -49,7 +49,7 @@ module ThemeCheck
         "Automatically fix offenses"
       ) { @auto_correct = true }
       @option_parser.on(
-        "--fail-level SEVERITY", Check::SEVERITIES,
+        "--fail-level SEVERITY", [:crash] + Check::SEVERITIES,
         "Minimum severity (error|suggestion|style) for exit with error code"
       ) do |severity|
         @fail_level = severity.to_sym
@@ -191,7 +191,10 @@ module ThemeCheck
       analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_theme
       analyzer.correct_offenses
-      output_with_format(theme, analyzer, out_stream)
+      print_with_format(theme, analyzer, out_stream)
+      # corrections are committed after printing so that the
+      # source_excerpts are still pointing to the uncorrected source.
+      analyzer.write_corrections
       raise Abort, "" if analyzer.uncorrectable_offenses.any? do |offense|
         offense.check.severity_value <= Check.severity_value(@fail_level)
       end
@@ -211,7 +214,7 @@ module ThemeCheck
       STDERR.puts "Profiling is only available in development"
     end
 
-    def output_with_format(theme, analyzer, out_stream)
+    def print_with_format(theme, analyzer, out_stream)
       case @format
       when :text
         ThemeCheck::Printer.new(out_stream).print(theme, analyzer.offenses, @config.auto_correct)

data/lib/theme_check/corrector.rb

@@ -7,25 +7,20 @@ module ThemeCheck
     end
 
     def insert_after(node, content)
-      line = @template.full_line(node.line_number)
-      line.insert(node.range[1] + 1, content)
+      @template.rewriter.insert_after(node, content)
     end
 
     def insert_before(node, content)
-      line = @template.full_line(node.line_number)
-      line.insert(node.range[0], content)
+      @template.rewriter.insert_before(node, content)
     end
 
     def replace(node, content)
-      line = @template.full_line(node.line_number)
-      line[node.range[0]..node.range[1]] = content
+      @template.rewriter.replace(node, content)
       node.markup = content
     end
 
     def wrap(node, insert_before, insert_after)
-      line = @template.full_line(node.line_number)
-      line.insert(node.range[0], insert_before)
-      line.insert(node.range[1] + 1 + insert_before.length, insert_after)
+      @template.rewriter.wrap(node, insert_before, insert_after)
     end
 
     def create(theme, relative_path, content)
@@ -34,11 +29,25 @@ module ThemeCheck
 
     def create_default_locale_json(theme)
       theme.default_locale_json = JsonFile.new("locales/#{theme.default_locale}.default.json", theme.storage)
-      theme.default_locale_json.update_contents('{}')
+      theme.default_locale_json.update_contents({})
+    end
+
+    def remove(theme, relative_path)
+      theme.storage.remove(relative_path)
     end
 
     def mkdir(theme, relative_path)
       theme.storage.mkdir(relative_path)
     end
+
+    def add_default_translation_key(file, key, value)
+      hash = file.content
+      key.reduce(hash) do |pointer, token|
+        return pointer[token] = value if token == key.last
+        pointer[token] = {} unless pointer.key?(token)
+        pointer[token]
+      end
+      file.update_contents(hash)
+    end
   end
 end

data/lib/theme_check/file_system_storage.rb

@@ -16,14 +16,19 @@ module ThemeCheck
     end
 
     def read(relative_path)
-      file(relative_path).read
+      file(relative_path).read(mode: 'rb', encoding: 'UTF-8')
     end
 
     def write(relative_path, content)
       reset_memoizers unless file_exists?(relative_path)
 
       file(relative_path).dirname.mkpath unless file(relative_path).dirname.directory?
-      file(relative_path).write(content)
+      file(relative_path).write(content, mode: 'w+b', encoding: 'UTF-8')
+    end
+
+    def remove(relative_path)
+      file(relative_path).delete
+      reset_memoizers
     end
 
     def mkdir(relative_path)

data/lib/theme_check/html_node.rb

@@ -67,10 +67,10 @@ module ThemeCheck
     private
 
     def replace_placeholders(string)
-      # Replace all {%#{i}####%} with the actual content.
-      string.gsub(LIQUID_TAG) do |match|
-        key = /\d+/.match(match)[0]
-        @placeholder_values[key.to_i]
+      # Replace all ≬{i}####≬ with the actual content.
+      string.gsub(HTML_LIQUID_PLACEHOLDER) do |match|
+        key = /[0-9a-z]+/.match(match)[0]
+        @placeholder_values[key.to_i(36)]
       end
     end
   end

data/lib/theme_check/html_visitor.rb

@@ -9,12 +9,11 @@ module ThemeCheck
 
     def initialize(checks)
       @checks = checks
-      @placeholder_values = []
     end
 
     def visit_template(template)
-      doc = parse(template)
-      visit(HtmlNode.new(doc, template, @placeholder_values))
+      doc, placeholder_values = parse(template)
+      visit(HtmlNode.new(doc, template, placeholder_values))
     rescue ArgumentError => e
       call_checks(:on_parse_error, e, template)
     end
@@ -22,19 +21,32 @@ module ThemeCheck
     private
 
     def parse(template)
+      placeholder_values = []
       parseable_source = +template.source.clone
 
-      # Replace all liquid tags with {%#{i}######%} to prevent the HTML
+      # Replace all non-empty liquid tags with ≬{i}######≬ to prevent the HTML
       # parser from freaking out. We transparently replace those placeholders in
       # HtmlNode.
+      #
+      # We're using base36 to prevent index bleeding on 36^3 tags.
+      # `{{x}}` -> `≬#{i}≬` would properly be transformed for 46656 tags in a single file.
+      # Should be enough.
+      #
+      # The base10 alternative would have overflowed at 1000 (`{{x}}` -> `≬1000≬`) which seemed more likely.
+      #
+      # Didn't go with base64 because of the `=` character that would have messed with HTML parsing.
       matches(parseable_source, LIQUID_TAG_OR_VARIABLE).each do |m|
         value = m[0]
-        @placeholder_values.push(value)
-        key = (@placeholder_values.size - 1).to_s
-        parseable_source[m.begin(0)...m.end(0)] = "{%#{key.ljust(m.end(0) - m.begin(0) - 4, '#')}%}"
+        next unless value.size > 4 # skip empty tags/variables {%%} and {{}}
+        placeholder_values.push(value)
+        key = (placeholder_values.size - 1).to_s(36)
+        parseable_source[m.begin(0)...m.end(0)] = "≬#{key.ljust(m.end(0) - m.begin(0) - 2, '#')}≬"
       end
 
-      Nokogiri::HTML5.fragment(parseable_source, max_tree_depth: 400, max_attributes: 400)
+      [
+        Nokogiri::HTML5.fragment(parseable_source, max_tree_depth: 400, max_attributes: 400),
+        placeholder_values,
+      ]
     end
 
     def visit(node)

data/lib/theme_check/in_memory_storage.rb

@@ -23,6 +23,10 @@ module ThemeCheck
       @files[relative_path] = content
     end
 
+    def remove(relative_path)
+      @files.delete(relative_path)
+    end
+
     def mkdir(relative_path)
       @files[relative_path] = nil
     end

data/lib/theme_check/json_file.rb

@@ -20,14 +20,19 @@ module ThemeCheck
       @parser_error
     end
 
-    def update_contents(new_content = '{}')
+    def update_contents(new_content = {})
+      raise ArgumentError if new_content.is_a?(String)
       @content = new_content
     end
 
     def write
-      if source != @content
-        @storage.write(@relative_path, content)
-        @source = content
+      pretty = JSON.pretty_generate(@content)
+      if source.rstrip != pretty.rstrip
+        # Most editors add a trailing \n at the end of files. Here we
+        # try to maintain the convention.
+        eof = source.end_with?("\n") ? "\n" : ""
+        @storage.write(@relative_path, pretty.gsub("\n", @eol) + eof)
+        @source = pretty
       end
     end
 

data/lib/theme_check/node.rb

@@ -156,11 +156,6 @@ module ThemeCheck
       end
     end
 
-    def range
-      start = template.full_line(line_number).index(markup)
-      [start, start + markup.length - 1]
-    end
-
     def position
       @position ||= Position.new(
         markup,
@@ -169,6 +164,14 @@ module ThemeCheck
       )
     end
 
+    def start_index
+      position.start_index
+    end
+
+    def end_index
+      position.end_index
+    end
+
     def start_token
       return "" if inside_liquid_tag?
       output = ""
@@ -187,14 +190,6 @@ module ThemeCheck
       output
     end
 
-    def start_index
-      position.start_index
-    end
-
-    def end_index
-      position.end_index
-    end
-
     private
 
     # Here we're hacking around a glorious bug in Liquid that makes it so the

data/lib/theme_check/offense.rb

@@ -144,6 +144,32 @@ module ThemeCheck
         corrector = Corrector.new(template: template)
         correction.call(corrector)
       end
+    rescue => e
+      ThemeCheck.bug(<<~EOS)
+        Exception while running `Offense#correct`:
+        ```
+        #{e.class}: #{e.message}
+          #{e.backtrace.join("\n  ")}
+        ```
+
+        Offense:
+        ```
+        #{JSON.pretty_generate(to_h)}
+        ```
+        Check options:
+        ```
+        #{check.options.pretty_inspect}
+        ```
+        Markup:
+        ```
+        #{markup}
+        ```
+        Node.Markup:
+        ```
+        #{node&.markup}
+        ```
+      EOS
+      exit(2)
     end
 
     def whole_theme?

data/lib/theme_check/regex_helpers.rb

@@ -5,6 +5,7 @@ module ThemeCheck
     LIQUID_TAG = /#{Liquid::TagStart}.*?#{Liquid::TagEnd}/om
     LIQUID_VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
     LIQUID_TAG_OR_VARIABLE = /#{LIQUID_TAG}|#{LIQUID_VARIABLE}/om
+    HTML_LIQUID_PLACEHOLDER = /≬[0-9a-z]+#*≬/m
     START_OR_END_QUOTE = /(^['"])|(['"]$)/
 
     def matches(s, re)
@@ -16,20 +17,5 @@ module ThemeCheck
       end
       matches
     end
-
-    def href_to_file_size(href)
-      # asset_url (+ optional stylesheet_tag) variables
-      if href =~ /^#{LIQUID_VARIABLE}$/o && href =~ /asset_url/ && href =~ Liquid::QuotedString
-        asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
-        asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
-        return if asset.nil?
-        asset.gzipped_size
-
-      # remote URLs
-      elsif href =~ %r{^(https?:)?//}
-        asset = RemoteAssetFile.from_src(href)
-        asset.gzipped_size
-      end
-    end
   end
 end

data/lib/theme_check/template.rb

@@ -3,10 +3,11 @@
 module ThemeCheck
   class Template < ThemeFile
     def write
-      content = updated_content
+      content = rewriter.to_s
       if source != content
-        @storage.write(@relative_path, content)
+        @storage.write(@relative_path, content.gsub("\n", @eol))
         @source = content
+        @rewriter = nil
       end
     end
 
@@ -26,19 +27,8 @@ module ThemeCheck
       name.start_with?('snippets')
     end
 
-    def lines
-      # Retain trailing newline character
-      @lines ||= source.split("\n", -1)
-    end
-
-    # Not entirely obvious but lines is mutable, corrections are to be
-    # applied on @lines.
-    def updated_content
-      lines.join("\n")
-    end
-
-    def excerpt(line)
-      lines[line - 1].strip
+    def rewriter
+      @rewriter ||= TemplateRewriter.new(@relative_path, source)
     end
 
     def source_excerpt(line)
@@ -46,10 +36,6 @@ module ThemeCheck
       original_lines[line - 1].strip
     end
 
-    def full_line(line)
-      lines[line - 1]
-    end
-
     def parse
       @ast ||= self.class.parse(source)
     end

data/lib/theme_check/template_rewriter.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'parser'
+
+module ThemeCheck
+  class TemplateRewriter
+    def initialize(name, source)
+      @buffer = Parser::Source::Buffer.new(name, source: source)
+      @rewriter = Parser::Source::TreeRewriter.new(
+        @buffer
+      )
+    end
+
+    def insert_before(node, content)
+      @rewriter.insert_before(
+        range(node.start_index, node.end_index),
+        content
+      )
+    end
+
+    def insert_after(node, content)
+      @rewriter.insert_after(
+        range(node.start_index, node.end_index),
+        content
+      )
+    end
+
+    def replace(node, content)
+      @rewriter.replace(
+        range(node.start_index, node.end_index),
+        content
+      )
+    end
+
+    def wrap(node, insert_before, insert_after)
+      @rewriter.wrap(
+        range(node.start_index, node.end_index),
+        insert_before,
+        insert_after,
+      )
+    end
+
+    def to_s
+      @rewriter.process
+    end
+
+    private
+
+    def range(start_index, end_index)
+      Parser::Source::Range.new(
+        @buffer,
+        start_index,
+        end_index,
+      )
+    end
+  end
+end

data/lib/theme_check/theme_file.rb

@@ -6,6 +6,8 @@ module ThemeCheck
     def initialize(relative_path, storage)
       @relative_path = relative_path
       @storage = storage
+      @source = nil
+      @eol = "\n"
     end
 
     def path
@@ -20,8 +22,23 @@ module ThemeCheck
       relative_path.sub_ext('').to_s
     end
 
+    # For the corrector to work properly, we should have a
+    # simple mental model of the internal representation of eol
+    # characters (Windows uses \r\n, Linux uses \n).
+    #
+    # Parser::Source::Buffer strips the \r from the source file, so if
+    # you are autocorrecting the file you might lose that info and
+    # cause a git diff. It also makes the node.start_index/end_index
+    # calculation break. That's not cool.
+    #
+    # So in here we track whether the source file has \r\n in it and
+    # we'll make sure that the file we write has the same eol as the
+    # source file.
     def source
-      @source ||= @storage.read(@relative_path)
+      return @source if @source
+      @source = @storage.read(@relative_path)
+      @eol = @source.include?("\r\n") ? "\r\n" : "\n"
+      @source = @source.gsub("\r\n", "\n")
     end
 
     def json?

data/lib/theme_check/version.rb

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

data/lib/theme_check.rb

@@ -34,6 +34,7 @@ require_relative "theme_check/string_helpers"
 require_relative "theme_check/file_system_storage"
 require_relative "theme_check/in_memory_storage"
 require_relative "theme_check/tags"
+require_relative "theme_check/template_rewriter"
 require_relative "theme_check/template"
 require_relative "theme_check/theme"
 require_relative "theme_check/visitor"

data/theme-check.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency('liquid', '>= 5.0.1')
   spec.add_dependency('nokogiri', '>= 1.12')
+  spec.add_dependency('parser', '~> 3')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: 
 email:
 - marcandre.cournoyer@shopify.com
@@ -229,6 +243,7 @@ files:
 - lib/theme_check/string_helpers.rb
 - lib/theme_check/tags.rb
 - lib/theme_check/template.rb
+- lib/theme_check/template_rewriter.rb
 - lib/theme_check/theme.rb
 - lib/theme_check/theme_file.rb
 - lib/theme_check/version.rb