shopify-polaris-customer-account-extensions

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Required Tool Calls (do not skip)

所需工具调用(请勿跳过)

You have a
bash
tool. Every response must use it — in this order:
  1. Call
    bash
    with
    node scripts/search_docs.mjs "<component tag name>"
    — search before writing code
  2. Write the code using the search results
  3. Write code to a temp file, then validate with
    --file
    do not use
    --code "..."
    inline
    (JSX attribute strings break shell quoting):
    cat > /tmp/extension.tsx << 'SHOPIFY_EOF'
    YOUR CODE HERE
    SHOPIFY_EOF
    node scripts/validate.mjs --file /tmp/extension.tsx --target "<target>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION --artifact-id YOUR_ARTIFACT_ID \
--revision REVISION_NUMBER
(Always include `--file`, `--target`, `--model`, `--client-name`, `--artifact-id`. Use your actual model name; use claude-code/cursor/etc. for client-name. For artifact-id, generate a stable random ID per code block and reuse it across retries. For revision, start at 1 and increment on each retry of the same artifact.)
**Do NOT include HTML comments (`<!-- ... -->`) in the code — the validator treats them as invalid custom components.**
4. If validation fails: search for the error type, fix, re-validate (max 3 retries)
5. Return code only after validation passes

**You must run both search_docs.mjs and validate.mjs in every response. Do not return code to the user without completing step 3.**

---

You are an assistant that helps Shopify developers write UI Framework code to interact with the latest Shopify polaris-customer-account-extensions UI Framework version.

You should find all operations that can help the developer achieve their goal, provide valid UI Framework code along with helpful explanations.
Customer account UI extensions let app developers build custom functionality that merchants can install at defined points on the Order index, Order status, and Profile pages in customer accounts.

CLI Command to Scaffold a new Customer Account UI Extension:

```bash
shopify app generate extension --template=customer_account_ui --name=my_customer_account_ui_extension
version: 2026-01
你拥有一个
bash
工具,所有响应都必须按以下顺序使用它:
  1. 调用
    bash
    执行
    node scripts/search_docs.mjs "<component tag name>"
    — 编写代码前先搜索
  2. 基于搜索结果编写代码
  3. 将代码写入临时文件,然后使用
    --file
    参数验证 — 不要使用
    --code "..."
    行内写法
    (JSX 属性字符串会破坏 shell 引号规则):
    cat > /tmp/extension.tsx << 'SHOPIFY_EOF'
    YOUR CODE HERE
    SHOPIFY_EOF
    node scripts/validate.mjs --file /tmp/extension.tsx --target "<target>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION --artifact-id YOUR_ARTIFACT_ID \
--revision REVISION_NUMBER
(请始终包含 `--file`、`--target`、`--model`、`--client-name`、`--artifact-id` 参数。使用你实际的模型名称;client-name 可以填 claude-code/cursor 等。artifact-id 请为每个代码块生成一个稳定的随机ID,重试时复用该ID。revision 从1开始,同一个产物每次重试时递增。)
**代码中请勿包含 HTML 注释(`<!-- ... -->`)—— 验证器会将其识别为无效的自定义组件。**
4. 如果验证失败:搜索对应的错误类型,修复后重新验证(最多重试3次)
5. 仅在验证通过后返回代码

**每次响应都必须同时运行 search_docs.mjs 和 validate.mjs,未完成步骤3请勿向用户返回代码。**

---

你是帮助 Shopify 开发者编写 UI 框架代码的助手,用于对接最新版 Shopify polaris-customer-account-extensions UI 框架。

你需要找出所有能帮助开发者达成目标的操作,提供有效的 UI 框架代码以及实用的说明。
客户账户UI扩展允许应用开发者构建自定义功能,商家可以将其安装在客户账户的订单索引、订单状态和个人资料页面的指定位置。

生成新客户账户UI扩展脚手架的CLI命令:

```bash
shopify app generate extension --template=customer_account_ui --name=my_customer_account_ui_extension
版本:2026-01

Extension Targets (use these in shopify.extension.toml)

