theme-check 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e154c11ed7f84b968edac05c97afb2611e816933d790347cdbdca63071d46e88
-  data.tar.gz: dd8fc72c420412ab3adfad64f3d11197f562904bd0171289debe8e440ca34c86
+  metadata.gz: 9bfe8af624c0fe355dedcf6036609fc1366196011af2207b8365c0bb3389f3f5
+  data.tar.gz: 526353e93c6d8bc3bb902b24d81084c581cecdbd0bd98e29d9c1fd95ff00aff3
 SHA512:
-  metadata.gz: 0315a3eb75f5cda96fe2be02d7533e07aa364fc7b3e08bdb2682edf50f30d13bc2c03099d015c73db2e1c6e7d06c90707068d596db044176ddcdaea4bfe3a65c
-  data.tar.gz: a7050df945829d05a0440464d0ac309d3cc55d9fdd9909259b95f2405beae746e799aad8beeb564508b0a543568dcd718edb9638c1307bb345051784818ea165
+  metadata.gz: 49b583b1bbfa5fb7a59370ec6d09e6b1099ecf3ffa22a6fc55cf099fe26ab682637bf3c943c54786b0a36b80b20501491bb9623255af3323901d33f7cdbb8897
+  data.tar.gz: 02ed21413f0d437a77a8859cd7a4df76d296e4bf51f88c4470c8b9f74c89fefe32431cbb2658159fecc48bc79bdf4762f1db00bf21f2ff78fa81c239b29d765e

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

@@ -4,16 +4,16 @@ on: [push]
 
 jobs:
   test:
-    runs-on: macos-latest
+    runs-on: ${{ matrix.platform }}
 
     strategy:
       matrix:
+        platform: [ubuntu-latest, windows-latest]
         version:
           - 3.0.0
-          - 2.7.1
           - 2.6.6
 
-    name: Ruby ${{ matrix.version }}
+    name: Ruby ${{ matrix.platform }} ${{ matrix.version }}
 
     steps:
     - uses: actions/checkout@v2

data/.gitignore

@@ -12,3 +12,4 @@ Gemfile.lock
 
 .rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml
 packaging/builds
+.vscode

data/CHANGELOG.md

@@ -1,4 +1,17 @@
 
