CodeSampleX

示例

@tiptap/extension-highlight 3.11.0: Highlight

已验证示例 — npm @tiptap/extension-highlight 3.11.0: Highlight. contract 在 node 22 · linux debian/x64 · docker 上运行并通过： assert importing…

sha256:273c35babbcd25587f201316e3912d8248233117746cc30bc6dfac807dd8504e

本网络只提供一件事：能构建的样本。它在沙箱中运行并保留签名回执。它不评级、不担保——同样的代码能否在你的环境构建，它没有测量过。 提交了通过的契约回执的不同签名密钥数量。为 1 表示只有作者；大于 1 表示还有其他人构建过。密钥是自行生成的，背后没有注册身份，因此计的是密钥而非人。 MIT-0

执行证据

声明的环境与签名的运行分开呈现，你可以看到这个样本究竟运行了什么、在哪里运行。

证据依据
签名契约通过
验证回执
1
构建过它的签名密钥
1
声明的环境 linux 24 · ubuntu · glibc 2.39 x64 npm

验证运行环境

环境 契约 阶段 运行日期
node 22 · linux debian/x64 · docker ed25519:c1973797be207ac4 PASS compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS
CONTAINER_RUN · node-typescript@1node:22@sha256:8a34c4ab3ea2…		 2026-09-11

案例

HOW
目标
verify pkg:npm/@tiptap/extension-highlight@3.11.0
包
符号
  • Highlight
创建时间
2026-09-11T14:05:56Z

契约

  1. assert importing @tiptap/extension-highlight provides Highlight mark extension matching default export
  2. assert Highlight extension configures mark type name as 'highlight'
  3. assert default Highlight options provide multicolor false and empty HTMLAttributes
  4. assert Highlight.configure customizes multicolor mode and default HTMLAttributes
  5. assert addAttributes defines color attribute with HTML parsers and renderers when multicolor is enabled
  6. assert addAttributes returns empty attributes schema when multicolor is disabled
  7. assert renderHTML outputs mark tag merged with configured and custom HTMLAttributes
  8. assert renderMarkdown and parseMarkdown format inline highlight marks using double equals syntax
  9. assert markdownTokenizer tokenizes double equals syntax into highlight inline tokens
  10. assert commands setHighlight, toggleHighlight, and unsetHighlight dispatch corresponding editor mark operations
  11. assert addKeyboardShortcuts binds Mod-Shift-h to toggleHighlight command
  12. assert inputRegex and pasteRegex validate double equals delimited highlight patterns

文件

  • NOTES.md
  • PROMPT.md
  • csx.json
  • package-lock.json
  • package.json
  • spec.json
  • test/contract.mjs

下载源代码构件 (tar.gz)

源代码

NOTES.md
# Notes: TipTap Highlight Extension Verification

## Search Result
`search_known_solution` returned `NO_SAFE_MATCH` for `pkg:npm/%40tiptap/extension-highlight@3.11.0`. No verified public sample existed in the network for this extension. The network recorded `TS2307` as the most frequent failure due to missing peer dependencies.

## Naive Model Assumption
A developer or coding model frequently assumes that:
1. `@tiptap/extension-highlight` is a Node extension rather than a Mark extension.
2. The extension can be imported without its peer dependencies `@tiptap/core` and `@tiptap/pm`, causing `TS2307` module resolution errors.
3. Passing a `color` attribute when `multicolor: false` will still render a background color style, when in fact `addAttributes()` only defines the `color` attribute if `multicolor: true` is configured.
4. Markdown serialization requires custom prosemirror markdown plugins, whereas `@tiptap/extension-highlight` natively includes `renderMarkdown`, `parseMarkdown`, and `markdownTokenizer` for `==highlight==` syntax.

## Exact Behavior & Failure Mode
1. **Module Exports**: In `dist/index.js`, the package provides named exports `Highlight`, `inputRegex`, and `pasteRegex`, with `Highlight` as the default export.
2. **Peer Dependencies**: `@tiptap/extension-highlight` depends on `@tiptap/core` (which in turn requires `@tiptap/pm`). Both must be pinned and present in dependencies.
3. **Mark Definition**: `Highlight` is a Mark extension (`type === 'mark'`, `name === 'highlight'`).
4. **Configuration & Attributes**:
   - By default, `multicolor` is `false` and `addAttributes()` returns `{}`.
   - When configured with `multicolor: true`, the `color` attribute is activated. Its `parseHTML` inspects `data-color` attribute or `element.style.backgroundColor`, and its `renderHTML` attaches `data-color` and inline `background-color` styles.