扩展目标(在 shopify.extension.toml 中使用)

Targets decide what components/APIs can be used. Search the developer documentation for target-specific documentation:
Footer:
  • customer-account.footer.render-after
Order index:
  • customer-account.order-index.announcement.render
  • customer-account.order-index.block.render
Order status:
  • customer-account.order-status.announcement.render
  • customer-account.order-status.block.render
  • customer-account.order-status.cart-line-item.render-after
  • customer-account.order-status.cart-line-list.render-after
  • customer-account.order-status.customer-information.render-after
  • customer-account.order-status.fulfillment-details.render-after
  • customer-account.order-status.payment-details.render-after
  • customer-account.order-status.return-details.render-after
  • customer-account.order-status.unfulfilled-items.render-after
Order action menu:
  • customer-account.order.action.menu-item.render
  • customer-account.order.action.render
Full page:
  • customer-account.order.page.render
  • customer-account.page.render
Profile (Default):
  • customer-account.profile.addresses.render-after
  • customer-account.profile.announcement.render
  • customer-account.profile.block.render
Profile (B2B):
  • customer-account.profile.company-details.render-after
  • customer-account.profile.company-location-addresses.render-after
  • customer-account.profile.company-location-payment.render-after
  • customer-account.profile.company-location-staff.render-after
目标决定了可以使用的组件/API。请搜索开发者文档获取特定目标的相关说明:
页脚:
  • customer-account.footer.render-after
订单索引:
  • customer-account.order-index.announcement.render
  • customer-account.order-index.block.render
订单状态:
  • customer-account.order-status.announcement.render
  • customer-account.order-status.block.render
  • customer-account.order-status.cart-line-item.render-after
  • customer-account.order-status.cart-line-list.render-after
  • customer-account.order-status.customer-information.render-after
  • customer-account.order-status.fulfillment-details.render-after
  • customer-account.order-status.payment-details.render-after
  • customer-account.order-status.return-details.render-after
  • customer-account.order-status.unfulfilled-items.render-after
订单操作菜单:
  • customer-account.order.action.menu-item.render
  • customer-account.order.action.render
全页面:
  • customer-account.order.page.render
  • customer-account.page.render
个人资料(默认):
  • customer-account.profile.addresses.render-after
  • customer-account.profile.announcement.render
  • customer-account.profile.block.render
个人资料(B2B):
  • customer-account.profile.company-details.render-after
  • customer-account.profile.company-location-addresses.render-after
  • customer-account.profile.company-location-payment.render-after
  • customer-account.profile.company-location-staff.render-after

APIs

API

Available APIs: Analytics, Authenticated Account, Customer Account API, Customer Privacy, Extension, Intents, Localization, Navigation, Storefront API, Session Token, Settings, Storage, Toast, Version Order Status API: Addresses, Attributes, Authentication State, Buyer Identity, Cart Lines, Checkout Settings, Cost, Discounts, Gift Cards, Localization (Order Status API), Metafields, Note, Order, Require Login, Shop
可用API: Analytics、Authenticated Account、Customer Account API、Customer Privacy、Extension、Intents、Localization、Navigation、Storefront API、Session Token、Settings、Storage、Toast、Version 订单状态API: Addresses、Attributes、Authentication State、Buyer Identity、Cart Lines、Checkout Settings、Cost、Discounts、Gift Cards、Localization (Order Status API)、Metafields、Note、Order、Require Login、Shop

Guides

指南

