@aurelienbn/oxlint-plugin-shopify-app (英语)

27 oxlint规则为 Shopify apps和扩展:App Store的静态切片,为 Shopify所建,Admin API,以及Polaris App Home的要求.

[尖叫声] Passing lint 并不能让 App Store 或为 Shopify 所建的应用程序符合条件 . 这些规则只执行静态可核查部件.

pnpm add -D @aurelienbbn/oxlint-plugin-shopify-app oxlint   # oxlint >=1.82.0 <2.0.0

没有预设, 无自定义:每个更改都意味着选择一个API,内容,布局,或运行时间策略.

27个规则,4个范围

server baseline   ███████          7   every app, server + route source
App Home recipe   █████████████   13   + 14 jsx-a11y, App Home paths only
category opt-in   ████             4   overrides on the paths the BFS category covers
other opt-in      ███              3   Function source · Polaris manifest · 1 candidate

规则从来不推断应用类别或扩展目标. 你决定,然后范围与 overrides。 。 。 .

服务器基线:每个应用程序,不需要决定

{
  "jsPlugins": ["@aurelienbbn/oxlint-plugin-shopify-app"],
  "rules": {
    "shopify-app/no-script-tag-api": "error",
    "shopify-app/require-mutation-user-errors": "error",
    "shopify-app/require-idempotent-mutations": "error",
    "shopify-app/no-swallowed-auth-response": "error",
    "shopify-app/no-hardcoded-billing-test-mode": "error",
    "shopify-app/webhook-hmac-verification-shape": "error",
    "shopify-app/no-router-redirect-in-embedded-route": "warn"
  }
}

`mutation($id: ID!, $tags: [String!]!) { tagsAdd(id: $id, tags: $tags) { node { id } } }`; // ❌ no userErrors
`mutation { tagsAdd(id: 1, tags: []) { node { id } userErrors { field message } } }`; // ✅

`mutation($input: RefundInput!) { refundCreate(input: $input) { refund { id } userErrors { message } } }`; // ❌ missingIdempotent
`mutation($input: RefundInput!) { refundCreate(input: $input) @idempotent(key: "4f5b6ebf-143c-4da5-8d0f-fb8553bfd85d") { refund { id } } }`; // ❌ literalIdempotencyKey
`mutation($input: RefundInput!, $key: String!) { refundCreate(input: $input) @idempotent(key: $key) { refund { id } } }`; // ✅

try {
  const { admin } = await authenticate.admin(request);
  return admin;
} catch (error) {
  return data({ error: "Something went wrong" }, { status: 500 });
} // ❌ swallows the Response
try {
  await authenticate.admin(request);
} catch (error) {
  if (error instanceof Response) throw error;
  return null;
} // ✅

await billing.require({ plans: [PRO], isTest: true, onFailure }); // ❌ never bills

同上:规则来源中的一个日期表. 发布2025-12-12,审查2026-09-20,要求行政API 2026-04脚本标签 停止运行于2027-03-01: 基线,不是BFS选入.

App 家食谱:Polaris + 原生 a11y

复制已测试的 应用 家食谱在 App Home 源码上运行 :

oxlint --config app-home.oxlintrc.json app

app-home.oxlintrc.json
├── jsx-a11y (14 upstream rules)   native HTML accessibility
└── shopify-app (13 rules)         Polaris App Home v1.0 contracts
      no-nav-emoji · no-viewport-zoom-disable · s-action-slot-contract
      s-button-accessible-name · s-button-submit-no-navigation · s-clickable-accessible-name
      s-form-control-label-required · s-modal-actions-use-slots · s-modal-heading-required
      s-money-field-no-currency-symbol (warn) · s-page-aside-visible
      s-spinner-accessible-label · s-tooltip-no-interactive-content

把这个食谱放在App Home上. 离职和客户账户部分有不同的合同.

<s-button icon="edit" />                                     // ❌ s-button-accessible-name
<s-button icon="edit" accessibilityLabel="Edit product" />   // ✅

<s-text-field labelAccessibilityVisibility="exclusive" />        // ❌ hiding the label doesn't remove the need for one
<s-search-field label="Search" labelAccessibilityVisibility="exclusive" /> // ✅

<s-money-field label="Price ($)" />                              // ❌ currency formatting is component-owned

仅静态:静态诊断不能证明已形成状态.

类别选择:首先决定

[尖叫声] 永远不要用被子瞄准 extensions/**数字 : 无法分辨出退出、客户账户、管理员、函数和主题.

其他选入

functions-no-unavailable-runtime-apis 打开 仅限 JS 函数来源。 。 。 . s-known-components 在App Home的源头, 除了食谱 no-session-or-token-logging 是一个候选人,默认关闭.

<s-stak gap="base" />                           // ❌ unknown element
<s-button varient="primary">Save</s-button>     // ❌ unknown attribute
<s-button variant="primary" onClick={save}>Save</s-button> // ✅ declared attribute and event

s-known-components 从您的项目中读取其词汇, 从此软件包中读取 : 自定义元素表单 customElements 已安装的最近字段 @shopify/polaris-types (1.0.7及后). 它跟随你安装的主线. 没有包裹,或者没有 customElements 字段:规则保持沉默. 明确 manifestPath 无法读取,或者一个没有元素的表, 报告每个文件一次.

每条规则独立执行 Shopify 文档概念; 源文件带有 greppable @attribution 标签; 没有执行或推销.

登记的合同库存

从软件包导出 pnpm catalog. 规则特定选项和限制在上文和源测试中都有描述.

信用概念

• https://github.com/Shophify/shopify-app-js (中文(简体) ) (激励;独立执行)
• https://github.com/Shophify/shopify-app-template-resact-router 互联网档案馆的存檔,存档日期2013-12-22 (激励;独立执行)
• https://github.com/web组件/客户-要素-功能 (激励;独立执行)
• https://shopify.dev/changelog/making-idempotency-monor-for-infor-instory-调整-和 -- refund-muutations 互联网档案馆的存檔,存档日期2013-12-22 (激励;独立执行)
• https://shopify.dev/changelog/online-store-script-tags-deprencation 互联网档案馆的存檔,存档日期2014-12-22 (激励;独立执行)
• https://shopify.dev/docs/api/admin-graphql/latest (中文(简体) ) (激励;独立执行)
• 页:1 (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件 (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/动作/按钮 (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/动作/按钮#财产-财产-财产-细节-类型 (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/动作/可点击 (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/feedback-和-status-indicators/spinner 互联网档案馆的存檔,存档日期2013-12-02 (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/形式/投放区 (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/形式/钱田 (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/形式/switch (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/形式/文本-字段 (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/layout-和-structure/page#slots (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/layout-and-structure/page#slots-slotdetail-aside 页面存档备份,存于互联网档案馆 互联网档案馆 (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/重叠/模式 (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/覆盖/模式#slots (激励;独立执行)
• https://shopify.dev/docs/api/app-home/latest/web-组件/打字法-和-content/tooltip (激励;独立执行)
• https://shopify.dev/docs/api/shopify-app-react-router/latest/apis/billing 互联网档案馆的存檔,存档日期2014-12-02 (激励;独立执行)
• https://shopify.dev/docs/api/usage/ 执行-意识形态 (激励;独立执行)
• https://shopify.dev/docs/apps/building/函数/输入-输出 (激励;独立执行)
• https://shopify.dev/docs/apps/building/函数/programming-languages/javascript- for-函数 (激励;独立执行)
• https://shopify.dev/docs/apps/building/webhooks/订阅/https (激励;独立执行)
• https://shopify.dev/docs/apps/launch/被保护客户数据 (激励;独立执行)