@shopify/theme-check-docs-updater - npm Package Compare versions

Comparing version 2.8.0 to 2.9.0

CHANGELOG.md

 # @shopify/theme-check-docs-updater
 
+## 2.9.0
+
+### Patch Changes
+
+- Updated dependencies [457f9cb]
+- Updated dependencies [edb7f2e]
+  - @shopify/theme-check-common@2.9.0
+
 ## 2.7.0
@@ -4,0 +12,0 @@

data/default_setting_values.json

@@ -5,2 +5,58 @@ {
   "description": "A list of default values for any settings that you might want to populate. Each entry should include the setting name and the value.",
+  "properties": {
+    "layout": {
+      "type": "object",
+      "description": "Layout style settings for the preset",
+      "allOf": [
+        {
+          "$ref": "./setting.json#/definitions/style.flex_layout_properties"
+        }
+      ],
+      "properties": {
+        "@media (--mobile)": {
+          "type": "object",
+          "description": "Layout style settings for the mobile breakpoint",
+          "$ref": "./setting.json#/definitions/style.flex_layout_properties",
+          "unevaluatedProperties": false
+        }
+      },
+      "unevaluatedProperties": false
+    },
+    "size": {
+      "type": "object",
+      "description": "Size style settings for the preset",
+      "allOf": [
+        {
+          "$ref": "./setting.json#/definitions/style.size_properties"
+        }
+      ],
+      "properties": {
+        "@media (--mobile)": {
+          "type": "object",
+          "description": "Size style settings for the mobile breakpoint",
+          "$ref": "./setting.json#/definitions/style.size_properties",
+          "unevaluatedProperties": false
+        }
+      },
+      "unevaluatedProperties": false
+    },
+    "spacing": {
+      "type": "object",
+      "description": "Spacing style settings for the preset",
+      "allOf": [
+        {
+          "$ref": "./setting.json#/definitions/style.spacing_properties"
+        }
+      ],
+      "properties": {
+        "@media (--mobile)": {
+          "type": "object",
+          "description": "Spacing style settings for the mobile breakpoint",
+          "$ref": "./setting.json#/definitions/style.spacing_properties",
+          "unevaluatedProperties": false
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
   "additionalProperties": {
@@ -7,0 +63,0 @@ "anyOf": [

data/latest.json

@@ -1,2 +0,2 @@
-{ "revision": "ff2db0d67105251fbab29b1a24adad239b1df790" }
+{ "revision": "5c1c4031096fbca81caf0ab1d76868bb2216520f" }
 

data/section.json

@@ -122,2 +122,9 @@ {
               "properties": {
+                "static": {
+                  "type": "boolean",
+                  "description": "If the block is rendered statically or not"
+                },
+                "id": {
+                  "type": "string"
+                },
                 "type": {
@@ -133,3 +140,18 @@ "type": "string",
                 }
-              }
+              },
+              "allOf": [
+                {
+                  "if": {
+                    "properties": {
+                      "static": {
+                        "const": true
+                      }
+                    },
+                    "required": ["static"]
+                  },
+                  "then": {
+                    "required": ["id"]
+                  }
+                }
+              ]
             }
@@ -136,0 +158,0 @@ }

data/setting.json

@@ -25,2 +25,4 @@ {
         "liquid",
+        "metaobject",
+        "metaobject_list",
         "number",
@@ -35,2 +37,5 @@ "page",
         "select",
+        "style.layout_panel",
+        "style.size_panel",
+        "style.spacing_panel",
         "text",
@@ -117,2 +122,10 @@ "text_alignment",
     {
+      "if": { "required": ["type"], "properties": { "type": { "const": "metaobject" } } },
+      "then": { "$ref": "#/definitions/metaobject" }
+    },
+    {
+      "if": { "required": ["type"], "properties": { "type": { "const": "metaobject_list" } } },
+      "then": { "$ref": "#/definitions/metaobject_list" }
+    },
+    {
       "if": { "required": ["type"], "properties": { "type": { "const": "number" } } },
@@ -150,2 +163,14 @@ "then": { "$ref": "#/definitions/number" }
     {
+      "if": { "required": ["type"], "properties": { "type": { "const": "style.layout_panel" } } },
+      "then": { "$ref": "#/definitions/style.layout_panel" }
+    },
+    {
+      "if": { "required": ["type"], "properties": { "type": { "const": "style.size_panel" } } },
+      "then": { "$ref": "#/definitions/style.size_panel" }
+    },
+    {
+      "if": { "required": ["type"], "properties": { "type": { "const": "style.spacing_panel" } } },
+      "then": { "$ref": "#/definitions/style.spacing_panel" }
+    },
+    {
       "if": { "required": ["type"], "properties": { "type": { "const": "text" } } },
@@ -250,3 +275,3 @@ "then": { "$ref": "#/definitions/text" }
         "limit": {
-          "type": "number",
+          "type": "integer",
           "description": "The maximum number that the merchant can select. The default limit, and the maximum limit you can set, is 50."
@@ -520,2 +545,47 @@ },
 
+    "metaobject": {
+      "allOf": [{ "$ref": "#/definitions/inputSettingsStandardAttributes" }],
+      "properties": {
+        "type": {
+          "const": "metaobject",
+          "description": "A setting of type metaobject outputs a metaobject picker field that's automatically populated with the compatible metaobject entries for the store. You can use these fields to capture a metaobject entry selection for a known metaobject type.",
+          "markdownDescription": "A setting of type `metaobject` outputs a metaobject picker field that's automatically populated with the compatible metaobject entries for the store. You can use these fields to capture a metaobject entry selection for a known metaobject type. \n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/settings/input-settings#metaobject)"
+        },
+        "metaobject_type": {
+          "type": "string",
+          "description": "The metaobject type allowed by the picker."
+        },
+        "default": true,
+        "label": true,
+        "info": true,
+        "id": true
+      },
+      "required": ["metaobject_type"],
+      "additionalProperties": false
+    },
+
+    "metaobject_list": {
+      "allOf": [{ "$ref": "#/definitions/inputSettingsStandardAttributes" }],
+      "properties": {
+        "type": {
+          "const": "metaobject_list",
+          "description": "A setting of type metaobject_list outputs a metaobject picker field that's automatically populated with the compatible metaobject entries for the store. You can use these fields to capture multiple metaobject entry selections for a known metaobject type.",
+          "markdownDescription": "A setting of type `metaobject_list` outputs a metaobject picker field that's automatically populated with the compatible metaobject entries for the store. You can use these fields to capture multiple metaobject entry selections for a known metaobject type.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/settings/input-settings#metaobject_list)"
+        },
+        "metaobject_type": {
+          "type": "string",
+          "description": "The metaobject type allowed by the picker."
+        },
+        "limit": {
+          "type": "integer",
+          "description": "The maximum number that the merchant can select. The default limit, and the maximum limit you can set, is 50."
+        },
+        "default": true,
+        "label": true,
+        "info": true,
+        "id": true
+      },
+      "required": ["metaobject_type"],
+      "additionalProperties": false
+    },
     "number": {
@@ -582,3 +652,3 @@ "allOf": [{ "$ref": "#/definitions/inputSettingsStandardAttributes" }],
         "limit": {
-          "type": "number",
+          "type": "integer",
           "description": "The maximum number that the merchant can select. The default limit, and the maximum limit you can set, is 50."
@@ -692,2 +762,125 @@ },
 
+    "lengthPattern": {
+      "type": "string",
+      "pattern": "^[0-9]+(px|%)$"
+    },
+
+    "lengthAutoPattern": {
+      "type": "string",
+      "pattern": "^([0-9]+(px|%)|auto|fit-content)$"
+    },
+
+    "lengthNonePattern": {
+      "type": "string",
+      "pattern": "^([0-9]+(px|%)|none|fit-content)$"
+    },
+
+    "negativeLengthPattern": {
+      "type": "string",
+      "pattern": "^-?[0-9]+(px|%)$"
+    },
+
+    "numberPattern": {
+      "type": "string",
+      "pattern": "^[0-9]+$"
+    },
+
+    "negativeNumberPattern": {
+      "type": "string",
+      "pattern": "^-?[0-9]+$"
+    },
+
+    "style.layout_panel": {
+      "allOf": [{ "$ref": "#/definitions/inputSettingsStandardAttributes" }],
+      "properties": {
+        "type": {
+          "const": "style.layout_panel",
+          "description": "A setting of type style.layout_panel outputs style settings for layout.",
+          "markdownDescription": "A setting of type `style.layout_panel` outputs style settings for layout.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/settings/input-settings#style.layout_panel)"
+        },
+        "default": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/style.flex_layout_properties"
+            }
+          ],
+          "properties": {
+            "@media (--mobile)": {
+              "type": "object",
+              "description": "Style settings for the mobile breakpoint",
+              "$ref": "#/definitions/style.flex_layout_properties",
+              "unevaluatedProperties": false
+            }
+          },
+          "unevaluatedProperties": false
+        },
+        "label": true,
+        "info": true,
+        "id": true
+      },
+      "additionalProperties": false
+    },
+
+    "style.size_panel": {
+      "allOf": [{ "$ref": "#/definitions/inputSettingsStandardAttributes" }],
+      "properties": {
+        "type": {
+          "const": "style.size_panel",
+          "description": "A setting of type style.size_panel outputs style settings for size.",
+          "markdownDescription": "A setting of type `style.size_panel` outputs style settings for size.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/settings/input-settings#style.size_panel)"
+        },
+        "default": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/style.size_properties"
+            }
+          ],
+          "properties": {
+            "@media (--mobile)": {
+              "type": "object",
+              "description": "Style settings for the mobile breakpoint",
+              "$ref": "#/definitions/style.size_properties",
+              "unevaluatedProperties": false
+            }
+          },
+          "unevaluatedProperties": false
+        },
+        "label": true,
+        "info": true,
+        "id": true
+      },
+      "additionalProperties": false
+    },
+
+    "style.spacing_panel": {
+      "allOf": [{ "$ref": "#/definitions/inputSettingsStandardAttributes" }],
+      "properties": {
+        "type": {
+          "const": "style.spacing_panel",
+          "description": "A setting of type style.spacing_panel outputs style settings for spacing.",
+          "markdownDescription": "A setting of type `style.spacing_panel` outputs style settings for spacing.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/settings/input-settings#style.spacing_panel)"
+        },
+        "default": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/style.spacing_properties"
+            }
+          ],
+          "properties": {
+            "@media (--mobile)": {
+              "type": "object",
+              "description": "Style settings for the mobile breakpoint",
+              "$ref": "#/definitions/style.spacing_properties",
+              "unevaluatedProperties": false
+            }
+          },
+          "unevaluatedProperties": false
+        },
+        "label": true,
+        "info": true,
+        "id": true
+      },
+      "additionalProperties": false
+    },
+
     "text": {
@@ -902,2 +1095,218 @@ "allOf": [{ "$ref": "#/definitions/inputSettingsStandardAttributes" }],
 
+    "style.flex_layout_properties": {
+      "type": "object",
+      "properties": {
+        "flex-direction": {
+          "type": "string",
+          "description": "Determines how flex items are arranged within the flex container by specifying the main axis and direction. Valid values are row (default), row-reverse, column, and column-reverse.",
+          "enum": ["row", "row-reverse", "column", "column-reverse"]
+        },
+        "flex-wrap": {
+          "type": "string",
+          "description": "Specifies whether flex items are confined to a single line or can flow onto multiple lines. If wrapping is allowed, it defines the stacking direction of the lines. Valid values are nowrap (default), wrap, and wrap-reverse.",
+          "enum": ["nowrap", "wrap", "wrap-reverse"]
+        },
+        "row-gap": {
+          "$ref": "#/definitions/lengthPattern",
+          "description": "Defines the size of the gap between the rows of a wrapped flex container."
+        },
+        "column-gap": {
+          "$ref": "#/definitions/lengthPattern",
+          "description": "Defines the size of the gap between flex items."
+        },
+        "gap": {
+          "type": "string",
+          "description": "Shorthand for row-gap and column-gap. Defines the gaps between flex items.",
+          "pattern": "^([0-9]+(px|%) ?){1,2}$"
+        },
+        "justify-content": {
+          "type": "string",
+          "description": "Defines the alignment of flex items along the main axis of the flex container. Valid values are flex-start (default), flex-end, start, end, left, right, center, space-between, space-around and space-evenly.",
+          "enum": [
+            "flex-start",
+            "flex-end",
+            "start",
+            "end",
+            "left",
+            "right",
+            "center",
+            "space-between",
+            "space-around",
+            "space-evenly"
+          ]
+        },
+        "align-items": {
+          "type": "string",
+          "description": "Defines the alignment of flex items along the cross axis of the flex container. Valid values are stretch (default), flex-start / start / self-start, flex-end / end / self-end, center and baseline.",
+          "enum": [
+            "stretch",
+            "flex-start",
+            "start",
+            "self-start",
+            "flex-end",
+            "end",
+            "self-end",
+            "center",
+            "baseline"
+          ]
+        },
+        "align-content": {
+          "type": "string",
+          "description": "Defines the distribution of space between and around flex items along the cross axis. Valid values are stretch, flex-start / start, flex-end / end, center, space-between, space-around, and space-evenly.",
+          "enum": [
+            "stretch",
+            "flex-start",
+            "start",
+            "flex-end",
+            "end",
+            "center",
+            "space-between",
+            "space-around",
+            "space-evenly"
+          ]
+        }
+      }
+    },
+
+    "style.size_properties": {
+      "type": "object",
+      "properties": {
+        "flex-grow": {
+          "$ref": "#/definitions/numberPattern",
+          "description": "Defines the flex grow factor of a flex item, determining how much of the available space in the flex container the item should occupy."
+        },
+        "flex-shrink": {
+          "$ref": "#/definitions/numberPattern",
+          "description": "Defines the flex shrink factor of a flex item, determining how much the item should reduce in size compared to the other flex items when space is insufficient."
+        },
+        "flex-basis": {
+          "$ref": "#/definitions/lengthAutoPattern",
+          "description": "Defines the initial main size of a flex item, determining the size of the content-box unless otherwise specified by box-sizing."
+        },
+        "width": {
+          "$ref": "#/definitions/lengthAutoPattern",
+          "description": "Defines the width of an item."
+        },
+        "min-width": {
+          "$ref": "#/definitions/lengthAutoPattern",
+          "description": "Defines the minimum width of an item."
+        },
+        "max-width": {
+          "$ref": "#/definitions/lengthNonePattern",
+          "description": "Defines the maximum width of an item."
+        },
+        "height": {
+          "$ref": "#/definitions/lengthAutoPattern",
+          "description": "Defines the height of an item."
+        },
+        "min-height": {
+          "$ref": "#/definitions/lengthAutoPattern",
+          "description": "Defines the minimum height of an item."
+        },
+        "max-height": {
+          "$ref": "#/definitions/lengthNonePattern",
+          "description": "Defines the maximum height of an item."
+        }
+      }
+    },
+
+    "style.spacing_properties": {
+      "type": "object",
+      "properties": {
+        "padding": {
+          "description": "Shorthand that defines the padding on all four sides of an element.",
+          "pattern": "^([0-9]+(px|%) ?){1,4}$"
+        },
+        "padding-top": {
+          "description": "Defines the padding on the top side of an element.",
+          "$ref": "#/definitions/lengthPattern"
+        },
+        "padding-right": {
+          "description": "Defines the padding on the right side of an element.",
+          "$ref": "#/definitions/lengthPattern"
+        },
+        "padding-bottom": {
+          "description": "Defines the padding on the bottom side of an element.",
+          "$ref": "#/definitions/lengthPattern"
+        },
+        "padding-left": {
+          "description": "Defines the padding on the left side of an element.",
+          "$ref": "#/definitions/lengthPattern"
+        },
+        "padding-block-start": {
+          "description": "Defines the logical block start padding of an element, translating to physical padding based on the element's writing mode, text direction, and text orientation.",
+          "$ref": "#/definitions/lengthPattern"
+        },
+        "padding-block-end": {
+          "description": "Defines the logical block end padding of an element, translating to physical padding based on the element's writing mode, text direction, and text orientation.",
+          "$ref": "#/definitions/lengthPattern"
+        },
+        "padding-block": {
+          "type": "string",
+          "description": "Shorthand for padding-block-start and padding-block end. Defines the logical block start and end padding of an element, translating to physical padding based on the element's writing mode, text direction, and text orientation.",
+          "pattern": "^([0-9]+(px|%) ?){1,2}$"
+        },
+        "padding-inline-start": {
+          "description": "Defines the logical inline start padding of an element, translating to physical padding based on the element's writing mode, text direction, and text orientation.",
+          "$ref": "#/definitions/lengthPattern"
+        },
+        "padding-inline-end": {
+          "description": "Defines the logical inline end padding of an element, translating to physical padding based on the element's writing mode, text direction, and text orientation.",
+          "$ref": "#/definitions/lengthPattern"
+        },
+        "padding-inline": {
+          "type": "string",
+          "description": "Shorthand that defines the logical inline start and end padding of an element, translating to physical padding based on the element's writing mode, text direction, and text orientation.",
+          "pattern": "^([0-9]+(px|%) ?){1,2}$"
+        },
+        "margin": {
+          "type": "string",
+          "description": "Shorthand that defines the margin on all four sides of an element.",
+          "pattern": "^(-?[0-9]+(px|%) ?){1,4}$"
+        },
+        "margin-top": {
+          "description": "Defines the margin on the top side of an element.",
+          "$ref": "#/definitions/negativeLengthPattern"
+        },
+        "margin-right": {
+          "description": "Defines the margin on the right side of an element.",
+          "$ref": "#/definitions/negativeLengthPattern"
+        },
+        "margin-bottom": {
+          "description": "Defines the margin on the bottom side of an element.",
+          "$ref": "#/definitions/negativeLengthPattern"
+        },
+        "margin-left": {
+          "description": "Defines the margin on the left side of an element.",
+          "$ref": "#/definitions/negativeLengthPattern"
+        },
+        "margin-block-start": {
+          "description": "Defines the logical block start margin of an element, translating to physical margin based on the element's writing mode, text direction, and text orientation.",
+          "$ref": "#/definitions/negativeLengthPattern"
+        },
+        "margin-block-end": {
+          "description": "Defines the logical block end margin of an element, translating to physical margin based on the element's writing mode, text direction, and text orientation.",
+          "$ref": "#/definitions/negativeLengthPattern"
+        },
+        "margin-block": {
+          "type": "string",
+          "description": "Shorthand that defines the logical block start and end margins of an element, translating to physical margin based on the element's writing mode, text direction, and text orientation.",
+          "pattern": "^(-?[0-9]+(px|%) ?){1,2}$"
+        },
+        "margin-inline-start": {
+          "description": "Defines the logical inline start margin of an element, translating to physical margin based on the element's writing mode, text direction, and text orientation.",
+          "$ref": "#/definitions/negativeLengthPattern"
+        },
+        "margin-inline-end": {
+          "description": "Defines the logical inline end margin of an element, translating to physical margin based on the element's writing mode, text direction, and text orientation.",
+          "$ref": "#/definitions/negativeLengthPattern"
+        },
+        "margin-inline": {
+          "type": "string",
+          "description": "Shorthand that defines both the logical inline start and end margins of an element, translating to physical margin based on the element's writing mode, text direction, and text orientation.",
+          "pattern": "^(-?[0-9]+(px|%) ?){1,2}$"
+        }
+      }
+    },
+
     "options": {
@@ -904,0 +1313,0 @@ "description": "Takes an array of `value`/`label` definitions.",

data/tags.json

 [
   {
+    "category": "theme",
+    "deprecated": false,
+    "deprecation_reason": "",
+    "description": "<aside class=\"note beta\">\n  <h4>Developer preview</h4>\n  <p>This tag is only available as part of the <a href=\"/storefronts/themes/architecture/blocks/theme-blocks/developer-preview\">Theme blocks developer preview</a>.</p>\n</aside>\n\nThe content_for tag requires a type to indicate whether it will render a single static block or a number of theme blocks defined in the JSON templates or section groups.\n\n- [`blocks`](/docs/api/liquid/tags/content_for#content_for-blocks)\n- [`block`](/docs/api/liquid/tags/content_for#content_for-block)",
+    "parameters": [
+
+    ],
+    "summary": "Creates a surface for rendering a block or blocks.",
+    "name": "content_for",
+    "syntax": "{% content_for 'blocks' %}\n{% content_for 'block', type: \"\", id: \"\" %}",
+    "syntax_keywords": [
+
+    ],
+    "examples": [
+      {
+        "name": "blocks",
+        "description": "Renders block elements within sections or other blocks as configured in the JSON template or section groups. See [theme blocks](/themes/architecture/blocks/theme-blocks) to see how to create theme blocks that can be used this way.\n",
+        "syntax": "{% content_for \"blocks\" %}\n",
+        "path": "/",
+        "raw_liquid": "",
+        "parameter": false,
+        "display_type": "text",
+        "show_data_tab": true
+      },
+      {
+        "name": "block",
+        "description": "Renders a static theme block within `sections` or `theme blocks`.\n",
+        "syntax": "{% content_for \"block\", type: \"button\", id: \"static-block-1\" %}\n",
+        "path": "/",
+        "raw_liquid": "",
+        "parameter": false,
+        "display_type": "text",
+        "show_data_tab": true
+      }
+    ]
+  },
+  {
     "category": "html",
@@ -4,0 +41,0 @@ "deprecated": false,

package.json

 {
   "name": "@shopify/theme-check-docs-updater",
-  "version": "2.8.0",
+  "version": "2.9.0",
   "description": "Scripts to initialize theme-check data with assets from the theme-liquid-docs repo.",
@@ -33,3 +33,3 @@ "main": "dist/index.js",
   "dependencies": {
-    "@shopify/theme-check-common": "^2.8.0",
+    "@shopify/theme-check-common": "^2.9.0",
     "env-paths": "^2.2.1",
@@ -36,0 +36,0 @@ "node-fetch": "^2.6.11"

No alert changes

Improved metrics

Total package byte prevSize

1376391

increased by5.9%

Lines of code

34007

increased by6.9%

Dependency changes

• Updated@shopify/theme-check-common@^2.9.0