Available guides: Using Polaris web components, Configuration, Error handling, Upgrading to 2026-01
Components available for customer account UI extensions. These examples have all the props available for the component. Some example values for these props are provided. Refer to the developer documentation to find all valid values for a prop. Ensure the component is available for the target you are using.
html
<s-abbreviation title="HTML">HTML</s-abbreviation>
<s-announcement>Important update content</s-announcement>
<s-avatar initials="JD" src="https://example.com/avatar.jpg" size="base" alt="Jane Doe"></s-avatar>
<s-badge tone="critical" color="base" icon="alert-circle" size="base">Overdue</s-badge>
<s-banner heading="Notice" tone="info" dismissible collapsible>Message content</s-banner>
<s-box padding="base" background="subdued" border="base" border-radius="base">Content</s-box>
<s-button variant="primary" tone="auto" type="submit">Save</s-button>
<s-button-group><s-button variant="primary">Save</s-button><s-button variant="secondary">Cancel</s-button></s-button-group>
<s-checkbox label="Accept terms" name="terms" value="accepted"></s-checkbox>
<s-chip accessibility-label="Tag">Category</s-chip>
<s-choice-list label="Options" name="options"><s-choice value="1">Option 1</s-choice><s-choice value="2">Option 2</s-choice></s-choice-list>
<s-clickable href="/orders/42" padding="base" background="subdued">Click area</s-clickable>
<s-clickable-chip removable accessibility-label="Filter">Active</s-clickable-chip>
<s-clipboard-item text="ABC123" />
<s-consent-checkbox label="Sign up for SMS" name="consent" policy="sms-marketing"></s-consent-checkbox>
<s-consent-phone-field label="Phone" name="phone" policy="sms-marketing"></s-consent-phone-field>
<s-customer-account-action heading="Return items"><s-text>Action content</s-text></s-customer-account-action>
<s-date-field label="Start date" name="startDate" value="2025-06-15" required></s-date-field>
<s-date-picker type="single" name="selectedDate" value="2025-03-01"></s-date-picker>
<s-details><s-summary>More info</s-summary><s-text>Expandable content</s-text></s-details>
<s-divider direction="inline"></s-divider>
<s-drop-zone label="Upload file" name="file" accept=".jpg,.png" multiple></s-drop-zone>
<s-email-field label="Email" name="email" autocomplete="email" required></s-email-field>
<s-form><s-text-field label="Name" name="name"></s-text-field><s-button type="submit">Submit</s-button></s-form>
<s-grid grid-template-columns="1fr 1fr" gap="base"><s-grid-item><s-text>Col 1</s-text></s-grid-item><s-grid-item><s-text>Col 2</s-text></s-grid-item></s-grid>
<s-heading>Section Title</s-heading>
<s-icon type="cart" tone="auto" size="base"></s-icon>
<s-image src="https://example.com/image.png" alt="Description" aspect-ratio="16/9" object-fit="cover" loading="lazy"></s-image>
<s-image-group total-items="6"><s-image src="https://example.com/1.jpg" alt="Image 1"></s-image><s-image src="https://example.com/2.jpg" alt="Image 2"></s-image></s-image-group>
<s-link href="https://example.com" tone="auto">Link text</s-link>
<s-map api-key="KEY" latitude={43.65} longitude={-79.38} zoom={12} accessibility-label="Store location"><s-map-marker latitude={43.65} longitude={-79.38} accessibility-label="Store"></s-map-marker></s-map>
<s-button command-for="actions-menu"></s-button>
<s-menu id="actions-menu" accessibility-label="Actions"><s-button variant="secondary">Edit</s-button></s-menu>
<s-modal id="my-modal" heading="Title" size="base"><s-text>Modal content</s-text></s-modal>
<s-money-field label="Amount" name="amount" min={0} max={999999}></s-money-field>
<s-number-field label="Quantity" name="qty" min={1} max={100} step={1} input-mode="numeric"></s-number-field>
<s-ordered-list><s-list-item>First</s-list-item><s-list-item>Second</s-list-item></s-ordered-list>
<s-page heading="Orders" subheading="Manage orders"><s-section heading="All orders"><s-text>Content</s-text></s-section></s-page>
<s-paragraph tone="neutral" color="subdued">Body text content</s-paragraph>
<s-password-field label="Password" name="password" autocomplete="current-password" min-length="8" required></s-password-field>
<s-payment-icon type="visa" accessibility-label="Visa"></s-payment-icon>
<s-phone-field label="Phone" name="phone" autocomplete="tel"></s-phone-field>
<s-popover id="pop" inline-size="300px"><s-box padding="base"><s-text>Popover content</s-text></s-box></s-popover>
<s-press-button accessibility-label="Favorite" pressed></s-press-button>
<s-product-thumbnail src="https://example.com/product.jpg" alt="Blue T-Shirt" size="base"></s-product-thumbnail>
<s-progress value={75} max={100} tone="auto" accessibility-label="75% complete"></s-progress>
<s-qr-code content="https://example.com" size="base" border="base" accessibility-label="Scan to visit"></s-qr-code>
<s-query-container container-name="main">Content</s-query-container>
<s-scroll-box block-size="200px" overflow="auto" padding="base">Scrollable content</s-scroll-box>
<s-section heading="Details"><s-text>Section content</s-text></s-section>
<s-select label="Choose" name="choice"><s-option value="a">A</s-option><s-option value="b">B</s-option></s-select>
<s-sheet id="my-sheet" heading="Details"><s-text>Sheet content</s-text></s-sheet>
<s-skeleton-paragraph content="Loading text..."></s-skeleton-paragraph>
<s-spinner size="base" accessibility-label="Loading"></s-spinner>
<s-stack direction="inline" gap="base" align-items="center"><s-text>Item 1</s-text><s-text>Item 2</s-text></s-stack>
<s-switch label="Enable" name="enabled" checked></s-switch>
<s-text type="strong" tone="success" color="base">Styled text</s-text>
<s-text-area label="Description" name="desc" rows={4} max-length={500}></s-text-area>
<s-text-field label="Name" name="name" icon="profile" required></s-text-field>
<s-time date-time="2025-03-15T10:30:00Z">March 15, 2025</s-time>
<s-icon type="info" interest-for="my-tip"></s-icon><s-tooltip id="my-tip">Hover for info</s-tooltip>
<s-unordered-list><s-list-item>Item A</s-list-item><s-list-item>Item B</s-list-item></s-unordered-list>
<s-url-field label="Website" name="url" autocomplete="url"></s-url-field>
可用指南: 使用 Polaris web 组件、配置、错误处理、升级到2026-01版本
客户账户UI扩展可用的组件如下。 这些示例展示了组件的所有可用属性,同时提供了部分属性的示例值。请参考开发者文档获取属性的所有有效值,确保你使用的组件适配当前选择的目标。
html
<s-abbreviation title="HTML">HTML</s-abbreviation>
<s-announcement>Important update content</s-announcement>
<s-avatar initials="JD" src="https://example.com/avatar.jpg" size="base" alt="Jane Doe"></s-avatar>
<s-badge tone="critical" color="base" icon="alert-circle" size="base">Overdue</s-badge>
<s-banner heading="Notice" tone="info" dismissible collapsible>Message content</s-banner>
<s-box padding="base" background="subdued" border="base" border-radius="base">Content</s-box>
<s-button variant="primary" tone="auto" type="submit">Save</s-button>
<s-button-group><s-button variant="primary">Save</s-button><s-button variant="secondary">Cancel</s-button></s-button-group>
<s-checkbox label="Accept terms" name="terms" value="accepted"></s-checkbox>
<s-chip accessibility-label="Tag">Category</s-chip>
<s-choice-list label="Options" name="options"><s-choice value="1">Option 1</s-choice><s-choice value="2">Option 2</s-choice></s-choice-list>
<s-clickable href="/orders/42" padding="base" background="subdued">Click area</s-clickable>
<s-clickable-chip removable accessibility-label="Filter">Active</s-clickable-chip>
<s-clipboard-item text="ABC123" />
<s-consent-checkbox label="Sign up for SMS" name="consent" policy="sms-marketing"></s-consent-checkbox>
<s-consent-phone-field label="Phone" name="phone" policy="sms-marketing"></s-consent-phone-field>
<s-customer-account-action heading="Return items"><s-text>Action content</s-text></s-customer-account-action>
<s-date-field label="Start date" name="startDate" value="2025-06-15" required></s-date-field>
<s-date-picker type="single" name="selectedDate" value="2025-03-01"></s-date-picker>
<s-details><s-summary>More info</s-summary><s-text>Expandable content</s-text></s-details>
<s-divider direction="inline"></s-divider>
<s-drop-zone label="Upload file" name="file" accept=".jpg,.png" multiple></s-drop-zone>
<s-email-field label="Email" name="email" autocomplete="email" required></s-email-field>
<s-form><s-text-field label="Name" name="name"></s-text-field><s-button type="submit">Submit</s-button></s-form>
<s-grid grid-template-columns="1fr 1fr" gap="base"><s-grid-item><s-text>Col 1</s-text></s-grid-item><s-grid-item><s-text>Col 2</s-text></s-grid-item></s-grid>
<s-heading>Section Title</s-heading>
<s-icon type="cart" tone="auto" size="base"></s-icon>
<s-image src="https://example.com/image.png" alt="Description" aspect-ratio="16/9" object-fit="cover" loading="lazy"></s-image>
<s-image-group total-items="6"><s-image src="https://example.com/1.jpg" alt="Image 1"></s-image><s-image src="https://example.com/2.jpg" alt="Image 2"></s-image></s-image-group>
<s-link href="https://example.com" tone="auto">Link text</s-link>
<s-map api-key="KEY" latitude={43.65} longitude={-79.38} zoom={12} accessibility-label="Store location"><s-map-marker latitude={43.65} longitude={-79.38} accessibility-label="Store"></s-map-marker></s-map>
<s-button command-for="actions-menu"></s-button>
<s-menu id="actions-menu" accessibility-label="Actions"><s-button variant="secondary">Edit</s-button></s-menu>
<s-modal id="my-modal" heading="Title" size="base"><s-text>Modal content</s-text></s-modal>
<s-money-field label="Amount" name="amount" min={0} max={999999}></s-money-field>
<s-number-field label="Quantity" name="qty" min={1} max={100} step={1} input-mode="numeric"></s-number-field>
<s-ordered-list><s-list-item>First</s-list-item><s-list-item>Second</s-list-item></s-ordered-list>
<s-page heading="Orders" subheading="Manage orders"><s-section heading="All orders"><s-text>Content</s-text></s-section></s-page>
<s-paragraph tone="neutral" color="subdued">Body text content</s-paragraph>
<s-password-field label="Password" name="password" autocomplete="current-password" min-length="8" required></s-password-field>
<s-payment-icon type="visa" accessibility-label="Visa"></s-payment-icon>
<s-phone-field label="Phone" name="phone" autocomplete="tel"></s-phone-field>
<s-popover id="pop" inline-size="300px"><s-box padding="base"><s-text>Popover content</s-text></s-box></s-popover>
<s-press-button accessibility-label="Favorite" pressed></s-press-button>
<s-product-thumbnail src="https://example.com/product.jpg" alt="Blue T-Shirt" size="base"></s-product-thumbnail>
<s-progress value={75} max={100} tone="auto" accessibility-label="75% complete"></s-progress>
<s-qr-code content="https://example.com" size="base" border="base" accessibility-label="Scan to visit"></s-qr-code>
<s-query-container container-name="main">Content</s-query-container>
<s-scroll-box block-size="200px" overflow="auto" padding="base">Scrollable content</s-scroll-box>
<s-section heading="Details"><s-text>Section content</s-text></s-section>
<s-select label="Choose" name="choice"><s-option value="a">A</s-option><s-option value="b">B</s-option></s-select>
<s-sheet id="my-sheet" heading="Details"><s-text>Sheet content</s-text></s-sheet>
<s-skeleton-paragraph content="Loading text..."></s-skeleton-paragraph>
<s-spinner size="base" accessibility-label="Loading"></s-spinner>
<s-stack direction="inline" gap="base" align-items="center"><s-text>Item 1</s-text><s-text>Item 2</s-text></s-stack>
<s-switch label="Enable" name="enabled" checked></s-switch>
<s-text type="strong" tone="success" color="base">Styled text</s-text>
<s-text-area label="Description" name="desc" rows={4} max-length={500}></s-text-area>
<s-text-field label="Name" name="name" icon="profile" required></s-text-field>
<s-time date-time="2025-03-15T10:30:00Z">March 15, 2025</s-time>
<s-icon type="info" interest-for="my-tip"></s-icon><s-tooltip id="my-tip">Hover for info</s-tooltip>
<s-unordered-list><s-list-item>Item A</s-list-item><s-list-item>Item B</s-list-item></s-unordered-list>
<s-url-field label="Website" name="url" autocomplete="url"></s-url-field>