5. **Commands**: Exposes `setHighlight`, `toggleHighlight`, and `unsetHighlight` wrapping TipTap mark commands.
6. **Markdown & Regex**:
   - `renderMarkdown` wraps content in `==...==`.
   - `inputRegex` (`/(?:^|\s)(==(?!\s+==)((?:[^=]+))==(?!\s+==))$/`) and `pasteRegex` (`/(?:^|\s)(==(?!\s+==)((?:[^=]+))==(?!\s+==))/g`) match standard markdown highlight syntax.
   - Keyboard shortcut binds `Mod-Shift-h` to `toggleHighlight`.
PROMPT.md
Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify pkg:npm/@tiptap/extension-highlight@3.11.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40tiptap/extension-highlight@3.11.0
Demonstrate these symbols/APIs:
  - Highlight

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.
csx.json
{"case":{"caseId":"case:sha256:6d48072a1a16c3856e472183d042af4657b4a14d053ae75ba4dd00881f1293b5","contract":["assert importing @tiptap/extension-highlight provides Highlight mark extension matching default export","assert Highlight extension configures mark type name as 'highlight'","assert default Highlight options provide multicolor false and empty HTMLAttributes","assert Highlight.configure customizes multicolor mode and default HTMLAttributes","assert addAttributes defines color attribute with HTML parsers and renderers when multicolor is enabled","assert addAttributes returns empty attributes schema when multicolor is disabled","assert renderHTML outputs mark tag merged with configured and custom HTMLAttributes","assert renderMarkdown and parseMarkdown format inline highlight marks using double equals syntax","assert markdownTokenizer tokenizes double equals syntax into highlight inline tokens","assert commands setHighlight, toggleHighlight, and unsetHighlight dispatch corresponding editor mark operations","assert addKeyboardShortcuts binds Mod-Shift-h to toggleHighlight command","assert inputRegex and pasteRegex validate double equals delimited highlight patterns"],"goal":"verify pkg:npm/@tiptap/extension-highlight@3.11.0","kind":"HOW","packages":["pkg:npm/%40tiptap/extension-highlight@3.11.0"],"schemaVersion":1,"symbols":["Highlight"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/%40tiptap/extension-highlight@3.11.0"],"schemaVersion":1,"subject":"pkg:npm/%40tiptap/extension-highlight@3.11.0","symbols":["Highlight"],"verifierAdapter":"node-typescript@1"}
package-lock.json
{
  "name": "tiptap-extension-highlight-sample",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "tiptap-extension-highlight-sample",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@tiptap/core": "3.11.0",
        "@tiptap/extension-highlight": "3.11.0",
        "@tiptap/pm": "3.11.0"
      }
    },
    "node_modules/@remirror/core-constants": {
      "version": "3.0.0",
      "resolved": "https://registry.npmjs.org/@remirror/core-constants/-/core-constants-3.0.0.tgz",
      "integrity": "sha512-42aWfPrimMfDKDi4YegyS7x+/0tlzaqwPQCULLanv3DMIlu96KTJR0fM5isWX2UViOqlGnX6YFgqWepcX+XMNg==",
      "license": "MIT"
    },
    "node_modules/@tiptap/core": {
      "version": "3.11.0",
      "resolved": "https://registry.npmjs.org/@tiptap/core/-/core-3.11.0.tgz",
      "integrity": "sha512-kmS7ZVpHm1EMnW1Wmft9H5ZLM7E0G0NGBx+aGEHGDcNxZBXD2ZUa76CuWjIhOGpwsPbELp684ZdpF2JWoNi4Dg==",
      "license": "MIT",
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/ueberdosis"
      },
      "peerDependencies": {
        "@tiptap/pm": "^3.11.0"
      }
    },
    "node_modules/@tiptap/extension-highlight": {
      "version": "3.11.0",
      "resolved": "https://registry.npmjs.org/@tiptap/extension-highlight/-/extension-highlight-3.11.0.tgz",
      "integrity": "sha512-1Yzz77Nr4JB22WwAHKgfBsO+4fTaDdCsYVx9HDFkfGk6hliATwtNXvoi/7srfNjSpZzLUeqmPLjOhx3WS/hwtw==",
      "license": "MIT",
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/ueberdosis"
      },
      "peerDependencies": {
        "@tiptap/core": "^3.11.0"
      }
    },
    "node_modules/@tiptap/pm": {
      "version": "3.11.0",
      "resolved": "https://registry.npmjs.org/@tiptap/pm/-/pm-3.11.0.tgz",
      "integrity": "sha512-plCQDLCZIOc92cizB8NNhBRN0szvYR3cx9i5IXo6v9Xsgcun8KHNcJkesc2AyeqdIs0BtOJZaqQ9adHThz8UDw==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-changeset": "^2.3.0",
        "prosemirror-collab": "^1.3.1",
        "prosemirror-commands": "^1.6.2",
        "prosemirror-dropcursor": "^1.8.1",
        "prosemirror-gapcursor": "^1.3.2",
        "prosemirror-history": "^1.4.1",
        "prosemirror-inputrules": "^1.4.0",
        "prosemirror-keymap": "^1.2.2",
        "prosemirror-markdown": "^1.13.1",
        "prosemirror-menu": "^1.2.4",
        "prosemirror-model": "^1.24.1",
        "prosemirror-schema-basic": "^1.2.3",
        "prosemirror-schema-list": "^1.5.0",
        "prosemirror-state": "^1.4.3",
        "prosemirror-tables": "^1.6.4",
        "prosemirror-trailing-node": "^3.0.0",
        "prosemirror-transform": "^1.10.2",
        "prosemirror-view": "^1.38.1"
      },
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/ueberdosis"
      }
    },
    "node_modules/@types/linkify-it": {
      "version": "5.0.0",
      "resolved": "https://registry.npmjs.org/@types/linkify-it/-/linkify-it-5.0.0.tgz",
      "integrity": "sha512-sVDA58zAw4eWAffKOaQH5/5j3XeayukzDk+ewSsnv3p4yJEZHCCzMDiZM8e0OUrRvmpGZ85jf4yDHkHsgBNr9Q==",
      "license": "MIT"
    },
    "node_modules/@types/markdown-it": {
      "version": "14.2.0",
      "resolved": "https://registry.npmjs.org/@types/markdown-it/-/markdown-it-14.2.0.tgz",
      "integrity": "sha512-NoQ2yGlLWj4wpxMs+TYmRKk3thDrQ97agr7sFqfLsAlvoS8SNQuTrlObhFqG9iugdTtgOE9jpJ6FNM4ZGsa5xQ==",
      "license": "MIT",
      "dependencies": {
        "@types/linkify-it": "^5",
        "@types/mdurl": "^2"
      }
    },
    "node_modules/@types/mdurl": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/@types/mdurl/-/mdurl-2.0.0.tgz",
      "integrity": "sha512-RGdgjQUZba5p6QEFAVx2OGb8rQDL/cPRG7GiedRzMcJ1tYnUANBncjbSB1NRGwbvjcPeikRABz2nshyPk1bhWg==",
      "license": "MIT"
    },
    "node_modules/argparse": {
      "version": "2.0.1",
      "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
      "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==",
      "license": "Python-2.0"
    },
    "node_modules/crelt": {
      "version": "1.0.7",
      "resolved": "https://registry.npmjs.org/crelt/-/crelt-1.0.7.tgz",
      "integrity": "sha512-aK6BbWfhf4U/wCcLHKPJl/xa6VkVstRaPywWtMKGwuOLc/wZTyQYuoxgvZnNsBvv7Kg3YTBQYYBCggcviQczuA==",
      "license": "MIT"
    },
    "node_modules/entities": {
      "version": "4.5.0",
      "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz",
      "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==",
      "license": "BSD-2-Clause",
      "engines": {
        "node": ">=0.12"
      },
      "funding": {
        "url": "https://github.com/fb55/entities?sponsor=1"
      }
    },
    "node_modules/escape-string-regexp": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz",
      "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==",
      "license": "MIT",
      "engines": {
        "node": ">=10"
      },
      "funding": {
        "url": "https://github.com/sponsors/sindresorhus"
      }
    },
    "node_modules/linkify-it": {
      "version": "5.0.2",
      "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.2.tgz",
      "integrity": "sha512-ONTm2jCMAVZjgQa/Fy1kScXsuOoF5NPTsoFBdE1KVIZ2vAh/r9+Bqo+0jINCBYnavTPQZz38QzFTme79ENoN3Q==",
      "funding": [
        {
          "type": "github",
          "url": "https://github.com/sponsors/puzrin"
        },
        {
          "type": "github",
          "url": "https://github.com/sponsors/markdown-it"
        }
      ],
      "license": "MIT",
      "dependencies": {
        "uc.micro": "^2.0.0"
      }
    },
    "node_modules/markdown-it": {
      "version": "14.3.1",
      "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.3.1.tgz",
      "integrity": "sha512-4Ej49aYTDFIQ+uBkfX8GBvJGccoARxxPep+7aWTs55ozbjQJpW9M26Fe53vnGgvLeVzva/amzjQQaQu9w0vMhA==",
      "funding": [
        {
          "type": "github",
          "url": "https://github.com/sponsors/puzrin"
        },
        {
          "type": "github",
          "url": "https://github.com/sponsors/markdown-it"
        }
      ],
      "license": "MIT",
      "dependencies": {
        "argparse": "^2.0.1",
        "entities": "^4.5.0",
        "linkify-it": "^5.0.2",
        "mdurl": "^2.0.0",
        "punycode.js": "^2.3.1",
        "uc.micro": "^2.1.0"
      },
      "bin": {
        "markdown-it": "bin/markdown-it.mjs"
      }
    },
    "node_modules/mdurl": {
      "version": "2.1.0",
      "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.1.0.tgz",
      "integrity": "sha512-1+HBaOx0zi/dQWht8rNv9MYf9qqpqL/kxI0hXImU6Y547zM6Sni8BQibt7ifgMcYtQg41ao3Ivd6cnSM86inpg==",
      "license": "MIT"
    },
    "node_modules/orderedmap": {
      "version": "2.1.1",
      "resolved": "https://registry.npmjs.org/orderedmap/-/orderedmap-2.1.1.tgz",
      "integrity": "sha512-TvAWxi0nDe1j/rtMcWcIj94+Ffe6n7zhow33h40SKxmsmozs6dz/e+EajymfoFcHd7sxNn8yHM8839uixMOV6g==",
      "license": "MIT"
    },
    "node_modules/prosemirror-changeset": {
      "version": "2.4.2",
      "resolved": "https://registry.npmjs.org/prosemirror-changeset/-/prosemirror-changeset-2.4.2.tgz",
      "integrity": "sha512-ViYrjMSg3YFiXwIhKaluu+/mi3Yrxt6AR8ri14ulTaGcZtXO1CThl7A2gv79qx5fQnOw8woKwyBU2u+9PVCm3w==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-transform": "^1.0.0"
      }
    },
    "node_modules/prosemirror-collab": {
      "version": "1.3.1",
      "resolved": "https://registry.npmjs.org/prosemirror-collab/-/prosemirror-collab-1.3.1.tgz",
      "integrity": "sha512-4SnynYR9TTYaQVXd/ieUvsVV4PDMBzrq2xPUWutHivDuOshZXqQ5rGbZM84HEaXKbLdItse7weMGOUdDVcLKEQ==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-state": "^1.0.0"
      }
    },
    "node_modules/prosemirror-commands": {
      "version": "1.7.2",
      "resolved": "https://registry.npmjs.org/prosemirror-commands/-/prosemirror-commands-1.7.2.tgz",
      "integrity": "sha512-q6Q6szxqdu9Xd6EcdKsqXghu5nQdZTpB4Q9yd04WRc7/jt763e/rT60Owh0L1GYY+T46o5rD+9lEN36dZS43tw==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-model": "^1.0.0",
        "prosemirror-state": "^1.0.0",
        "prosemirror-transform": "^1.10.2"
      }
    },
    "node_modules/prosemirror-dropcursor": {
      "version": "1.8.3",
      "resolved": "https://registry.npmjs.org/prosemirror-dropcursor/-/prosemirror-dropcursor-1.8.3.tgz",
      "integrity": "sha512-FoYbsJR8gK+DGlqhNoE29Loa38eIZPzQRIb1VMaDNBoo4OLP6vVof/jR8qFY/6XvUd6Dhug8MDCHl2a/h8RTfQ==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-state": "^1.0.0",
        "prosemirror-transform": "^1.1.0",
        "prosemirror-view": "^1.1.0"
      }
    },
    "node_modules/prosemirror-gapcursor": {
      "version": "1.4.1",
      "resolved": "https://registry.npmjs.org/prosemirror-gapcursor/-/prosemirror-gapcursor-1.4.1.tgz",
      "integrity": "sha512-pMdYaEnjNMSwl11yjEGtgTmLkR08m/Vl+Jj443167p9eB3HVQKhYCc4gmHVDsLPODfZfjr/MmirsdyZziXbQKw==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-keymap": "^1.0.0",
        "prosemirror-model": "^1.0.0",
        "prosemirror-state": "^1.0.0",
        "prosemirror-view": "^1.0.0"
      }
    },
    "node_modules/prosemirror-history": {
      "version": "1.5.0",
      "resolved": "https://registry.npmjs.org/prosemirror-history/-/prosemirror-history-1.5.0.tgz",
      "integrity": "sha512-zlzTiH01eKA55UAf1MEjtssJeHnGxO0j4K4Dpx+gnmX9n+SHNlDqI2oO1Kv1iPN5B1dm5fsljCfqKF9nFL6HRg==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-state": "^1.2.2",
        "prosemirror-transform": "^1.0.0",
        "prosemirror-view": "^1.31.0",
        "rope-sequence": "^1.3.0"
      }
    },
    "node_modules/prosemirror-inputrules": {
      "version": "1.5.1",
      "resolved": "https://registry.npmjs.org/prosemirror-inputrules/-/prosemirror-inputrules-1.5.1.tgz",
      "integrity": "sha512-7wj4uMjKaXWAQ1CDgxNzNtR9AlsuwzHfdFH1ygEHA2KHF2DOEaXl1CJfNPAKCg9qNEh4rum975QLaCiQPyY6Fw==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-state": "^1.0.0",
        "prosemirror-transform": "^1.0.0"
      }
    },
    "node_modules/prosemirror-keymap": {
      "version": "1.2.3",
      "resolved": "https://registry.npmjs.org/prosemirror-keymap/-/prosemirror-keymap-1.2.3.tgz",
      "integrity": "sha512-4HucRlpiLd1IPQQXNqeo81BGtkY8Ai5smHhKW9jjPKRc2wQIxksg7Hl1tTI2IfT2B/LgX6bfYvXxEpJl7aKYKw==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-state": "^1.0.0",
        "w3c-keyname": "^2.2.0"
      }
    },
    "node_modules/prosemirror-markdown": {
      "version": "1.13.7",
      "resolved": "https://registry.npmjs.org/prosemirror-markdown/-/prosemirror-markdown-1.13.7.tgz",
      "integrity": "sha512-NV57Oxe3fXR+bNGXS5XW4sKt/XGIyY3n0eHVUoJORcismeF4FFMpLBnl0YESy2BvJQHloexX+9P+zT3VqFj/CQ==",
      "license": "MIT",
      "dependencies": {
        "@types/markdown-it": "^14.0.0",
        "markdown-it": "^14.0.0",
        "prosemirror-model": "^1.25.0"
      }
    },
    "node_modules/prosemirror-menu": {
      "version": "1.3.2",
      "resolved": "https://registry.npmjs.org/prosemirror-menu/-/prosemirror-menu-1.3.2.tgz",
      "integrity": "sha512-6VgUJTYod0nMBlCaYJGhXGLu7Gt4AvcwcOq0YfJCY/6Uh+3S7UsWhpy6rJFCBFOmonq1hD8KyWOtZhkppd4YPg==",
      "license": "MIT",
      "dependencies": {
        "crelt": "^1.0.0",
        "prosemirror-commands": "^1.0.0",
        "prosemirror-history": "^1.0.0",
        "prosemirror-state": "^1.0.0"
      }
    },
    "node_modules/prosemirror-model": {
      "version": "1.25.11",
      "resolved": "https://registry.npmjs.org/prosemirror-model/-/prosemirror-model-1.25.11.tgz",
      "integrity": "sha512-QWg9RhnpLlogAmp3p96uEFrE5txQpFynd4vhBAELkwgOCWQs/X0yCzB3/hrHqiPwf91RG5KyWq6553zs9JqIOQ==",
      "license": "MIT",
      "dependencies": {
        "orderedmap": "^2.0.0"
      }
    },
    "node_modules/prosemirror-schema-basic": {
      "version": "1.2.4",
      "resolved": "https://registry.npmjs.org/prosemirror-schema-basic/-/prosemirror-schema-basic-1.2.4.tgz",
      "integrity": "sha512-ELxP4TlX3yr2v5rM7Sb70SqStq5NvI15c0j9j/gjsrO5vaw+fnnpovCLEGIcpeGfifkuqJwl4fon6b+KdrODYQ==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-model": "^1.25.0"
      }
    },
    "node_modules/prosemirror-schema-list": {
      "version": "1.5.1",
      "resolved": "https://registry.npmjs.org/prosemirror-schema-list/-/prosemirror-schema-list-1.5.1.tgz",
      "integrity": "sha512-927lFx/uwyQaGwJxLWCZRkjXG0p48KpMj6ueoYiu4JX05GGuGcgzAy62dfiV8eFZftgyBUvLx76RsMe20fJl+Q==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-model": "^1.0.0",
        "prosemirror-state": "^1.0.0",
        "prosemirror-transform": "^1.7.3"
      }
    },
    "node_modules/prosemirror-state": {
      "version": "1.4.4",
      "resolved": "https://registry.npmjs.org/prosemirror-state/-/prosemirror-state-1.4.4.tgz",
      "integrity": "sha512-6jiYHH2CIGbCfnxdHbXZ12gySFY/fz/ulZE333G6bPqIZ4F+TXo9ifiR86nAHpWnfoNjOb3o5ESi7J8Uz1jXHw==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-model": "^1.0.0",
        "prosemirror-transform": "^1.0.0",
        "prosemirror-view": "^1.27.0"
      }
    },
    "node_modules/prosemirror-tables": {
      "version": "1.8.5",
      "resolved": "https://registry.npmjs.org/prosemirror-tables/-/prosemirror-tables-1.8.5.tgz",
      "integrity": "sha512-V/0cDCsHKHe/tfWkeCmthNUcEp1IVO3p6vwN8XtwE9PZQLAZJigbw3QoraAdfJPir4NKJtNvOB8oYGKRl+t0Dw==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-keymap": "^1.2.3",
        "prosemirror-model": "^1.25.4",
        "prosemirror-state": "^1.4.4",
        "prosemirror-transform": "^1.10.5",
        "prosemirror-view": "^1.41.4"
      }
    },
    "node_modules/prosemirror-trailing-node": {
      "version": "3.0.0",
      "resolved": "https://registry.npmjs.org/prosemirror-trailing-node/-/prosemirror-trailing-node-3.0.0.tgz",
      "integrity": "sha512-xiun5/3q0w5eRnGYfNlW1uU9W6x5MoFKWwq/0TIRgt09lv7Hcser2QYV8t4muXbEr+Fwo0geYn79Xs4GKywrRQ==",
      "license": "MIT",
      "dependencies": {
        "@remirror/core-constants": "3.0.0",
        "escape-string-regexp": "^4.0.0"
      },
      "peerDependencies": {
        "prosemirror-model": "^1.22.1",
        "prosemirror-state": "^1.4.2",
        "prosemirror-view": "^1.33.8"
      }
    },
    "node_modules/prosemirror-transform": {
      "version": "1.12.1",
      "resolved": "https://registry.npmjs.org/prosemirror-transform/-/prosemirror-transform-1.12.1.tgz",
      "integrity": "sha512-t4F5615FycnCqsX7ShTUs8+jfnwcf46kuFRvSl/3qFx2QTZ4DjgowesLHQXcFP7G//TjesqZG3WtgL7vdyVJyA==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-model": "^1.21.0"
      }
    },
    "node_modules/prosemirror-view": {
      "version": "1.42.3",
      "resolved": "https://registry.npmjs.org/prosemirror-view/-/prosemirror-view-1.42.3.tgz",
      "integrity": "sha512-oTN7EtH+CpwxU9NrwEYWd0UZ4JUx7l048l5A2Xppm4p/60isZYLnth9QVQmC3VRIvdrIWCxwZSd+Uz791G31/w==",
      "license": "MIT",
      "dependencies": {
        "prosemirror-model": "^1.25.8",
        "prosemirror-state": "^1.0.0",
        "prosemirror-transform": "^1.1.0"
      }
    },
    "node_modules/punycode.js": {
      "version": "2.3.1",
      "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz",
      "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==",
      "license": "MIT",
      "engines": {
        "node": ">=6"
      }
    },
    "node_modules/rope-sequence": {
      "version": "1.3.4",
      "resolved": "https://registry.npmjs.org/rope-sequence/-/rope-sequence-1.3.4.tgz",
      "integrity": "sha512-UT5EDe2cu2E/6O4igUr5PSFs23nvvukicWHx6GnOPlHAiiYbzNuCRQCuiUdHJQcqKalLKlrYJnjY0ySGsXNQXQ==",
      "license": "MIT"
    },
    "node_modules/uc.micro": {
      "version": "2.1.0",
      "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz",
      "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==",
      "license": "MIT"
    },
    "node_modules/w3c-keyname": {
      "version": "2.2.8",
      "resolved": "https://registry.npmjs.org/w3c-keyname/-/w3c-keyname-2.2.8.tgz",
      "integrity": "sha512-dpojBhNsCNN7T82Tm7k26A6G9ML3NkhDsnw9n/eoxSRlVBB4CEtIQ/KTCLI2Fwf3ataSXRhYFkQi3SlnFwPvPQ==",
      "license": "MIT"
    }
  }
}
package.json
{
  "name": "tiptap-extension-highlight-sample",
  "version": "1.0.0",
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "@tiptap/core": "3.11.0",
    "@tiptap/extension-highlight": "3.11.0",
    "@tiptap/pm": "3.11.0"
  }
}
spec.json
{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/@tiptap/extension-highlight@3.11.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40tiptap/extension-highlight@3.11.0"
  ],
  "symbols": [
    "Highlight"
  ]
}
test/contract.mjs
import { strict as assert } from 'node:assert';
import { Highlight, inputRegex, pasteRegex, default as DefaultHighlight } from '@tiptap/extension-highlight';

