theme-check 0.1.0

data/lib/theme_check/checks.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class Checks < Array
+    def call(method, *args)
+      each do |check|
+        if check.respond_to?(method) && !check.ignored?
+          check.send(method, *args)
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/checks/convert_include_to_render.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Recommends replacing `include` for `render`
+  class ConvertIncludeToRender < LiquidCheck
+    severity :suggestion
+    category :liquid
+    doc "https://shopify.dev/docs/themes/liquid/reference/tags/deprecated-tags#include"
+
+    def on_include(node)
+      add_offense("`include` is deprecated - convert it to `render`", node: node)
+    end
+  end
+end

data/lib/theme_check/checks/default_locale.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class DefaultLocale < JsonCheck
+    severity :suggestion
+    category :translation
+
+    def on_end
+      return if @theme.default_locale_json
+      add_offense("Default translation file not found (for example locales/en.default.json)")
+    end
+  end
+end

data/lib/theme_check/checks/liquid_tag.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Recommends using {% liquid ... %} if 3 or more consecutive {% ... %} are found.
+  class LiquidTag < LiquidCheck
+    severity :suggestion
+    category :liquid
+    doc "https://shopify.dev/docs/themes/liquid/reference/tags/theme-tags#liquid"
+
+    def initialize(min_consecutive_statements: 10)
+      @first_statement = nil
+      @consecutive_statements = 0
+      @min_consecutive_statements = min_consecutive_statements
+    end
+
+    def on_tag(node)
+      if !node.inside_liquid_tag?
+        reset_consecutive_statements
+      # Ignore comments
+      elsif !node.comment?
+        increment_consecutive_statements(node)
+      end
+    end
+
+    def on_string(node)
+      # Only reset the counter on outputted strings, and ignore empty line-breaks
+      if node.parent.block? && !node.value.strip.empty?
+        reset_consecutive_statements
+      end
+    end
+
+    def after_document(_node)
+      reset_consecutive_statements
+    end
+
+    def increment_consecutive_statements(node)
+      @first_statement ||= node
+      @consecutive_statements += 1
+    end
+
+    def reset_consecutive_statements
+      if @consecutive_statements >= @min_consecutive_statements
+        add_offense("Use {% liquid ... %} to write multiple tags", node: @first_statement)
+      end
+      @first_statement = nil
+      @consecutive_statements = 0
+    end
+  end
+end

data/lib/theme_check/checks/matching_schema_translations.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class MatchingSchemaTranslations < LiquidCheck
+    severity :suggestion
+    category :translation
+
+    def on_schema(node)
+      schema = JSON.parse(node.value.nodelist.join)
+
+      # Get all locales used in the schema
+      used_locales = Set.new([theme.default_locale])
+      visit_object(schema) do |_, locales|
+        used_locales += locales
+      end
+      used_locales = used_locales.to_a
+
+      # Check all used locales are defined in each localized keys
+      visit_object(schema) do |key, locales|
+        missing = used_locales - locales
+        if missing.any?
+          add_offense("#{key} missing translations for #{missing.join(', ')}", node: node)
+        end
+      end
+
+      check_locales(schema["locales"], node: node)
+
+    rescue JSON::ParserError
+      # Ignored, handled in ValidSchema.
+    end
+
+    private
+
+    def check_locales(locales, node:)
+      return unless locales.is_a?(Hash)
+
+      default_locale = locales[theme.default_locale]
+      if default_locale
+        locales.each_pair do |name, content|
+          diff = LocaleDiff.new(default_locale, content)
+          diff.add_as_offenses(self, key_prefix: ["locales", name], node: node)
+        end
+      else
+        add_offense("Missing default locale in key: locales", node: node)
+      end
+    end
+
+    def visit_object(object, top_path = [], &block)
+      return unless object.is_a?(Hash)
+      top_path += [object["id"]] if object["id"].is_a?(String)
+
+      object.each_pair do |key, value|
+        path = top_path + [key]
+
+        case value
+        when Array
+          value.each do |item|
+            visit_object(item, path, &block)
+          end
+
+        when Hash
+          # Localized key
+          if value[theme.default_locale].is_a?(String)
+            block.call(path.join("."), value.keys)
+          # Nested keys
+          else
+            visit_object(value, path, &block)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/checks/matching_translations.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  class MatchingTranslations < JsonCheck
+    severity :suggestion
+    category :translation
+
+    def initialize
+      @files = []
+    end
+
+    def on_file(file)
+      return unless file.name.starts_with?("locales/")
+      return unless file.content.is_a?(Hash)
+      return if file.name == @theme.default_locale_json&.name
+
+      @files << file
+    end
+
+    def on_end
+      return unless @theme.default_locale_json&.content
+
+      @files.each do |file|
+        diff = LocaleDiff.new(@theme.default_locale_json.content, file.content)
+        diff.add_as_offenses(self, template: file)
+      end
+    end
+  end
+end