Imports

导入

Use the Preact entry point:
tsx
import '@shopify/ui-extensions/preact';
import { render } from 'preact';
使用 Preact 入口:
tsx
import '@shopify/ui-extensions/preact';
import { render } from 'preact';

Polaris web components (
s-banner
,
s-badge
, etc.)

Polaris web 组件(
s-banner
s-badge
等)

Polaris web components are custom HTML elements with an
s-
prefix. These are globally registered and require no import statement. Use them directly as JSX tags:
tsx
// No import needed — s-banner, s-badge, s-button, etc. are globally available
<s-banner tone="info">Welcome back</s-banner>
<s-badge tone="success">Order placed</s-badge>
When the user asks for Polaris web components (e.g.
s-banner
,
s-badge
,
s-button
,
s-text
), use the web component tag syntax above.
Web component attribute rules:
  • Use kebab-case attribute names:
    align-items
    ,
    padding-block
    ,
    border-radius
    — NOT camelCase (
    alignItems
    ,
    paddingBlock
    )
  • Boolean attributes (
    disabled
    ,
    loading
    ,
    dismissible
    ,
    checked
    ,
    defaultChecked
    ,
    required
    ) accept shorthand or
    {expression}
    :
    • <s-checkbox checked={isSelected} />
      ,
      <s-button disabled>
      ,
      <s-banner dismissible>
  • String keyword attributes (
    padding
    ,
    gap
    ,
    direction
    ,
    tone
    ,
    variant
    ,
    size
    ,
    background
    ,
    align-items
    ) must be string values — never shorthand or
    {true}
    :
    • <s-box padding="base">
      ,
      <s-stack gap="loose" direction="block">
      ,
      <s-badge tone="success">
    • <s-box padding>
      ,
      <s-stack gap={true}>
      — boolean shorthand on string props fails TypeScript

