@tiptap/extension-underline 3.11.0

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/%40tiptap/extension-underline@3.11.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40tiptap/extension-underline@3.11.0

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.

{"case":{"caseId":"case:sha256:52b603ab86bda7b54b96aa0c311dc0b3ea2e26ee326c81044057bdd1d75cf1e9","contract":["Underline extension exports Mark named underline with default options","Underline configure updates HTMLAttributes option","Underline extend creates derived mark extension","Underline parseHTML matches u tag and underline text-decoration style","Underline renderHTML merges configured and dynamic HTMLAttributes","Underline renderMarkdown wraps content in double plus delimiters"],"goal":"verify pkg:npm/%40tiptap/extension-underline@3.11.0","kind":"HOW","packages":["pkg:npm/%40tiptap/extension-underline@3.11.0"],"schemaVersion":1},"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-underline@3.11.0"],"schemaVersion":1,"subject":"pkg:npm/%40tiptap/extension-underline@3.11.0","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-tiptap-extension-underline",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-tiptap-extension-underline",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@tiptap/extension-underline": "3.11.0"
      }
    },
    "node_modules/@tiptap/core": {
      "version": "3.31.3",
      "resolved": "https://registry.npmjs.org/@tiptap/core/-/core-3.31.3.tgz",
      "integrity": "sha512-Cz50pvciQrxdSxgTkHOVz0uD0Yl/8Xt0QatGD6ILm47jW8EzyHR9RkUGs/D5IqzXKuVPntfw1ttaT926vXfiRg==",
      "license": "MIT",
      "peer": true,
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/ueberdosis"
      },
      "peerDependencies": {
        "@tiptap/pm": "3.31.3"
      }
    },
    "node_modules/@tiptap/extension-underline": {
      "version": "3.11.0",
      "resolved": "https://registry.npmjs.org/@tiptap/extension-underline/-/extension-underline-3.11.0.tgz",
      "integrity": "sha512-D3PsS/84RlQKFjd5eerMIUioC0mNh4yy1RRV/WbXx6ugu+6T+0hT42gNk9Ap8pDsVQZCk0SHfDyBEUFC2KOwKw==",
      "license": "MIT",
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/ueberdosis"
      },
      "peerDependencies": {
        "@tiptap/core": "^3.11.0"
      }
    },
    "node_modules/@tiptap/pm": {
      "version": "3.31.3",
      "resolved": "https://registry.npmjs.org/@tiptap/pm/-/pm-3.31.3.tgz",
      "integrity": "sha512-sZime0SWsz/k62W2WvHx5Ig7G2h7kVhrrmnqy+wEgIHfDwEfOlelRjaWCiBCFlF7dxGUntJusCh9FxlLhni0Ag==",
      "license": "MIT",
      "peer": true,
      "dependencies": {
        "prosemirror-changeset": "^2.4.1",
        "prosemirror-commands": "^1.7.1",
        "prosemirror-dropcursor": "^1.8.2",
        "prosemirror-gapcursor": "^1.4.1",
        "prosemirror-history": "^1.5.0",
        "prosemirror-inputrules": "^1.5.1",
        "prosemirror-keymap": "^1.2.3",
        "prosemirror-model": "^1.25.11",
        "prosemirror-schema-list": "^1.5.1",
        "prosemirror-state": "^1.4.4",
        "prosemirror-tables": "^1.8.5",
        "prosemirror-transform": "^1.12.0",
        "prosemirror-view": "^1.42.3"
      },
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/ueberdosis"
      }
    },
    "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",
      "peer": true
    },
    "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",
      "peer": true,
      "dependencies": {
        "prosemirror-transform": "^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",
      "peer": true,
      "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",
      "peer": true,
      "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",
      "peer": true,
      "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",
      "peer": true,
      "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",
      "peer": true,
      "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",
      "peer": true,
      "dependencies": {
        "prosemirror-state": "^1.0.0",
        "w3c-keyname": "^2.2.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",
      "peer": true,
      "dependencies": {
        "orderedmap": "^2.0.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",
      "peer": true,
      "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",
      "peer": true,
      "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",
      "peer": true,
      "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-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",
      "peer": true,
      "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",
      "peer": true,
      "dependencies": {
        "prosemirror-model": "^1.25.8",
        "prosemirror-state": "^1.0.0",
        "prosemirror-transform": "^1.1.0"
      }
    },
    "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",
      "peer": true
    },
    "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",
      "peer": true
    }
  }
}

{
  "name": "sample-tiptap-extension-underline",
  "version": "1.0.0",
  "description": "Clean-room sample verifying @tiptap/extension-underline",
  "type": "module",
  "main": "src/index.js",
  "license": "MIT-0",
  "dependencies": {
    "@tiptap/extension-underline": "3.11.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/%40tiptap/extension-underline@3.11.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40tiptap/extension-underline@3.11.0"
  ]
}

import { Underline } from '@tiptap/extension-underline';