data/lib/theme_check/checks/missing_required_template_files.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  # Reports missing shopify required theme files
+  # required templates: https://shopify.dev/tutorials/review-theme-store-requirements-files
+
+  class MissingRequiredTemplateFiles < LiquidCheck
+    severity :error
+    category :liquid
+    doc "https://shopify.dev/docs/themes/theme-templates"
+
+    LAYOUT_FILENAME = "layout/theme"
+    REQUIRED_TEMPLATES_FILES = %w(index product collection cart blog article page list-collections search 404
+                                  gift_card customers/account customers/activate_account customers/addresses
+                                  customers/login customers/order customers/register customers/reset_password password)
+      .map { |file| "templates/#{file}" }
+
+    def on_end
+      missing_files = (REQUIRED_TEMPLATES_FILES + [LAYOUT_FILENAME]) - theme.liquid.map(&:name)
+      missing_files.each { |file| add_missing_file_offense(file) }
+    end
+
+    private
+
+    def add_missing_file_offense(file)
+      add_offense("Theme is missing '#{file}.liquid' file")
+    end
+  end
+end

data/lib/theme_check/checks/missing_template.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports missing include/render/section template
+  class MissingTemplate < LiquidCheck
+    severity :suggestion
+    category :liquid
+
+    def on_include(node)
+      template = node.value.template_name_expr
+      if template.is_a?(String)
+        unless theme["snippets/#{template}"]
+          add_offense("'snippets/#{template}.liquid' is not found", node: node)
+        end
+      end
+    end
+    alias_method :on_render, :on_include
+
+    def on_section(node)
+      template = node.value.section_name
+      unless theme["sections/#{template}"]
+        add_offense("'sections/#{template}.liquid' is not found", node: node)
+      end
+    end
+  end
+end

data/lib/theme_check/checks/nested_snippet.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports deeply nested {% include ... %} or {% render ... %}
+  class NestedSnippet < LiquidCheck
+    severity :suggestion
+    category :liquid
+
+    class TemplateInfo < Struct.new(:includes)
+      def with_deep_nested(templates, max, current_level = 0)
+        includes.each do |node|
+          if current_level >= max
+            yield node
+          else
+            template_name = "snippets/#{node.value.template_name_expr}"
+            templates[template_name]
+              &.with_deep_nested(templates, max, current_level + 1) { yield node }
+          end
+        end
+      end
+    end
+
+    def initialize(max_nesting_level: 2)
+      @max_nesting_level = max_nesting_level
+      @templates = {}
+    end
+
+    def on_document(node)
+      @templates[node.template.name] = TemplateInfo.new(Set.new)
+    end
+
+    def on_include(node)
+      if node.value.template_name_expr.is_a?(String)
+        @templates[node.template.name].includes << node
+      end
+    end
+    alias_method :on_render, :on_include
+
+    def on_end
+      @templates.each_pair do |_, info|
+        info.with_deep_nested(@templates, @max_nesting_level) do |node|
+          add_offense("Too many nested snippets", node: node)
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/checks/required_directories.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports missing shopify required directories
+
+  class RequiredDirectories < LiquidCheck
+    severity :error
+    category :liquid
+    doc "https://shopify.dev/tutorials/develop-theme-files"
+
+    REQUIRED_DIRECTORIES = %w(assets config layout locales sections snippets templates)
+
+    def on_end
+      directories = theme.directories.map(&:to_s)
+      missing_directories = REQUIRED_DIRECTORIES - directories
+      missing_directories.each { |d| add_missing_directories_offense(d) }
+    end
+
+    private
+
+    def add_missing_directories_offense(directory)
+      add_offense("Theme is missing '#{directory}' directory")
+    end
+  end
+end