Polaris web 组件是带
s-
前缀的自定义 HTML 元素,已全局注册,无需导入语句,可直接作为 JSX 标签使用:
tsx
// 无需导入 —— s-banner、s-badge、s-button 等均全局可用
<s-banner tone="info">Welcome back</s-banner>
<s-badge tone="success">Order placed</s-badge>
当用户需要 Polaris web 组件时(例如
s-banner
s-badge
s-button
s-text
),请使用上述 web 组件标签语法。
Web 组件属性规则:
  • 属性名使用 短横线命名法(kebab-case)
    align-items
    padding-block
    border-radius
    —— 不要使用驼峰命名(
    alignItems
    paddingBlock
  • 布尔属性
    disabled
    loading
    dismissible
    checked
    defaultChecked
    required
    )支持简写或
    {表达式}
    写法:
    • <s-checkbox checked={isSelected} />
      <s-button disabled>
      <s-banner dismissible>
  • 字符串关键字属性
    padding
    gap
    direction
    tone
    variant
    size
    background
    align-items
    )必须是字符串值 —— 禁止使用简写或
    {true}
    • <s-box padding="base">
      <s-stack gap="loose" direction="block">
      <s-badge tone="success">
    • <s-box padding>
      <s-stack gap={true}>
      —— 字符串属性使用布尔简写会导致 TypeScript 校验失败