/**
 * Creates a configured Underline extension.
 * @param {Record<string, any>} options
 * @returns {any}
 */
export function createUnderline(options = {}) {
  return Underline.configure(options);
}

/**
 * Extends the Underline extension with custom configuration.
 * @param {Record<string, any>} override
 * @returns {any}
 */
export function extendUnderline(override = {}) {
  return Underline.extend(override);
}

/**
 * Returns the extension name.
 * @returns {string}
 */
export function getUnderlineName() {
  return Underline.name;
}

/**
 * Returns the extension type.
 * @returns {string}
 */
export function getUnderlineType() {
  return Underline.type;
}

export { Underline };
export default Underline;

import assert from 'node:assert/strict';
import { Underline, default as DefaultUnderline } from '@tiptap/extension-underline';
import {
  createUnderline,
  extendUnderline,
  getUnderlineName,
  getUnderlineType,
  Underline as ExportedUnderline
} from '../src/index.js';

// 1. Underline extension exports Mark named underline with default options
{
  assert.equal(Underline, DefaultUnderline, 'named and default imports must be identical');
  assert.equal(Underline, ExportedUnderline, 'index export must match original export');
  assert.equal(getUnderlineName(), 'underline', 'helper getUnderlineName must return underline');
  assert.equal(getUnderlineType(), 'mark', 'helper getUnderlineType must return mark');
  assert.equal(Underline.name, 'underline', 'Underline.name must be underline');
  assert.equal(Underline.type, 'mark', 'Underline.type must be mark');
  assert.deepEqual(Underline.options, { HTMLAttributes: {} }, 'default options must have empty HTMLAttributes');
}

// 2. Underline configure updates HTMLAttributes option
{
  const configured = createUnderline({
    HTMLAttributes: {
      class: 'custom-underline',
      'data-testid': 'underline-node'
    }
  });
  assert.equal(configured.name, 'underline', 'configured name must remain underline');
  assert.equal(configured.type, 'mark', 'configured type must remain mark');
  assert.deepEqual(
    configured.options.HTMLAttributes,
    {
      class: 'custom-underline',
      'data-testid': 'underline-node'
    },
    'HTMLAttributes option must match configured object'
  );
}

// 3. Underline extend creates derived mark extension
{
  const extended = extendUnderline({
    name: 'customUnderline'
  });
  assert.equal(extended.name, 'customUnderline', 'extended name must be customUnderline');
  assert.equal(extended.type, 'mark', 'extended type must be mark');
}

// 4. Underline parseHTML matches u tag and underline text-decoration style
{
  const parseRules = Underline.config.parseHTML();
  assert.ok(Array.isArray(parseRules), 'parseHTML must return an array');
  assert.equal(parseRules.length, 2, 'parseHTML must have 2 rules');
  assert.equal(parseRules[0].tag, 'u', 'first rule must match u tag');
  assert.equal(parseRules[1].style, 'text-decoration', 'second rule must match text-decoration style');
  assert.equal(parseRules[1].consuming, false, 'second rule consuming must be false');
  assert.deepEqual(parseRules[1].getAttrs('underline'), {}, 'getAttrs must return empty object when style includes underline');
  assert.equal(parseRules[1].getAttrs('line-through'), false, 'getAttrs must return false when style does not include underline');
}

// 5. Underline renderHTML merges configured and dynamic HTMLAttributes
{
  const renderedBase = Underline.config.renderHTML.call(
    { options: { HTMLAttributes: { class: 'base-underline' } } },
    { HTMLAttributes: {} }
  );
  assert.deepEqual(
    renderedBase,
    ['u', { class: 'base-underline' }, 0],
    'renderHTML must return u element with configured attributes'
  );

  const renderedMerged = Underline.config.renderHTML.call(
    { options: { HTMLAttributes: { class: 'base-underline' } } },
    { HTMLAttributes: { class: 'extra-class', id: 'u-1' } }
  );
  assert.deepEqual(
    renderedMerged,
    ['u', { class: 'base-underline extra-class', id: 'u-1' }, 0],
    'renderHTML must merge configured and dynamic attributes'
  );
}

// 6. Underline renderMarkdown wraps content in double plus delimiters
{
  const rendered = Underline.config.renderMarkdown(
    {},
    { renderChildren: () => 'underlined content' }
  );
  assert.equal(rendered, '++underlined content++', 'renderMarkdown must wrap children in ++');

  assert.ok(Underline.config.markdownTokenizer, 'markdownTokenizer must be defined');
  assert.equal(Underline.config.markdownTokenizer.name, 'underline', 'tokenizer name must be underline');
  assert.equal(Underline.config.markdownTokenizer.level, 'inline', 'tokenizer level must be inline');
  assert.equal(Underline.config.markdownTokenizer.start('text ++underline++ text'), 5, 'tokenizer start must find ++');
}

console.log('All @tiptap/extension-underline contract assertions passed successfully.');