async function runContract() {
  // ---------------------------------------------------------------------------
  // Contract Assertion 1:
  // Importing @tiptap/extension-highlight provides Highlight mark extension matching default export.
  // ---------------------------------------------------------------------------
  assert.strictEqual(
    Highlight,
    DefaultHighlight,
    'named export Highlight must be identical to default export'
  );
  assert.strictEqual(
    Highlight.name,
    'highlight',
    'Highlight extension name must be "highlight"'
  );
  assert.strictEqual(
    Highlight.type,
    'mark',
    'Highlight extension type must be "mark"'
  );

  // ---------------------------------------------------------------------------
  // Contract Assertion 2:
  // Highlight extension configures mark type name as 'highlight'.
  // ---------------------------------------------------------------------------
  assert.strictEqual(
    Highlight.config.name,
    'highlight',
    'Highlight config name must be "highlight"'
  );

  // ---------------------------------------------------------------------------
  // Contract Assertion 3:
  // Default Highlight options provide multicolor false and empty HTMLAttributes.
  // ---------------------------------------------------------------------------
  assert.strictEqual(
    Highlight.options.multicolor,
    false,
    'multicolor option must default to false'
  );
  assert.deepStrictEqual(
    Highlight.options.HTMLAttributes,
    {},
    'HTMLAttributes option must default to empty object'
  );

  // ---------------------------------------------------------------------------
  // Contract Assertion 4:
  // Highlight.configure customizes multicolor mode and default HTMLAttributes.
  // ---------------------------------------------------------------------------
  const configured = Highlight.configure({
    multicolor: true,
    HTMLAttributes: { class: 'custom-highlight' },
  });
  assert.strictEqual(
    configured.options.multicolor,
    true,
    'configured multicolor must be true'
  );
  assert.deepStrictEqual(
    configured.options.HTMLAttributes,
    { class: 'custom-highlight' },
    'configured HTMLAttributes must match custom attributes'
  );

  // ---------------------------------------------------------------------------
  // Contract Assertion 5:
  // addAttributes defines color attribute with HTML parsers and renderers when multicolor is enabled.
  // ---------------------------------------------------------------------------
  const attrsWithMulticolor = configured.config.addAttributes.call(configured);
  assert.ok(attrsWithMulticolor.color, 'color attribute must be present when multicolor is true');
  assert.strictEqual(attrsWithMulticolor.color.default, null, 'color attribute default must be null');

  // parseHTML with data-color
  const elementWithDataColor = {
    getAttribute: (name) => (name === 'data-color' ? '#ffcc00' : null),
    style: {},
  };
  assert.strictEqual(
    attrsWithMulticolor.color.parseHTML(elementWithDataColor),
    '#ffcc00',
    'parseHTML should extract color from data-color attribute'
  );

  // parseHTML with style.backgroundColor fallback
  const elementWithStyleColor = {
    getAttribute: () => null,
    style: { backgroundColor: '#00ffcc' },
  };
  assert.strictEqual(
    attrsWithMulticolor.color.parseHTML(elementWithStyleColor),
    '#00ffcc',
    'parseHTML should fallback to style.backgroundColor'
  );

  // renderHTML for color attribute
  assert.deepStrictEqual(
    attrsWithMulticolor.color.renderHTML({}),
    {},
    'renderHTML should return empty object when color attribute is absent'
  );
  assert.deepStrictEqual(
    attrsWithMulticolor.color.renderHTML({ color: '#ffcc00' }),
    {
      'data-color': '#ffcc00',
      style: 'background-color: #ffcc00; color: inherit',
    },
    'renderHTML should return data-color and background style when color is present'
  );

  // ---------------------------------------------------------------------------
  // Contract Assertion 6:
  // addAttributes returns empty attributes schema when multicolor is disabled.
  // ---------------------------------------------------------------------------
  const attrsDefault = Highlight.config.addAttributes.call(Highlight);
  assert.deepStrictEqual(
    attrsDefault,
    {},
    'addAttributes must return an empty object when multicolor is false'
  );

  // ---------------------------------------------------------------------------
  // Contract Assertion 7:
  // renderHTML outputs mark tag merged with configured and custom HTMLAttributes.
  // ---------------------------------------------------------------------------
  const defaultRender = Highlight.config.renderHTML.call(Highlight, {
    HTMLAttributes: { 'data-custom': 'val' },
  });
  assert.deepStrictEqual(
    defaultRender,
    ['mark', { 'data-custom': 'val' }, 0],
    'renderHTML must return mark element array with merged attributes'
  );

  const mergedRender = configured.config.renderHTML.call(configured, {
    HTMLAttributes: { id: 'hl-target' },
  });
  assert.deepStrictEqual(
    mergedRender,
    ['mark', { class: 'custom-highlight', id: 'hl-target' }, 0],
    'renderHTML must merge configured options.HTMLAttributes and per-mark HTMLAttributes'
  );

  // ---------------------------------------------------------------------------
  // Contract Assertion 8:
  // renderMarkdown and parseMarkdown format inline highlight marks using double equals syntax.
  // ---------------------------------------------------------------------------
  const renderedMarkdown = Highlight.config.renderMarkdown(
    { type: 'highlight' },
    { renderChildren: () => 'important text' }
  );
  assert.strictEqual(
    renderedMarkdown,
    '==important text==',
    'renderMarkdown must wrap children with double equals delimiters'
  );

  const parsedMarkdown = Highlight.config.parseMarkdown(
    { tokens: ['tok-1'] },
    {
      applyMark: (name, content) => ({ mark: name, content }),
      parseInline: (tokens) => tokens,
    }
  );
  assert.deepStrictEqual(
    parsedMarkdown,
    { mark: 'highlight', content: ['tok-1'] },
    'parseMarkdown must apply highlight mark over inline tokens'
  );

  // ---------------------------------------------------------------------------
  // Contract Assertion 9:
  // markdownTokenizer tokenizes double equals syntax into highlight inline tokens.
  // ---------------------------------------------------------------------------
  const tokenizer = Highlight.config.markdownTokenizer;
  assert.strictEqual(tokenizer.name, 'highlight', 'tokenizer name must be highlight');
  assert.strictEqual(tokenizer.level, 'inline', 'tokenizer level must be inline');
  assert.strictEqual(
    tokenizer.start('prefix ==highlighted== suffix'),
    7,
    'tokenizer start method must locate start index of double equals'
  );

  const tokenResult = tokenizer.tokenize('==sample==', null, {
    inlineTokens: (text) => [{ type: 'text', raw: text }],
  });
  assert.deepStrictEqual(
    tokenResult,
    {
      type: 'highlight',
      raw: '==sample==',
      text: 'sample',
      tokens: [{ type: 'text', raw: 'sample' }],
    },
    'tokenize must produce valid highlight token structure'
  );

  // ---------------------------------------------------------------------------
  // Contract Assertion 10:
  // Commands setHighlight, toggleHighlight, and unsetHighlight dispatch corresponding editor mark operations.
  // ---------------------------------------------------------------------------
  const commands = Highlight.config.addCommands.call(Highlight);
  let dispatchedCommand = null;
  const mockContext = {
    commands: {
      setMark: (name, attrs) => {
        dispatchedCommand = { action: 'setMark', name, attrs };
        return true;
      },
      toggleMark: (name, attrs) => {
        dispatchedCommand = { action: 'toggleMark', name, attrs };
        return true;
      },
      unsetMark: (name) => {
        dispatchedCommand = { action: 'unsetMark', name };
        return true;
      },
    },
  };

  const setResult = commands.setHighlight({ color: '#ffcc00' })(mockContext);
  assert.strictEqual(setResult, true);
  assert.deepStrictEqual(dispatchedCommand, {
    action: 'setMark',
    name: 'highlight',
    attrs: { color: '#ffcc00' },
  });

  const toggleResult = commands.toggleHighlight({ color: '#00ccff' })(mockContext);
  assert.strictEqual(toggleResult, true);
  assert.deepStrictEqual(dispatchedCommand, {
    action: 'toggleMark',
    name: 'highlight',
    attrs: { color: '#00ccff' },
  });

  const unsetResult = commands.unsetHighlight()(mockContext);
  assert.strictEqual(unsetResult, true);
  assert.deepStrictEqual(dispatchedCommand, {
    action: 'unsetMark',
    name: 'highlight',
  });

  // ---------------------------------------------------------------------------
  // Contract Assertion 11:
  // addKeyboardShortcuts binds Mod-Shift-h to toggleHighlight command.
  // ---------------------------------------------------------------------------
  let shortcutFired = false;
  const mockEditorContext = {
    editor: {
      commands: {
        toggleHighlight: () => {
          shortcutFired = true;
          return true;
        },
      },
    },
  };
  const shortcuts = Highlight.config.addKeyboardShortcuts.call(mockEditorContext);
  assert.ok(shortcuts['Mod-Shift-h'], 'Mod-Shift-h shortcut must be registered');
  shortcuts['Mod-Shift-h']();
  assert.strictEqual(shortcutFired, true, 'shortcut invocation must call editor toggleHighlight');

  // ---------------------------------------------------------------------------
  // Contract Assertion 12:
  // inputRegex and pasteRegex validate double equals delimited highlight patterns.
  // ---------------------------------------------------------------------------
  assert.ok(inputRegex.test('==highlighted=='), 'inputRegex must match ==highlighted==');
  assert.ok(pasteRegex.test('some ==text== here'), 'pasteRegex must match inline ==text==');

  console.log('All contract assertions passed successfully.');
}

runContract().catch((err) => {
  console.error('Contract failed:', err);
  process.exit(1);
});

原始种子者

匿名