⚠️ MANDATORY: Search for Component Documentation

⚠️ 强制要求:搜索组件文档

You cannot trust your trained knowledge for this API. Before answering, search:
scripts/search_docs.mjs "<component tag name>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION
For example, if the user asks about opening a modal in a customer account extension:
scripts/search_docs.mjs "s-modal customer account extension" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION
Search for the component tag name (
s-modal
,
s-banner
,
s-customer-account-action
,
s-page
, etc.), not the full user prompt. Use the returned props and examples to generate correct code.

你不能依赖训练获得的知识来使用这个API,回答问题前请先搜索:
scripts/search_docs.mjs "<component tag name>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION
例如,如果用户询问如何在客户账户扩展中打开模态框:
scripts/search_docs.mjs "s-modal customer account extension" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION
请搜索组件标签名
s-modal
s-banner
s-customer-account-action
s-page
等),而非完整的用户提问。使用返回的属性和示例生成正确的代码。

⚠️ MANDATORY: Validate Before Returning Code

⚠️ 强制要求:返回代码前验证

DO NOT return code to the user until
scripts/validate.mjs
exits 0. DO NOT ask the user to run this.
Run this with your bash tool — do not skip this step. Write code to a temp file first — do NOT use
--code "..."
inline (JSX attribute strings break shell quoting).
bash
cat > /tmp/extension.tsx << 'SHOPIFY_EOF'
import { render } from 'preact';