+v1.5.0 / 2021-09-07
+==================
+
+### Features
+
+  * Add [DeprecatedGlobalAppBlockType](docs/checks/deprecated_global_app_block_type.md) ([#402](https://github.com/shopify/theme-check/issues/402))
+
+### Fixes
+
+  * Add Windows CI
+  * Fix multiple Windows bugs ([#413](https://github.com/shopify/theme-check/issues/413), [#415](https://github.com/shopify/theme-check/issues/415))
+  * Fix pagination size as string bug in PaginationSize ([#417](https://github.com/shopify/theme-check/issues/417),  [#421](https://github.com/shopify/theme-check/issues/421))
+
 v1.4.0 / 2021-08-30
 ==================
 

data/config/default.yml

@@ -188,3 +188,6 @@ PaginationSize:
   ignore: []
   min_size: 1
   max_size: 50
+
+DeprecatedGlobalAppBlockType:
+  enabled: true

data/docs/checks/deprecated_global_app_block_type.md

@@ -0,0 +1,65 @@
+# Check for deprecated global app block type `@global`
+This check makes sure theme sections are not using [deprecated (`@global`)][change_log] global app block type.
+
+## Check Details
+In order for theme sections to [support app blocks][support_app_blocks_in_theme_section], sections need to define a block of type `@app`. This check makes sure that theme sections are not using the deprecated (`@global`) global app block type in theme sections.
+
+:-1: Example of **incorrect** theme section for this check:
+```
+{% for block in section.blocks %}
+  {% if block.type = "@global" %}
+    {% render block %}
+  {% endif %}
+{% endfor %}
+
+{% schema %}
+{
+  "name": "Product section",
+  "blocks": [{"type": "@global"}]
+}
+{% endschema %}
+```
+
+:+1: Examples of **correct** theme section for this check:
+```
+{% for block in section.blocks %}
+  {% if block.type = "@app" %}
+    {% render block %}
+  {% endif %}
+{% endfor %}
+
+{% schema %}
+{
+  "name": "Product section",
+  "blocks": [{"type": "@app"}]
+}
+{% endschema %}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+DeprecatedGlobalAppBlockType:
+  enabled: true
+```
+
+## When Not To Use It
+
+It is discouraged to disable this check.
+
+## Version
+
+This check has been introduced in Theme Check 1.5.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/theme_check/checks/deprecated_global_app_block_type.rb
+[docsource]: /docs/checks/deprecated_global_app_block_type.md
+[remote_asset]: /docs/checks/deprecated_global_app_block_type.md
+[support_app_blocks_in_theme_section]: https://shopify.dev/themes/migration#step-8-add-support-for-app-blocks-to-sections
+[change_log]: https://shopify.dev/changelog/removing-the-global-block-type-in-favour-of-the-app-block-type-in-theme-sections

data/lib/theme_check/checks/deprecated_global_app_block_type.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class DeprecatedGlobalAppBlockType < LiquidCheck
+    severity :error
+    category :liquid
+    doc docs_url(__FILE__)
+
+    INVALID_GLOBAL_APP_BLOCK_TYPE = "@global"
+    VALID_GLOBAL_APP_BLOCK_TYPE = "@app"
+
+    def on_schema(node)
+      schema = JSON.parse(node.value.nodelist.join)
+
+      if block_types_from(schema).include?(INVALID_GLOBAL_APP_BLOCK_TYPE)
+        add_offense(
+          "Deprecated '#{INVALID_GLOBAL_APP_BLOCK_TYPE}' block type defined in the schema, use '#{VALID_GLOBAL_APP_BLOCK_TYPE}' block type instead.",
+          node: node
+        )
+      end
+    rescue JSON::ParserError
+      # Ignored, handled in ValidSchema.
+    end
+
+    def on_case(node)
+      if node.value == INVALID_GLOBAL_APP_BLOCK_TYPE
+        report_offense(node)
+      end
+    end
+
+    def on_condition(node)
+      if node.value.right == INVALID_GLOBAL_APP_BLOCK_TYPE || node.value.left == INVALID_GLOBAL_APP_BLOCK_TYPE
+        report_offense(node)
+      end
+    end
+
+    def on_variable(node)
+      if node.value.name == INVALID_GLOBAL_APP_BLOCK_TYPE
+        report_offense(node)
+      end
+    end
+
+    private
+
+    def report_offense(node)
+      add_offense(
+        "Deprecated '#{INVALID_GLOBAL_APP_BLOCK_TYPE}' block type, use '#{VALID_GLOBAL_APP_BLOCK_TYPE}' block type instead.",
+        node: node
+      )
+    end
+
+    def block_types_from(schema)
+      schema.fetch("blocks", []).map do |block|
+        block.fetch("type", "")
+      end
+    end
+  end
+end

data/lib/theme_check/checks/pagination_size.rb

@@ -54,12 +54,11 @@ module ThemeCheck
     private
 
     def get_setting_default_value(setting_id)
-      setting = @schema_settings.select { |s| s['id'] == setting_id }
-      unless setting.empty?
-        return setting.last['default']
-      end
-      # Setting does not exist
-      nil
+      setting = @schema_settings.find { |s| s['id'] == setting_id }
+      return nil if setting.empty?
+      default_value = setting['default'].to_i
+      return nil if default_value == 0
+      default_value
     end
   end
 end

data/lib/theme_check/json_printer.rb

@@ -21,6 +21,7 @@ module ThemeCheck
             styleCount: path_offenses.count { |offense| offense[:severity] == Check::SEVERITY_VALUES[:style] },
           }
         end
+        .sort_by { |o| o[:path] }
     end
   end
 end

data/lib/theme_check/language_server/document_link_provider.rb

@@ -5,6 +5,7 @@ module ThemeCheck
     class DocumentLinkProvider
       include RegexHelpers
       include PositionHelper
+      include URIHelper
 
       class << self
         attr_accessor :partial_regexp, :destination_directory, :destination_postfix
@@ -63,7 +64,7 @@ module ThemeCheck
       end
 
       def file_link(partial)
-        "file://#{@storage.path(destination_directory + '/' + partial + destination_postfix)}"
+        file_uri(@storage.path(destination_directory + '/' + partial + destination_postfix))
       end
     end
   end

data/lib/theme_check/language_server/handler.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 require "benchmark"
-require "uri"
-require "cgi"
 
 module ThemeCheck
   module LanguageServer
     class Handler
+      include URIHelper
+
       CAPABILITIES = {
         completionProvider: {
           triggerCharacters: ['.', '{{ ', '{% '],
@@ -26,7 +27,7 @@ module ThemeCheck
       end
 
       def on_initialize(id, params)
-        @root_path = path_from_uri(params["rootUri"]) || params["rootPath"]
+        @root_path = root_path_from_params(params)
 
         # Tell the client we don't support anything if there's no rootPath
         return send_response(id, { capabilities: {} }) if @root_path.nil?
@@ -96,19 +97,23 @@ module ThemeCheck
       end
 
       def text_document_uri(params)
-        path_from_uri(params.dig('textDocument', 'uri'))
-      end
-
-      def path_from_uri(uri_string)
-        return if uri_string.nil?
-        uri = URI(uri_string)
-        CGI.unescape(uri.path)
+        file_path(params.dig('textDocument', 'uri'))
       end
 
       def relative_path_from_text_document_uri(params)
         @storage.relative_path(text_document_uri(params))
       end
 
+      def root_path_from_params(params)
+        root_uri = params["rootUri"]
+        root_path = params["rootPath"]
+        if root_uri
+          file_path(root_uri)
+        elsif root_path
+          root_path
+        end
+      end
+
       def text_document_text(params)
         params.dig('textDocument', 'text')
       end
@@ -174,7 +179,7 @@ module ThemeCheck
       def send_diagnostic(path, offenses)
         # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#notificationMessage
         send_notification('textDocument/publishDiagnostics', {
-          uri: "file://#{path}",
+          uri: file_uri(path),
           diagnostics: offenses.map { |offense| offense_to_diagnostic(offense) },
         })
       end

data/lib/theme_check/language_server/server.rb

@@ -25,6 +25,15 @@ module ThemeCheck
         @out = out_stream
         @err = err_stream
 
+        # Because programming is fun,
+        #
+        # Ruby on Windows turns \n into \r\n. Which means that \r\n
+        # gets turned into \r\r\n. Which means that the protocol
+        # breaks on windows unless we turn STDOUT into binary mode.
+        #
+        # Hours wasted: 9.
+        @out.binmode
+
         @out.sync = true # do not buffer
         @err.sync = true # do not buffer
 
@@ -52,19 +61,8 @@ module ThemeCheck
         response_body = JSON.dump(response)
         log(JSON.pretty_generate(response)) if $DEBUG
 
-        # Because programming is fun,
-        #
-        # Ruby on Windows turns \n into \r\n. Which means that \r\n
-        # gets turned into \r\r\n. Which means that the protocol
-        # breaks on windows unless we turn STDOUT into binary mode and
-        # set the encoding manually (yuk!) or we do this little hack
-        # here and put \n which gets transformed into \r\n on windows
-        # only...
-        #
-        # Hours wasted: 8.
-        eol = Gem.win_platform? ? "\n" : "\r\n"
-        @out.write("Content-Length: #{response_body.bytesize}#{eol}")
-        @out.write(eol)
+        @out.write("Content-Length: #{response_body.bytesize}\r\n")
+        @out.write("\r\n")
         @out.write(response_body)
         @out.flush
       end

data/lib/theme_check/language_server/uri_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "benchmark"
+require "uri"
+require "cgi"
+
+module ThemeCheck
+  module LanguageServer
+    module URIHelper
+      # Will URI.encode a string the same way VS Code would. There are two things
+      # to watch out for:
+      #
+      # 1. VS Code still uses the outdated '%20' for spaces
+      # 2. VS Code prefixes Windows paths with / (so /C:/Users/... is expected)
+      #
+      # Exists because of https://github.com/Shopify/theme-check/issues/360
+      def file_uri(absolute_path)
+        "file://" + absolute_path
+          .to_s
+          .split('/')
+          .map { |x| CGI.escape(x).gsub('+', '%20') }
+          .join('/')
+          .sub(%r{^/?}, '/') # Windows paths should be prefixed by /c:
+      end
+
+      def file_path(uri_string)
+        return if uri_string.nil?
+        uri = URI(uri_string)
+        path = CGI.unescape(uri.path)
+        # On Windows, VS Code sends the URLs as file:///C:/...
+        # /C:/1234 is not a valid path in ruby. So we strip the slash.
+        path = path.sub(%r{^/([a-z]:/)}i, '\1')
+        path
+      end
+    end
+  end
+end

data/lib/theme_check/language_server.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require_relative "language_server/protocol"
 require_relative "language_server/constants"
+require_relative "language_server/uri_helper"
 require_relative "language_server/handler"
 require_relative "language_server/server"
 require_relative "language_server/tokens"

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -90,6 +90,7 @@ files:
 - docs/checks/deprecate_bgsizes.md
 - docs/checks/deprecate_lazysizes.md
 - docs/checks/deprecated_filter.md
+- docs/checks/deprecated_global_app_block_type.md
 - docs/checks/html_parsing_error.md
 - docs/checks/img_lazy_loading.md
 - docs/checks/img_width_and_height.md
@@ -140,6 +141,7 @@ files:
 - lib/theme_check/checks/deprecate_bgsizes.rb
 - lib/theme_check/checks/deprecate_lazysizes.rb
 - lib/theme_check/checks/deprecated_filter.rb
+- lib/theme_check/checks/deprecated_global_app_block_type.rb
 - lib/theme_check/checks/html_parsing_error.rb
 - lib/theme_check/checks/img_lazy_loading.rb
 - lib/theme_check/checks/img_width_and_height.rb
@@ -203,6 +205,7 @@ files:
 - lib/theme_check/language_server/protocol.rb
 - lib/theme_check/language_server/server.rb
 - lib/theme_check/language_server/tokens.rb
+- lib/theme_check/language_server/uri_helper.rb
 - lib/theme_check/language_server/variable_lookup_finder.rb
 - lib/theme_check/liquid_check.rb
 - lib/theme_check/locale_diff.rb