@tiptap/extension-placeholder 3.11.0: Placeholder

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 Placeholder in pkg:npm/%40tiptap/extension-placeholder@3.11.0
Kind: HOW

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

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:095339ca7f0431be5c23caf0d91f6936ad6848d3b5db4ebe75e5076c4e095003","contract":["assert Placeholder exports extension named placeholder of type extension","assert Placeholder defines default configuration options","assert Placeholder.configure applies custom static options while keeping default values","assert Placeholder.configure accepts dynamic function callback for placeholder text","assert Placeholder.extend creates derived extension with custom behavior"],"goal":"verify Placeholder in pkg:npm/%40tiptap/extension-placeholder@3.11.0","kind":"HOW","packages":["pkg:npm/%40tiptap/extension-placeholder@3.11.0"],"schemaVersion":1,"symbols":["Placeholder"]},"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-placeholder@3.11.0"],"schemaVersion":1,"subject":"pkg:npm/%40tiptap/extension-placeholder@3.11.0","symbols":["Placeholder"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-tiptap-extension-placeholder",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-tiptap-extension-placeholder",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@tiptap/extension-placeholder": "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-placeholder": {
      "version": "3.11.0",
      "resolved": "https://registry.npmjs.org/@tiptap/extension-placeholder/-/extension-placeholder-3.11.0.tgz",
      "integrity": "sha512-wK67ZFBJ2CTV++MupftT3eKBy+CRuY7Z2AiO8uK4dyVt3ry5v/1G3QqARJrOsEKomdpONkd2cXaJGdEWZvh8EA==",
      "license": "MIT",
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/ueberdosis"
      },
      "peerDependencies": {
        "@tiptap/extensions": "^3.11.0"
      }
    },
    "node_modules/@tiptap/extensions": {
      "version": "3.31.3",
      "resolved": "https://registry.npmjs.org/@tiptap/extensions/-/extensions-3.31.3.tgz",
      "integrity": "sha512-8sJNPGGUe8f3aDojcOW5cfVL7I5NrBbE0UWxG08qoi9Tea6qWbvQJsCR9tsrOapr/DaLr3kpbGZ9s1gEEfcNcA==",
      "license": "MIT",
      "peer": true,
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/ueberdosis"
      },
      "peerDependencies": {
        "@tiptap/core": "3.31.3",
        "@tiptap/pm": "3.31.3"
      }
    },
    "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-placeholder",
  "version": "1.0.0",
  "description": "Clean-room sample verifying Placeholder in @tiptap/extension-placeholder",
  "type": "module",
  "main": "src/index.js",
  "license": "MIT-0",
  "dependencies": {
    "@tiptap/extension-placeholder": "3.11.0"
  }
}

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

import { Placeholder } from '@tiptap/extension-placeholder';

/**
 * Configure the Placeholder extension with custom options.
 * @param {Record<string, any>} options
 * @returns {any}
 */
export function configurePlaceholder(options = {}) {
  return Placeholder.configure(options);
}

/**
 * Extend the Placeholder extension with custom overrides.
 * @param {Record<string, any>} overrides
 * @returns {any}
 */
export function extendPlaceholder(overrides = {}) {
  return Placeholder.extend(overrides);
}

export { Placeholder };
export default Placeholder;

import assert from 'node:assert/strict';
import { Placeholder, configurePlaceholder, extendPlaceholder } from '../src/index.js';

// 1. assert Placeholder exports extension named placeholder of type extension
assert.strictEqual(Placeholder.name, 'placeholder', 'Extension name must be placeholder');
assert.strictEqual(Placeholder.type, 'extension', 'Extension type must be extension');
assert.strictEqual(typeof Placeholder.configure, 'function', 'Placeholder.configure must be a function');
assert.strictEqual(typeof Placeholder.extend, 'function', 'Placeholder.extend must be a function');

// 2. assert Placeholder defines default configuration options
assert.strictEqual(Placeholder.options.emptyEditorClass, 'is-editor-empty', 'Default emptyEditorClass must be is-editor-empty');
assert.strictEqual(Placeholder.options.emptyNodeClass, 'is-empty', 'Default emptyNodeClass must be is-empty');
assert.strictEqual(Placeholder.options.placeholder, 'Write something …', 'Default placeholder text must match');
assert.strictEqual(Placeholder.options.showOnlyWhenEditable, true, 'Default showOnlyWhenEditable must be true');
assert.strictEqual(Placeholder.options.showOnlyCurrent, true, 'Default showOnlyCurrent must be true');
assert.strictEqual(Placeholder.options.includeChildren, false, 'Default includeChildren must be false');
assert.strictEqual(Placeholder.options.dataAttribute, 'placeholder', 'Default dataAttribute must be placeholder');

// 3. assert Placeholder.configure applies custom static options while keeping default values
const configured = configurePlaceholder({
  placeholder: 'Enter content here...',
  emptyEditorClass: 'custom-editor-empty',
  emptyNodeClass: 'custom-node-empty',
  showOnlyWhenEditable: false,
});
assert.strictEqual(configured.name, 'placeholder', 'Configured extension name must remain placeholder');
assert.strictEqual(configured.options.placeholder, 'Enter content here...', 'Configured placeholder string must match');
assert.strictEqual(configured.options.emptyEditorClass, 'custom-editor-empty', 'Configured emptyEditorClass must match');
assert.strictEqual(configured.options.emptyNodeClass, 'custom-node-empty', 'Configured emptyNodeClass must match');
assert.strictEqual(configured.options.showOnlyWhenEditable, false, 'Configured showOnlyWhenEditable must match false');
assert.strictEqual(configured.options.showOnlyCurrent, true, 'Omitted showOnlyCurrent must retain default true');
assert.strictEqual(configured.options.includeChildren, false, 'Omitted includeChildren must retain default false');
assert.strictEqual(configured.options.dataAttribute, 'placeholder', 'Omitted dataAttribute must retain default placeholder');

// 4. assert Placeholder.configure accepts dynamic function callback for placeholder text
const dynamicPlaceholder = configurePlaceholder({
  placeholder: ({ node }) => (node ? 'Node placeholder' : 'Default placeholder'),
});
assert.strictEqual(typeof dynamicPlaceholder.options.placeholder, 'function', 'Placeholder option must accept a function');
assert.strictEqual(dynamicPlaceholder.options.placeholder({ node: {} }), 'Node placeholder');
assert.strictEqual(dynamicPlaceholder.options.placeholder({ node: null }), 'Default placeholder');

// 5. assert Placeholder.extend creates derived extension with custom behavior
const extended = extendPlaceholder({
  name: 'customPlaceholderExtension',
});
assert.strictEqual(extended.name, 'customPlaceholderExtension', 'Extended extension must have overridden name');
assert.strictEqual(extended.type, 'extension', 'Extended extension must have type extension');

console.log('Contract verification for Placeholder passed.');