data/lib/theme_check/checks/required_layout_theme_object.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports missing content_for_header and content_for_layout in theme.liquid
+  class RequiredLayoutThemeObject < LiquidCheck
+    severity :error
+    category :liquid
+    doc "https://shopify.dev/docs/themes/theme-templates/theme-liquid"
+
+    LAYOUT_FILENAME = "layout/theme"
+
+    def initialize
+      @content_for_layout_found = false
+      @content_for_header_found = false
+    end
+
+    def on_document(node)
+      @layout_theme_node = node if node.template.name == LAYOUT_FILENAME
+    end
+
+    def on_variable(node)
+      return unless node.value.name.is_a?(Liquid::VariableLookup)
+
+      @content_for_header_found ||= node.value.name.name == "content_for_header"
+      @content_for_layout_found ||= node.value.name.name == "content_for_layout"
+    end
+
+    def after_document(node)
+      return unless node.template.name == LAYOUT_FILENAME
+
+      add_missing_object_offense("content_for_layout") unless @content_for_layout_found
+      add_missing_object_offense("content_for_header") unless @content_for_header_found
+    end
+
+    private
+
+    def add_missing_object_offense(name)
+      add_offense("#{LAYOUT_FILENAME} must include {{#{name}}}", node: @layout_theme_node)
+    end
+  end
+end

data/lib/theme_check/checks/space_inside_braces.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Ensure {% ... %} & {{ ... }} have consistent spaces.
+  class SpaceInsideBraces < LiquidCheck
+    severity :style
+    category :liquid
+
+    def initialize
+      @ignore = false
+    end
+
+    def on_node(node)
+      return unless node.markup
+
+      outside_of_strings(node.markup) do |chunk|
+        chunk.scan(/([,:])  +/) do |_match|
+          add_offense("Too many spaces after '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+        end
+        chunk.scan(/([,:])\S/) do |_match|
+          add_offense("Space missing after '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+        end
+      end
+    end
+
+    def on_tag(node)
+      if node.inside_liquid_tag?
+        markup = if node.whitespace_trimmed?
+          "-%}"
+        else
+          "%}"
+        end
+        if node.markup[-1] != " " && node.markup[-1] != "\n"
+          add_offense("Space missing before '#{markup}'", node: node, markup: node.markup[-1] + markup)
+        elsif node.markup =~ /(\n?)(  +)\z/m && Regexp.last_match(1) != "\n"
+          add_offense("Too many spaces before '#{markup}'", node: node, markup: Regexp.last_match(2) + markup)
+        end
+      end
+      @ignore = true
+    end
+
+    def after_tag(_node)
+      @ignore = false
+    end
+
+    def on_variable(node)
+      return if @ignore
+      if node.markup[0] != " "
+        add_offense("Space missing after '{{'", node: node)
+      elsif node.markup[-1] != " "
+        add_offense("Space missing before '}}'", node: node)
+      elsif node.markup[1] == " "
+        add_offense("Too many spaces after '{{'", node: node)
+      elsif node.markup[-2] == " "
+        add_offense("Too many spaces before '}}'", node: node)
+      end
+    end
+  end
+end

data/lib/theme_check/checks/syntax_error.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Report Liquid syntax errors
+  class SyntaxError < LiquidCheck
+    severity :error
+    category :liquid
+
+    def on_document(node)
+      node.template.warnings.each do |warning|
+        add_exception_as_offense(warning, template: node.template)
+      end
+    end
+
+    def on_error(exception)
+      add_exception_as_offense(exception, template: theme[exception.template_name])
+    end
+
+    private
+
+    def add_exception_as_offense(exception, template:)
+      add_offense(
+        exception.to_s(false).sub(/ in ".*"$/, ''),
+        line_number: exception.line_number,
+        markup: exception.markup_context&.sub(/^in "(.*)"$/, '\1'),
+        template: template,
+      )
+    end
+  end
+end