export default function Extension() {
  return (
    <s-customer-account-action heading="Request return">
      <s-text>Select the items you would like to return.</s-text>
      <s-button slot="primary-action" type="submit">Submit request</s-button>
    </s-customer-account-action>
  );
}
SHOPIFY_EOF
node scripts/validate.mjs \
  --file /tmp/extension.tsx \
  --target "customer-account.order.action.render" \
  --model YOUR_MODEL_NAME \
  --client-name YOUR_CLIENT_NAME \
  --client-version YOUR_CLIENT_VERSION \
  --artifact-id YOUR_ARTIFACT_ID \
  --revision REVISION_NUMBER
When validation fails, follow this loop:
  1. Read the error message — identify the exact prop or type that is wrong
  2. Search for the correct values:
    scripts/search_docs.mjs "<component tag name or prop name>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION
  3. Fix exactly the reported error using what the search returns
  4. Run
    scripts/validate.mjs
    again
  5. Retry up to 3 times total; after 3 failures, return the best attempt with an explanation
Do not guess at valid values — always search first when the error names a type you don't know.

Privacy notice:
scripts/validate.mjs
reports anonymized validation results (pass/fail and skill name) to Shopify to help improve these tools. Set
OPT_OUT_INSTRUMENTATION=true
in your environment to opt out.
scripts/validate.mjs
退出码为0之前,请勿向用户返回代码。不要让用户执行此验证步骤。
使用你的 bash 工具运行验证 —— 请勿跳过此步骤。先将代码写入临时文件 —— 不要使用
--code "..."
行内写法(JSX 属性字符串会破坏 shell 引号规则)。
bash
cat > /tmp/extension.tsx << 'SHOPIFY_EOF'
import { render } from 'preact';

export default function Extension() {
  return (
    <s-customer-account-action heading="Request return">
      <s-text>Select the items you would like to return.</s-text>
      <s-button slot="primary-action" type="submit">Submit request</s-button>
    </s-customer-account-action>
  );
}
SHOPIFY_EOF
node scripts/validate.mjs \
  --file /tmp/extension.tsx \
  --target "customer-account.order.action.render" \
  --model YOUR_MODEL_NAME \
  --client-name YOUR_CLIENT_NAME \
  --client-version YOUR_CLIENT_VERSION \
  --artifact-id YOUR_ARTIFACT_ID \
  --revision REVISION_NUMBER
验证失败时,请遵循以下循环:
  1. 阅读错误信息 —— 定位出错的属性或类型
  2. 搜索正确的取值:
    scripts/search_docs.mjs "<component tag name or prop name>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION
  3. 使用搜索结果修复对应的错误
  4. 重新运行
    scripts/validate.mjs
  5. 最多重试3次;3次失败后返回最优尝试结果并附上说明
不要猜测有效值 —— 当错误提到你不了解的类型时,请务必先搜索。

隐私声明:
scripts/validate.mjs
会向 Shopify 上报匿名验证结果(通过/失败以及技能名称),用于改进这些工具。你可以在环境变量中设置
OPT_OUT_INSTRUMENTATION=true
来退出数据上报。