theme-check 0.1.0

data/lib/theme_check/theme.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require "pathname"
+
+module ThemeCheck
+  class Theme
+    DEFAULT_LOCALE_REGEXP = %r{^locales/(.*)\.default$}
+    attr_reader :root
+
+    def initialize(root)
+      @root = Pathname.new(root)
+    end
+
+    def liquid
+      @liquid ||= @root.glob("**/*.liquid").map { |path| Template.new(path, @root) }
+    end
+
+    def json
+      @json ||= @root.glob("**/*.json").map { |path| JsonFile.new(path, @root) }
+    end
+
+    def default_locale_json
+      return @default_locale_json if defined?(@default_locale_json)
+      @default_locale_json = json.find do |json_file|
+        json_file.name.match?(DEFAULT_LOCALE_REGEXP)
+      end
+    end
+
+    def default_locale
+      if default_locale_json
+        default_locale_json.name[DEFAULT_LOCALE_REGEXP, 1]
+      else
+        "en"
+      end
+    end
+
+    def all
+      @all ||= json + liquid
+    end
+
+    def [](name)
+      all.find { |t| t.name == name }
+    end
+
+    def templates
+      liquid.select(&:template?)
+    end
+
+    def sections
+      liquid.select(&:section?)
+    end
+
+    def snippets
+      liquid.select(&:snippet?)
+    end
+
+    def directories
+      @directories ||= @root.glob('*').select { |f| File.directory?(f) }.map { |f| f.relative_path_from(@root) }
+    end
+  end
+end

data/lib/theme_check/version.rb

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

data/lib/theme_check/visitor.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class Visitor
+    def initialize(checks)
+      @checks = checks
+    end
+
+    def visit_template(template)
+      visit(Node.new(template.root, nil, template))
+    rescue Liquid::Error => exception
+      exception.template_name = template.name
+      call_checks(:on_error, exception)
+    end
+
+    def visit(node)
+      call_checks(:on_node, node)
+      call_checks(:on_tag, node) if node.tag?
+      call_checks(:"on_#{node.type_name}", node)
+      node.children.each { |child| visit(child) }
+      unless node.literal?
+        call_checks(:"after_#{node.type_name}", node)
+        call_checks(:after_tag, node) if node.tag?
+        call_checks(:after_node, node)
+      end
+    end
+
+    private
+
+    def visit_children(node)
+      node.children.each { |child| visit(child) }
+    end
+
+    def call_checks(method, *args)
+      @checks.call(method, *args)
+    end
+  end
+end

data/theme-check.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "theme_check/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "theme-check"
+  spec.version       = ThemeCheck::VERSION
+  spec.authors       = ["Marc-André Cournoyer"]
+  spec.email         = ["marcandre.cournoyer@shopify.com"]
+
+  spec.summary       = "A Shopify Theme Linter"
+  spec.homepage      = "https://github.com/Shopify/theme-check"
+  spec.license       = "MIT"
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    %x{git ls-files -z}.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('liquid', '>= 5')
+  spec.add_dependency('activesupport')
+  spec.add_dependency('nokogumbo')
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: theme-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marc-André Cournoyer
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogumbo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- marcandre.cournoyer@shopify.com
+executables:
+- theme-check
+- theme-check-language-server
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/probots.yml"
+- ".github/workflows/theme-check.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/liquid-server
+- config/default.yml
+- data/shopify_liquid/filters.yml
+- data/shopify_liquid/objects.yml
+- dev.yml
+- docs/preview.png
+- exe/theme-check
+- exe/theme-check-language-server
+- lib/theme_check.rb
+- lib/theme_check/analyzer.rb
+- lib/theme_check/check.rb
+- lib/theme_check/checks.rb
+- lib/theme_check/checks/convert_include_to_render.rb
+- lib/theme_check/checks/default_locale.rb
+- lib/theme_check/checks/liquid_tag.rb
+- lib/theme_check/checks/matching_schema_translations.rb
+- lib/theme_check/checks/matching_translations.rb
+- lib/theme_check/checks/missing_required_template_files.rb
+- lib/theme_check/checks/missing_template.rb
+- lib/theme_check/checks/nested_snippet.rb
+- lib/theme_check/checks/required_directories.rb
+- lib/theme_check/checks/required_layout_theme_object.rb
+- lib/theme_check/checks/space_inside_braces.rb
+- lib/theme_check/checks/syntax_error.rb
+- lib/theme_check/checks/template_length.rb
+- lib/theme_check/checks/translation_key_exists.rb
+- lib/theme_check/checks/undefined_object.rb
+- lib/theme_check/checks/unknown_filter.rb
+- lib/theme_check/checks/unused_assign.rb
+- lib/theme_check/checks/unused_snippet.rb
+- lib/theme_check/checks/valid_html_translation.rb
+- lib/theme_check/checks/valid_json.rb
+- lib/theme_check/checks/valid_schema.rb
+- lib/theme_check/checks_tracking.rb
+- lib/theme_check/cli.rb
+- lib/theme_check/config.rb
+- lib/theme_check/json_check.rb
+- lib/theme_check/json_file.rb
+- lib/theme_check/json_helpers.rb
+- lib/theme_check/language_server.rb
+- lib/theme_check/language_server/handler.rb
+- lib/theme_check/language_server/server.rb
+- lib/theme_check/liquid_check.rb
+- lib/theme_check/locale_diff.rb
+- lib/theme_check/node.rb
+- lib/theme_check/offense.rb
+- lib/theme_check/parsing_helpers.rb
+- lib/theme_check/printer.rb
+- lib/theme_check/shopify_liquid.rb
+- lib/theme_check/shopify_liquid/filter.rb
+- lib/theme_check/shopify_liquid/object.rb
+- lib/theme_check/tags.rb
+- lib/theme_check/template.rb
+- lib/theme_check/theme.rb
+- lib/theme_check/version.rb
+- lib/theme_check/visitor.rb
+- theme-check.gemspec
+homepage: https://github.com/Shopify/theme-check
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A Shopify Theme Linter
+test_files: []