theme-check 0.1.0

data/data/shopify_liquid/filters.yml

@@ -0,0 +1,174 @@
+---
+Liquid::StandardFilters:
+- url_encode
+- where
+- uniq
+- escape
+- replace
+- remove
+- h
+- upcase
+- downcase
+- capitalize
+- date
+- last
+- split
+- size
+- append
+- reverse
+- join
+- concat
+- prepend
+- escape_once
+- url_decode
+- truncatewords
+- strip_html
+- strip
+- lstrip
+- rstrip
+- strip_newlines
+- plus
+- sort_natural
+- compact
+- replace_first
+- remove_first
+- newline_to_br
+- minus
+- divided_by
+- at_least
+- at_most
+- sort
+- default
+- modulo
+- slice
+- abs
+- map
+- floor
+- ceil
+- round
+- truncate
+- first
+- times
+FormFilter:
+- payment_button
+- payment_terms
+- installments_pricing
+- default_errors
+DateFilter:
+- date
+I18nFilter:
+- translate
+- t
+- date
+- sentence
+- time_tag
+UrlFilter:
+- image_url
+- stylesheet_tag
+- script_tag
+- img_tag
+- shopify_asset_url
+- payment_type_img_url
+- payment_type_svg_tag
+- placeholder_svg_tag
+- link_to
+- asset_url
+- img_url
+- asset_img_url
+- global_asset_url
+- file_url
+- file_img_url
+- product_img_url
+- collection_img_url
+- article_img_url
+JsonFilter:
+- json
+ColorFilter:
+- color_contrast
+- color_difference
+- brightness_difference
+- hex_to_rgba
+- color_to_rgb
+- color_to_hsl
+- color_to_hex
+- color_extract
+- color_brightness
+- color_modify
+- color_lighten
+- color_darken
+- color_saturate
+- color_desaturate
+- color_mix
+MoneyFilter:
+- money_without_currency
+- money_without_trailing_zeros
+- money
+- money_with_currency
+StringFilter:
+- handleize
+- url_param_escape
+- url_escape
+- camelcase
+- camelize
+- encode_url_component
+- format_code
+- md5
+- handle
+CollectionFilter:
+- within
+- link_to_vendor
+- url_for_vendor
+- link_to_type
+- url_for_type
+- sort_by
+TagFilter:
+- link_to_add_tag
+- link_to_remove_tag
+- link_to_tag
+- highlight_active_tag
+CryptoFilter:
+- hmac_sha1
+- sha256
+- hmac_sha256
+- md5
+- sha1
+CustomerAccountFilter:
+- customer_login_link
+- customer_logout_link
+- customer_register_link
+- recover_password_link
+- delete_customer_address_link
+- edit_customer_address_link
+- cancel_customer_order_link
+CurrencyFormFilter:
+- currency_selector
+PaginationFilter:
+- default_pagination
+WeightFilter:
+- weight
+- weight_with_unit
+- unit
+TextFilter:
+- pad_spaces
+- paragraphize
+- highlight
+- format_address
+- excerpt
+- pluralize
+FontFilter:
+- font_face
+- font_url
+- font_modify
+DistanceFilter:
+- distance_from
+MediaFilter:
+- external_video_url
+- external_video_tag
+- video_tag
+- model_viewer_tag
+- media_tag
+ThemeFilter:
+- theme_url
+- link_to_theme
+DebugFilter:
+- debug

data/data/shopify_liquid/objects.yml

@@ -0,0 +1,81 @@
+---
+- additional_checkout_buttons
+- address
+- all_country_option_tags
+- all_products
+- article
+- articles
+- block
+- blog
+- blogs
+- canonical_url
+- cart
+- checkout
+- collection
+- collections
+- comment
+- content_for_additional_checkout_buttons
+- content_for_header
+- content_for_index
+- content_for_layout
+- country_option_tags
+- currency
+- current_page
+- current_tags
+- customer
+- customer_address
+- discount_allocation
+- discount_application
+- external_video
+- font
+- forloop
+- form
+- fulfillment
+- gift_card
+- handle
+- image
+- images
+- line_item
+- link
+- linklist
+- linklists
+- location
+- metafield
+- model
+- model_source
+- order
+- page
+- page_description
+- page_image
+- page_title
+- pages
+- paginate
+- part
+- policy
+- powered_by_link
+- product
+- product_option
+- recommendations
+- request
+- routes
+- script
+- scripts
+- search
+- section
+- selling_plan
+- selling_plan_allocation
+- selling_plan_group
+- settings
+- shipping_method
+- shop
+- shop_locale
+- store_availability
+- tablerow
+- tax_line
+- template
+- theme
+- transaction
+- unit_price_measurement
+- variant
+- video
+- video_source

data/dev.yml

