theme-check 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6510c266c71be36555ad42b3de0dc88db11710ac631dd2d7292175764b3ce51f
-  data.tar.gz: d8eb627ff4f5de44cfea7a21049f37c42c007ff617fe2f07760ade8e1b0dc283
+  metadata.gz: b8c635ed30803cdeab5dfba7a7b65cbfabeaedf1d7c38bb0b99c35d1597798a4
+  data.tar.gz: 5abd13766f9f027aa6e5280120893380c6d845b230b0083d591701a5a9a31610
 SHA512:
-  metadata.gz: 79f4683785b839a91731540fdf4b0e23d1d4f4a0a949aae3beb8637f651b8b0030ef5a3f9506da5de63109636410fc4cdb31616aade995442e61de43da4e2c55
-  data.tar.gz: 5dda4447bb00c1b4f225255c628d9f5ab6c5e17c619065681631d68953e3b0b4562a523a3c359a5e566007de0042282aec775f82dcecd05e2c4c5b4c8eee0003
+  metadata.gz: c04023a0aa3c5de15038248e7f24fbaabcbe97a85fa67183006ddc59328d1e4641d490dad8f8643709d19259f91b01e3e996c23a0d03b951b59d3f35048e52ac
+  data.tar.gz: 81b5ad32a2fdcfa72ab07e47864616c5a2063ad9150ccc914d3a5b5863e09bc834d3497c78ac2d057a5645d3832dca0967c9fa425c661625fa9acf1c27c243d4

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 
+v1.14.0 / 2023-01-10
+==================
+
+  * Add shopify-dev link to code completion suggestion title ([#700](https://github.com/Shopify/theme-check/issues/700))
+  * Fix examples in `SchemaJsonFormat` ([#698](https://github.com/Shopify/theme-check/issues/698))
+  * Do not suggest `escape` filter for already escaped strings ([#692](https://github.com/Shopify/theme-check/issues/692))
+
 v1.13.0 / 2023-01-04
 ==================
 

data/data/shopify_liquid/documentation/filters.json

@@ -2657,7 +2657,7 @@
         "description": "",
         "syntax": "",
         "path": "/",
-        "raw_liquid": "{{ \"I hate it when I accidentally spill my duplication potion accidentally!\" | remove_first: ' accidentally' }}",
+        "raw_liquid": "{{ \"I hate it when I accidentally spill my duplication potion accidentally!\" | remove_last: ' accidentally' }}",
         "parameter": false,
         "display_type": "text",
         "show_data_tab": true
@@ -3888,10 +3888,10 @@
     "examples": [
       {
         "name": "Basic types",
-        "description": "Most metafield types return a simple HTML element:\n\n| Type | Element | Attributes |\n| --- | --- | --- |\n| `boolean` | `<span>` | `class=\"metafield-boolean\"` |\n| `collection_reference` | `<a>` | `class=\"metafield-collection_reference\"` |\n| `color` | `<span>` | `class=\"metafield-color\"` |\n| `date` | `<time>` | `datetime=\"<the metafield value>\"`<br><br>`class=\"metafield-date\"`<br><br>Value is localized to the customer |\n| `date_time` | `<time>` | `datetime=\"<the metafield value>\"`<br><br>`class=\"metafield-date\"`<br><br>Value is localized to the customer |\n| `json` | `<script>` | `type=\"application/json\"`<br><br>`class=\"metafield-json\"` |\n| `money` | `<span>` | `class=\"metafield-money\"`<br><br>Value is formatted using the store's [HTML with currency setting](https://help.shopify.com/manual/payments/currency-formatting) |\n| `multi_line_text_field` | `<span>` | `class=\"metafield-multi_line_text_field\"` |\n| `number_decimal` | `<span>` | `class=\"metafield-number_decimal\"` |\n| `number_integer` | `<span>` | `class=\"metafield-number_integer\"` |\n| `page_reference` | `<a>` | `class=\"metafield-page_reference\"` |\n| `product_reference` | `<a>` | `class=\"metafield-page_reference\"` |\n| `rating` | `<span>` | `class=\"metafield-rating\"` | |\n| `single_line_text_field` | `<span>` | `class=\"metafield-single_line_text_field\"` |\n| `url` | `<a>` | `class=\"metafield-url\"` |\n| `variant_reference` | `<a>` | `class=\"metafield-variant_reference\"` |\n",
+        "description": "Most metafield types return a simple HTML element:\n\n| Type | Element | Attributes |\n| --- | --- | --- |\n| `boolean` | `<span>` | `class=\"metafield-boolean\"` |\n| `collection_reference` | `<a>` | `class=\"metafield-collection_reference\"` |\n| `color` | `<span>` | `class=\"metafield-color\"` |\n| `date` | `<time>` | `datetime=\"<the metafield value>\"`<br><br>`class=\"metafield-date\"`<br><br>Value is localized to the customer |\n| `date_time` | `<time>` | `datetime=\"<the metafield value>\"`<br><br>`class=\"metafield-date\"`<br><br>Value is localized to the customer |\n| `json` | `<script>` | `type=\"application/json\"`<br><br>`class=\"metafield-json\"` |\n| `money` | `<span>` | `class=\"metafield-money\"`<br><br>Value is formatted using the store's [HTML with currency setting](https://help.shopify.com/manual/payments/currency-formatting) |\n| `multi_line_text_field` | `<span>` | `class=\"metafield-multi_line_text_field\"` |\n| `number_decimal` | `<span>` | `class=\"metafield-number_decimal\"` |\n| `number_integer` | `<span>` | `class=\"metafield-number_integer\"` |\n| `page_reference` | `<a>` | `class=\"metafield-page_reference\"` |\n| `product_reference` | `<a>` | `class=\"metafield-page_reference\"` |\n| `rating` | `<span>` | `class=\"metafield-rating\"` | |\n| `single_line_text_field` | `<span>` | `class=\"metafield-single_line_text_field\"` |\n| `url` | `<a>` | `class=\"metafield-url\"` |\n| `variant_reference` | `<a>` | `class=\"metafield-variant_reference\"` |\n| `rich_text_field` | <div> | `class=\"metafield-rich_text_field\"` |\n",
         "syntax": "",
         "path": "/products/health-potion",
-        "raw_liquid": "<!-- boolean -->\n{{ product.metafields.information.seasonal | metafield_tag }}\n\n<!-- collection_reference -->\n{{ product.metafields.information.related_collection | metafield_tag }}\n\n<!-- color -->\n{{ product.metafields.details.potion_color | metafield_tag }}\n\n<!-- date -->\n{{ product.metafields.information.expiry | metafield_tag }}\n\n<!-- date_time -->\n{{ product.metafields.information.brew_date | metafield_tag }}\n\n<!-- json -->\n{{ product.metafields.information.burn_temperature | metafield_tag }}\n\n<!-- money -->\n{{ product.metafields.details.price_per_ml | metafield_tag }}\n\n<!-- multi_line_text_field -->\n{{ product.metafields.information.shipping | metafield_tag }}\n\n<!-- number_decimal -->\n{{ product.metafields.information.salinity | metafield_tag }}\n\n<!-- number_integer -->\n{{ product.metafields.information.doses_per_day | metafield_tag }}\n\n<!-- page_reference -->\n{{ product.metafields.information.dosage | metafield_tag }}\n\n<!-- product_reference -->\n{{ product.metafields.information.related_product | metafield_tag }}\n\n<!-- rating -->\n{{ product.metafields.details.rating | metafield_tag }}\n\n<!-- single_line_text_field -->\n{{ product.metafields.information.directions | metafield_tag }}\n\n<!-- url -->\n{{ product.metafields.information.health | metafield_tag }}\n\n<!-- variant_reference -->\n{{ product.metafields.information.health | metafield_tag }}",
+        "raw_liquid": "<!-- boolean -->\n{{ product.metafields.information.seasonal | metafield_tag }}\n\n<!-- collection_reference -->\n{{ product.metafields.information.related_collection | metafield_tag }}\n\n<!-- color -->\n{{ product.metafields.details.potion_color | metafield_tag }}\n\n<!-- date -->\n{{ product.metafields.information.expiry | metafield_tag }}\n\n<!-- date_time -->\n{{ product.metafields.information.brew_date | metafield_tag }}\n\n<!-- json -->\n{{ product.metafields.information.burn_temperature | metafield_tag }}\n\n<!-- money -->\n{{ product.metafields.details.price_per_ml | metafield_tag }}\n\n<!-- multi_line_text_field -->\n{{ product.metafields.information.shipping | metafield_tag }}\n\n<!-- number_decimal -->\n{{ product.metafields.information.salinity | metafield_tag }}\n\n<!-- number_integer -->\n{{ product.metafields.information.doses_per_day | metafield_tag }}\n\n<!-- page_reference -->\n{{ product.metafields.information.dosage | metafield_tag }}\n\n<!-- product_reference -->\n{{ product.metafields.information.related_product | metafield_tag }}\n\n<!-- rating -->\n{{ product.metafields.details.rating | metafield_tag }}\n\n<!-- single_line_text_field -->\n{{ product.metafields.information.directions | metafield_tag }}\n\n<!-- url -->\n{{ product.metafields.information.health | metafield_tag }}\n\n<!-- variant_reference -->\n{{ product.metafields.information.health | metafield_tag }}\n\n<!-- rich_text_field -->\n{{ product.metafields.information.health | metafield_tag }}",
         "parameter": false,
         "display_type": "text",
         "show_data_tab": false
@@ -3965,7 +3965,7 @@
     "category": "metafield",
     "deprecated": false,
     "deprecation_reason": "",
-    "description": "The following outlines the output for each metafield type:\n\n| Metafield type | Output |\n| --- | --- |\n| `single_line_text_field` | The metafield text |\n| `multi_line_text_field` | The metafield text |\n| `page_reference` | The page title |\n| `product_reference` | The product title |\n| `collection_reference` | The collection title |\n| `variant_reference` | The variant title |\n| `file_reference` | The file URL |\n| `number_integer` | The number |\n| `number_decimal` | The number |\n| `date` | The date |\n| `date-time` | The date and time |\n| `url` | The URL |\n| `json` | The JSON |\n| `boolean` | The boolean value |\n| `color` | The color value |\n| `weight` | The weight value and unit |\n| `volume` | The volume value and unit |\n| `dimension` | The dimension value and unit |\n| `rating` | The rating value |\n| `list.single_line_text_field` | The metafield values converted to a sentence.<br><br>For example, if you had the values `Toronto`, `Ottawa`, and `Vancouver`, then the output would be:<br><br>`Toronto, Ottawa, and Vancouver` |\n| `money` | The money value, formatted using the store's [**HTML with currency** setting](https://help.shopify.com/manual/payments/currency-formatting). |",
+    "description": "The following outlines the output for each metafield type:\n\n| Metafield type | Output |\n| --- | --- |\n| `single_line_text_field` | The metafield text |\n| `multi_line_text_field` | The metafield text |\n| `page_reference` | The page title |\n| `product_reference` | The product title |\n| `collection_reference` | The collection title |\n| `variant_reference` | The variant title |\n| `file_reference` | The file URL |\n| `number_integer` | The number |\n| `number_decimal` | The number |\n| `date` | The date |\n| `date-time` | The date and time |\n| `url` | The URL |\n| `json` | The JSON |\n| `boolean` | The boolean value |\n| `color` | The color value |\n| `weight` | The weight value and unit |\n| `volume` | The volume value and unit |\n| `dimension` | The dimension value and unit |\n| `rating` | The rating value |\n| `list.single_line_text_field` | The metafield values converted to a sentence.<br><br>For example, if you had the values `Toronto`, `Ottawa`, and `Vancouver`, then the output would be:<br><br>`Toronto, Ottawa, and Vancouver` |\n| `money` | The money value, formatted using the store's [**HTML with currency** setting](https://help.shopify.com/manual/payments/currency-formatting). |\n| `rich_text_field` | The rich text value as simple text |",
     "parameters": [
 
     ],

data/data/shopify_liquid/documentation/objects.json

@@ -11046,7 +11046,7 @@
       {
         "deprecated": false,
         "deprecation_reason": "",
-        "description": "> Note:\n> The selected variant is determined by the `variant` URL parameter. The `selected_variant` parameter is available on product pages only.\n\nFor a variant to be available, it needs to meet one of the following criteria:\n\n- The `variant.inventory_quantity` is greater than 1.\n- The `variant.inventory_policy` is set to `continue`.\n- The `variant.inventory_management` is `nil`.",
+        "description": "> Note:\n> The selected variant is determined by the `variant` URL parameter. The `selected_variant` parameter is available on product pages only.\n\nFor a variant to be available, it needs to meet one of the following criteria:\n\n- The `variant.inventory_quantity` is greater than 0.\n- The `variant.inventory_policy` is set to `continue`.\n- The `variant.inventory_management` is `nil`.",
         "examples": [
 
         ],
@@ -11100,7 +11100,7 @@
       {
         "deprecated": false,
         "deprecation_reason": "",
-        "description": "For a variant to be available, it needs to meet one of the following criteria:\n\n- The `variant.inventory_quantity` is greater than 1.\n- The `variant.inventory_policy` is set to `continue`.\n- The `variant.inventory_management` is `nil`.",
+        "description": "For a variant to be available, it needs to meet one of the following criteria:\n\n- The `variant.inventory_quantity` is greater than 0.\n- The `variant.inventory_policy` is set to `continue`.\n- The `variant.inventory_management` is `nil`.",
         "examples": [
 
         ],
@@ -11118,7 +11118,7 @@
       {
         "deprecated": false,
         "deprecation_reason": "",
-        "description": "For a variant to be available, it needs to meet one of the following criteria:\n\n- The `variant.inventory_quantity` is greater than 1.\n- The `variant.inventory_policy` is set to `continue`.\n- The `variant.inventory_management` is `nil`.",
+        "description": "For a variant to be available, it needs to meet one of the following criteria:\n\n- The `variant.inventory_quantity` is greater than 0.\n- The `variant.inventory_policy` is set to `continue`.\n- The `variant.inventory_management` is `nil`.",
         "examples": [
 
         ],
@@ -18513,7 +18513,13 @@
         "type": "string",
         "name": "",
         "description": "",
-        "array_value": ""
+        "array_value": "",
+        "denied_filters": [
+          "escape",
+          "escape_once",
+          "url_escape",
+          "url_param_escape"
+        ]
       }
     ]
   },
@@ -18583,7 +18589,13 @@
         "type": "string",
         "name": "",
         "description": "",
-        "array_value": ""
+        "array_value": "",
+        "denied_filters": [
+          "escape",
+          "escape_once",
+          "url_escape",
+          "url_param_escape"
+        ]
       }
     ]
   },

data/docs/checks/schema_json_format.md

@@ -19,7 +19,7 @@ The following examples contain code snippets that either fail or pass this check
 "en": {
   "title": "Welcome", "product": "Product"
 },
-          "fr": { "title": "Bienvenue", "produit": "Produit" }
+          "fr": { "title": "Bienvenue", "product": "Produit" }
   }
 }
 {% endschema %}
@@ -33,11 +33,11 @@ The following examples contain code snippets that either fail or pass this check
   "locales": {
     "en": {
       "title": "Welcome",
-      "missing": "Product"
+      "product": "Product"
     },
     "fr": {
       "title": "Bienvenue",
-      "missing": "TODO"
+      "product": "Produit"
     }
   }
 }

data/lib/theme_check/language_server/completion_providers/filter_completion_provider.rb

@@ -15,8 +15,10 @@ module ThemeCheck
         return [] unless can_complete?(content, cursor)
 
         context = context_with_cursor_before_potential_filter_separator(context)
-        available_filters_for(determine_input_type(context))
-          .select { |w| w.name.start_with?(partial(content, cursor)) }
+        variable_lookup = VariableLookupFinder.lookup(context)
+        denied_filters = denied_filters_for(variable_lookup)
+        available_filters_for(determine_input_type(variable_lookup))
+          .select { |filter| filter.name.start_with?(partial(content, cursor)) && denied_filters.none?(filter.name) }
           .map { |filter| filter_to_completion(filter) }
       end
 
@@ -38,14 +40,18 @@ module ThemeCheck
         context.clone_and_overwrite(col: context.col + diff)
       end
 
-      def determine_input_type(context)
-        variable_lookup = VariableLookupFinder.lookup(context)
+      def determine_input_type(variable_lookup)
+        return if variable_lookup.nil?
 
-        if variable_lookup
-          object, property = VariableLookupTraverser.lookup_object_and_property(variable_lookup)
-          return property.return_type if property
-          return object.name if object
-        end
+        object, property = VariableLookupTraverser.lookup_object_and_property(variable_lookup)
+        return property.return_type if property
+        return object.name if object
+      end
+
+      def denied_filters_for(variable_lookup)
+        return [] if variable_lookup.nil?
+
+        VariableLookupTraverser.find_object(variable_lookup.name).denied_filters
       end
 
       def available_filters_for(input_type)

data/lib/theme_check/shopify_liquid/documentation/markdown_template.rb

@@ -16,7 +16,7 @@ module ThemeCheck
         private
 
         def title(entry)
-          "### #{entry.name}"
+          "### [#{entry.name}](#{entry.shopify_dev_url})"
         end
 
         def body(entry)

data/lib/theme_check/shopify_liquid/source_index/base_entry.rb

@@ -10,7 +10,9 @@ module ThemeCheck
 
         attr_reader :hash
 
-        def_delegators :return_type_instance, :generic_type?, :array_type?, :array_type, :to_s
+        def_delegators :return_type_instance, :generic_type?, :array_type?, :array_type, :to_s, :denied_filters
+
+        SHOPIFY_DEV_ROOT_URL = "https://shopify.dev/api/liquid"
 
         def initialize(hash = {})
           @hash = hash || {}
@@ -39,6 +41,10 @@ module ThemeCheck
           hash['deprecation_reason'] || nil
         end
 
+        def shopify_dev_url
+          SHOPIFY_DEV_ROOT_URL
+        end
+
         attr_writer :return_type
 
         def return_type

data/lib/theme_check/shopify_liquid/source_index/filter_entry.rb

@@ -10,7 +10,11 @@ module ThemeCheck
         end
 
         def input_type
-          hash['syntax'].split(' | ')[0]
+          @input_type ||= hash['syntax'].split(' | ')[0]
+        end
+
+        def shopify_dev_url
+          "#{SHOPIFY_DEV_ROOT_URL}/filters/#{hash['name']}"
         end
       end
     end

data/lib/theme_check/shopify_liquid/source_index/object_entry.rb

@@ -6,7 +6,13 @@ module ThemeCheck
       class ObjectEntry < BaseEntry
         def properties
           (hash['properties'] || [])
-            .map { |hash| PropertyEntry.new(hash) }
+            .map do |prop_hash|
+              PropertyEntry.new(prop_hash, hash['name'])
+            end
+        end
+
+        def shopify_dev_url
+          "#{SHOPIFY_DEV_ROOT_URL}/objects/#{hash['name']}"
         end
       end
     end

data/lib/theme_check/shopify_liquid/source_index/parameter_entry.rb

@@ -8,6 +8,10 @@ module ThemeCheck
           nil
         end
 
+        def shopify_dev_url
+          "#{SHOPIFY_DEV_ROOT_URL}/filters/#{hash['name']}"
+        end
+
         private
 
         def return_type_hash

data/lib/theme_check/shopify_liquid/source_index/property_entry.rb

@@ -3,7 +3,19 @@
 module ThemeCheck
   module ShopifyLiquid
     class SourceIndex
-      class PropertyEntry < BaseEntry; end
+      class PropertyEntry < BaseEntry
+        attr_reader :parent_name
+
+        def initialize(hash, parent_name)
+          @hash = hash || {}
+          @return_type = nil
+          @parent_name = parent_name
+        end
+
+        def shopify_dev_url
+          "#{SHOPIFY_DEV_ROOT_URL}/objects/#{parent_name}##{parent_name}-#{hash['name']}"
+        end
+      end
     end
   end
 end

data/lib/theme_check/shopify_liquid/source_index/return_type_entry.rb

@@ -24,6 +24,10 @@ module ThemeCheck
           hash['array_value']
         end
 
+        def denied_filters
+          hash['denied_filters'] || []
+        end
+
         private
 
         def return_type_hash

data/lib/theme_check/shopify_liquid/source_index/tag_entry.rb

@@ -14,6 +14,10 @@ module ThemeCheck
             'type' => "tag<#{name}>",
           }
         end
+
+        def shopify_dev_url
+          "#{SHOPIFY_DEV_ROOT_URL}/tags/#{hash['name']}"
+        end
       end
     end
   end

data/lib/theme_check/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid