theme-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 037f9fd0dba35bf611162475709aef96e0e24c8e63b18eac3ad20b4d65d37255
+  data.tar.gz: b856c24c2135a805c91c230d1c3a2e0dc178d4f0249faa77bb9a2c263993dbd2
+SHA512:
+  metadata.gz: 1f4cafab1d1a3adf53771682f0faf00b1a327dc3a358a60157a92a3c7625636ce38eb266a271d01891cae0786c0f4c38c35a3ed03cd34d1b9deb7bb86197ba41
+  data.tar.gz: cc0b7f5d9878c74b19a500d93cb873e0e17610134cb99fee832d1c31e20d6e6d805b494c44897e4d590d7b4c9bec99bb95b10b511d3fa0a13d7e1813035071a1

data/.github/probots.yml

@@ -0,0 +1,3 @@
+# .github/probots.yml
+enabled:
+  - cla

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

@@ -0,0 +1,28 @@
+name: ThemeCheck
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('Gemfile') }}
+        restore-keys: ${{ runner.os }}-gems-
+    - name: Install dependencies
+      run: bundle install --jobs=3 --retry=3 --path=vendor/bundle
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+Gemfile.lock
+
+.rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml

data/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_from:
+  - 'https://shopify.github.io/ruby-style-guide/rubocop.yml'
+
+require: rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'vendor/bundle/**/*'
+
+Metrics/MethodLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opensource@shopify.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,132 @@
+# Contributing to Theme Check
+
+We love receiving pull requests!
+
+## Standards
+
+* Checks should do one thing, and do it well.
+* PR should explain what the feature does, and why the change exists.
+* PR should include any carrier specific documentation explaining how it works.
+* Code _must_ be tested.
+* Be consistent. Write clean code that follows [Ruby community standards](https://github.com/bbatsov/ruby-style-guide).
+* Code should be generic and reusable.
+
+## How to contribute
+
+1. Fork it ( https://github.com/Shopify/theme-check/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Running Tests
+
+```
+bundle install # Or `dev up` if you're from Shopify
+bundle exec rake
+```
+
+## Checking a theme
+
+```
+bundle exec theme-check /path/to/your/theme
+```
+
+## Creating a new "Check"
+
+Under `lib/theme_check/checks`, create new Ruby file with a unique name describing what you want to check for.
+
+```ruby
+module ThemeCheck
+  # Does one thing, and does it well!
+  # NOTE: inherit from JsonCheck to implement a JSON based check.
+  class MyCheckName < LiquidCheck
+    severity :suggestion # :error or :style
+    doc "https://..."    # Optional link to doc
+
+    def on_document(node)
+      # Called with the root node of all templates
+      node.value    # is the original Liquid object for this node. See Liquid source code for details.
+      node.template # is the template being analyzed, See lib/theme_check/template.rb.
+      node.parent   # is the parent node.
+      node.children # are the children nodes.
+      # See lib/theme_check/node.rb for more helper methods
+      theme # Gives you access to all the templates in the theme. See lib/theme_check/theme.rb.
+    end
+
+    def on_node(node)
+      # Called for every node
+    end
+
+    def on_tag(node)
+      # Called for each tag (if, include, for, assign, etc.)
+    end
+
+    def after_tag(node)
+      # Called after the tag children have been visited
+      
+      # If you find an issue, add an offense:
+      add_offense("Describe the problem...", node: node)
+      # Or, if the offense is related to the whole template:
+      add_offense("Describe the problem...", template: node.template)
+    end
+
+    def on_assign(node)
+      # Called only for {% assign ... %} tags
+    end
+
+    def on_string(node)
+      # Called for every `String` (including inside if conditions).
+      if node.parent.block?
+        # If parent is a block, `node.value` is a String written directly to the output when
+        # the template is rendered.
+      end
+    end
+
+    def on_error(exception)
+      # Called each time a Liquid exception is raised while parsing the template
+    end
+
+    def on_end
+      # A special callback after we're done visiting all the templates
+    end
+
+    # Each type of node has a corresponding `on_node_class_name` & `after_node_class_name`
+    # A few common examples:
+    # on_block_body(node)
+    # on_capture(node)
+    # on_case(node)
+    # on_comment(node)
+    # on_condition(node)
+    # on_document(node)
+    # on_else_condition(node)
+    # on_for(node)
+    # on_form(node)
+    # on_if(node)
+    # on_include(node)
+    # on_integer(node)
+    # on_layout(node)
+    # on_method_literal(node)
+    # on_paginate(node)
+    # on_range(node)
+    # on_render(node)
+    # on_schema(node)
+    # on_section(node)
+    # on_style(node)
+    # on_unless(node)
+    # on_variable(node)
+    # on_variable_lookup(node)
+  end
+end
+```
+
+Add the new check to `config/default.yml` to enable it.
+
+```yaml
+MyCheckName:
+  enabled: true
+```
+
+Add a corresponding test file under `test/checks`.
+
+When done, run the tests with `dev test`.

data/Gemfile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in theme-check.gemspec
+gemspec
+
+gem 'bundler'
+gem 'rake'
+
+group :test do
+  gem 'minitest'
+  gem 'minitest-focus'
+  gem 'mocha'
+  gem 'pry-byebug'
+end
+
+group :development do
+  gem 'guard'
+  gem 'guard-minitest'
+end
+
+gem 'rubocop', '~> 0.93.1', require: false
+gem 'rubocop-performance', '~> 1.8.1', require: false
+gem 'rubocop-shopify', '~> 1.0.6', require: false

data/Guardfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+guard :minitest do
+  watch(%r{^test/(.*)_test.rb$})
+  watch(%r{^lib/theme_check/(.*)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$}) { 'test' }
+end

data/LICENSE.md

@@ -0,0 +1,8 @@
+
+Copyright 2020-present, Shopify Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Theme Check ✅ - A linter for Themes
+
+Think RuboCop, or eslint, but for Shopify themes.
+
+Theme Check is a command line tool that helps you follow Shopify Themes & Liquid best practices by analyzing the Liquid & JSON inside your theme.
+
+Theme Check is also available [inside some code editors](https://github.com/Shopify/theme-check/wiki).
+
+![](docs/preview.png)
+
+_Disclaimer: This tool is not supported as part of the Partners program._
+
+## Supported Checks
+
+Theme Check currently checks for the following:
+
+✅ Liquid syntax errors  
+✅ JSON syntax errors  
+✅ Missing snippet & section templates  
+✅ Unused `{% assign ... %}`  
+✅ Unused snippet templates  
+✅ Template length  
+✅ Deprecated tags  
+✅ Unknown tags  
+✅ Unknown filters  
+✅ Missing `{{ content_for_* }}` in `theme.liquid`  
+✅ Excessive nesting of snippets  
+✅ Missing or extra spaces inside `{% ... %}` and `{{ ... }}`  
+✅ Missing default locale file  
+✅ Unmatching translation keys in locale files  
+✅ Using unknown translation keys in `{{ 'missing_key' | t }}`  
+✅ Using several `{% ... %}` instead of `{% liquid ... %}`  
+✅ Undefined [objects](https://shopify.dev/docs/themes/liquid/reference/objects)
+
+And many more to come! Suggestions welcome ([create an issue](https://github.com/Shopify/theme-check/issues)).
+
+## Installation
+
+```
+gem install theme-check
+```
+
+## Usage
+
+```
+theme-check /path/to/your/theme
+
+# or from /path/to/your/theme
+theme-check
+```
+
+Run `theme-check --help` to get full usage.
+
+## Configuration
+
+Add a `.theme-check.yml` file at the root of your theme to configure:
+
+```yaml
+# If your theme is not using the supported directory structure, provide the root path
+# where to find the `templates/`, `sections/`, `snippets/` directories as they would
+# be uploaded to Shopify.
+root: dist
+
+# Disable some checks
+TemplateLength:
+  enabled: false
+  # Or configure options
+  max_length: 300
+```
+
+See [config/default.yml](config/default.yml) for available options & defaults.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require "rake/testtask"
+require "rubocop/rake_task"
+require "bundler/gem_tasks"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/bin/liquid-server

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+dev="/opt/dev/bin/dev"
+cd "$($dev project-path theme-check)"
+"$dev" language-server

data/config/default.yml

@@ -0,0 +1,63 @@
+ConvertIncludeToRender:
+  enabled: true
+
+LiquidTag:
+  enabled: true
+
+MissingTemplate:
+  enabled: true
+
+NestedSnippet:
+  enabled: true
+
+RequiredLayoutThemeObject:
+  enabled: true
+
+SpaceInsideBraces:
+  enabled: true
+
+SyntaxError:
+  enabled: true
+
+TemplateLength:
+  enabled: true
+  max_length: 200
+
+UnknownFilter:
+  enabled: true
+
+UnusedAssign:
+  enabled: true
+
+UnusedSnippet:
+  enabled: true
+
+MatchingSchemaTranslations:
+  enabled: true
+
+MatchingTranslations:
+  enabled: true
+
+DefaultLocale:
+  enabled: true
+
+TranslationKeyExists:
+  enabled: true
+
+ValidHTMLTranslation:
+  enabled: true
+
+ValidJson:
+  enabled: true
+
+ValidSchema:
+  enabled: true
+
+MissingRequiredTemplateFiles:
+  enabled: true
+
+UndefinedObject:
+  enabled: true
+
+RequiredDirectories:
+  enabled: true