@@ -0,0 +1,23 @@
+name: theme-check
+
+type: ruby
+
+up:
+  - ruby: 2.7.1
+  - bundler
+
+commands:
+  check:
+    desc: 'Check a theme'
+    syntax:
+      argument: file
+    run: bundle exec theme-check
+  test:
+    syntax:
+      argument: file
+      optional: args...
+    run: bundle exec rake test
+  style:
+    run: bundle exec rake rubocop
+  language-server:
+    run: bundle exec theme-check-language-server

data/exe/theme-check

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "theme_check"
+
+ThemeCheck::Cli.new.run!(ARGV)

data/exe/theme-check-language-server

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'theme_check'
+
+if ENV["THEME_CHECK_DEBUG"] == "true"
+  $DEBUG = true
+end
+# Force encoding to UTF-8 to fix VSCode
+Encoding.default_external = Encoding::UTF_8
+status_code = ThemeCheck::LanguageServer.start
+exit! status_code

data/lib/theme_check.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require "liquid"
+
+require_relative "theme_check/analyzer"
+require_relative "theme_check/check"
+require_relative "theme_check/checks_tracking"
+require_relative "theme_check/cli"
+require_relative "theme_check/liquid_check"
+require_relative "theme_check/locale_diff"
+require_relative "theme_check/json_check"
+require_relative "theme_check/json_file"
+require_relative "theme_check/json_helpers"
+require_relative "theme_check/language_server"
+require_relative "theme_check/checks"
+require_relative "theme_check/config"
+require_relative "theme_check/node"
+require_relative "theme_check/offense"
+require_relative "theme_check/printer"
+require_relative "theme_check/shopify_liquid"
+require_relative "theme_check/tags"
+require_relative "theme_check/template"
+require_relative "theme_check/theme"
+require_relative "theme_check/visitor"
+
+Dir[__dir__ + "/theme_check/checks/*.rb"].each { |file| require file }

data/lib/theme_check/analyzer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class Analyzer
+    attr_reader :offenses
+
+    def initialize(theme, checks = Check.all.map(&:new))
+      @theme = theme
+      @offenses = []
+
+      @liquid_checks = Checks.new
+      @json_checks = Checks.new
+
+      checks.each do |check|
+        check.theme = @theme
+        check.offenses = @offenses
+
+        case check
+        when LiquidCheck
+          @liquid_checks << check
+        when JsonCheck
+          @json_checks << check
+        end
+      end
+
+      @visitor = Visitor.new(@liquid_checks)
+    end
+
+    def analyze_theme
+      @offenses.clear
+      @theme.liquid.each { |template| @visitor.visit_template(template) }
+      @theme.json.each { |json_file| @json_checks.call(:on_file, json_file) }
+      @liquid_checks.call(:on_end)
+      @json_checks.call(:on_end)
+      @offenses
+    end
+
+    def analyze_file(path)
+      path = Pathname.new(path)
+      analyze_theme
+      @offenses.reject! { |offense| offense.template.path != path }
+    end
+  end
+end

data/lib/theme_check/check.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+require_relative "json_helpers"
+
+module ThemeCheck
+  class Check
+    include JsonHelpers
+
+    attr_accessor :theme
+    attr_accessor :offenses
+    attr_accessor :options
+
+    SEVERITIES = [
+      :error,
+      :suggestion,
+      :style,
+    ]
+
+    CATEGORIES = [
+      :liquid,
+      :translation,
+      :json,
+    ]
+
+    class << self
+      def all
+        @all ||= []
+      end
+
+      def severity(severity = nil)
+        if severity
+          unless SEVERITIES.include?(severity)
+            raise ArgumentError, "unknown severity. Use: #{SEVERITIES.join(', ')}"
+          end
+          @severity = severity
+        end
+        @severity if defined?(@severity)
+      end
+
+      def category(category = nil)
+        if category
+          unless CATEGORIES.include?(category)
+            raise ArgumentError, "unknown category. Use: #{CATEGORIES.join(', ')}"
+          end
+          @category = category
+        end
+        @category if defined?(@category)
+      end
+
+      def doc(doc = nil)
+        @doc = doc if doc
+        @doc if defined?(@doc)
+      end
+    end
+
+    def severity
+      self.class.severity
+    end
+
+    def category
+      self.class.category
+    end
+
+    def doc
+      self.class.doc
+    end
+
+    def code_name
+      self.class.name.demodulize
+    end
+
+    def ignore!
+      @ignored = true
+    end
+
+    def unignore!
+      @ignored = false
+    end
+
+    def ignored?
+      defined?(@ignored) && @ignored
+    end
+
+    def to_s
+      s = +"#{code_name}:\n"
+      properties = { severity: severity, category: category, doc: doc }.merge(options)
+      properties.each_pair do |name, value|
+        s << "  #{name}: #{value}\n" if value
+      end
+      s
+    end
+  end
+end