@tiptap/extensions 3.11.0: CharacterCount

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 @tiptap/extensions.CharacterCount in pkg:npm/%40tiptap/extensions@3.11.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40tiptap/extensions@3.11.0
Demonstrate these symbols/APIs:
  - @tiptap/extensions.CharacterCount
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

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:0faa8fa25db40dd96639740857c6e324428f8a1127629ba84b6f6a5efb0451ab","constraints":{"executionContext":"node"},"contract":["CharacterCount extension exposes valid extension metadata and default configuration","CharacterCount configure overrides limit, mode, textCounter, and wordCounter options","CharacterCount storage calculates character and word counts for editor document","CharacterCount storage supports nodeSize mode calculation","CharacterCount storage applies custom textCounter and wordCounter implementations","CharacterCount filterTransaction allows transactions within character limit","CharacterCount filterTransaction blocks non-paste transactions exceeding character limit","CharacterCount filterTransaction trims pasted content exceeding character limit","CharacterCount is exported from both package entrypoint and character-count subpath"],"goal":"verify @tiptap/extensions.CharacterCount in pkg:npm/%40tiptap/extensions@3.11.0","kind":"HOW","packages":["pkg:npm/%40tiptap/extensions@3.11.0"],"schemaVersion":1,"symbols":["@tiptap/extensions.CharacterCount"]},"contractCommand":["node","test/contract.cjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/%40tiptap/extensions@3.11.0"],"schemaVersion":1,"subject":"pkg:npm/%40tiptap/extensions@3.11.0","symbols":["@tiptap/extensions.CharacterCount"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-tiptap-extensions-character-count",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-tiptap-extensions-character-count",
      "version": "1.0.0",
      "dependencies": {
        "@tiptap/extensions": "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/extensions": {
      "version": "3.11.0",
      "resolved": "https://registry.npmjs.org/@tiptap/extensions/-/extensions-3.11.0.tgz",
      "integrity": "sha512-g43beA73ZMLezez1st9LEwYrRHZ0FLzlsSlOZKk7sdmtHLmuqWHf4oyb0XAHol1HZIdGv104rYaGNgmQXr1ecQ==",
      "license": "MIT",
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/ueberdosis"
      },
      "peerDependencies": {
        "@tiptap/core": "^3.11.0",
        "@tiptap/pm": "^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-extensions-character-count",
  "version": "1.0.0",
  "private": true,
  "description": "Verification sample for @tiptap/extensions CharacterCount",
  "dependencies": {
    "@tiptap/extensions": "3.11.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify @tiptap/extensions.CharacterCount in pkg:npm/%40tiptap/extensions@3.11.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40tiptap/extensions@3.11.0"
  ],
  "symbols": [
    "@tiptap/extensions.CharacterCount"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

const assert = require("node:assert/strict");
const { Editor, Node } = require("@tiptap/core");
const { CharacterCount } = require("@tiptap/extensions");
const { CharacterCount: SubpathCharacterCount } = require("@tiptap/extensions/character-count");

// Minimal ProseMirror document schema nodes for testing tiptap extensions
const Doc = Node.create({ name: "doc", topNode: true, content: "block+" });
const Paragraph = Node.create({ name: "paragraph", group: "block", content: "text*" });
const Text = Node.create({ name: "text", group: "inline" });

// 1. CharacterCount extension exposes valid extension metadata and default configuration
assert.equal(CharacterCount.name, "characterCount");
assert.equal(CharacterCount.type, "extension");
assert.equal(CharacterCount.options.limit, null);
assert.equal(CharacterCount.options.mode, "textSize");
assert.equal(typeof CharacterCount.options.textCounter, "function");
assert.equal(typeof CharacterCount.options.wordCounter, "function");
assert.equal(CharacterCount.options.textCounter("sample test string"), 18);
assert.equal(CharacterCount.options.wordCounter("sample test string"), 3);

// 2. CharacterCount configure overrides limit, mode, textCounter, and wordCounter options
const customTextCounter = (text) => text.replace(/\s+/g, "").length;
const customWordCounter = (text) => text.trim().split(/\s+/).filter(Boolean).length;
const configuredExtension = CharacterCount.configure({
  limit: 80,
  mode: "nodeSize",
  textCounter: customTextCounter,
  wordCounter: customWordCounter,
});
assert.equal(configuredExtension.name, "characterCount");
assert.equal(configuredExtension.options.limit, 80);
assert.equal(configuredExtension.options.mode, "nodeSize");
assert.equal(configuredExtension.options.textCounter("hello world"), 10);
assert.equal(configuredExtension.options.wordCounter("  hello   world  "), 2);

// 3. CharacterCount storage calculates character and word counts for editor document
const editor = new Editor({
  extensions: [Doc, Paragraph, Text, CharacterCount],
  content: {
    type: "doc",
    content: [
      {
        type: "paragraph",
        content: [{ type: "text", text: "Hello from CodeSampleX" }],
      },
    ],
  },
});
const storage = editor.storage.characterCount;
assert.equal(typeof storage.characters, "function");
assert.equal(typeof storage.words, "function");
assert.equal(storage.characters(), 22);
assert.equal(storage.words(), 3);

// 4. CharacterCount storage supports nodeSize mode calculation
const textSizeCount = storage.characters({ mode: "textSize" });
const nodeSizeCount = storage.characters({ mode: "nodeSize" });
assert.equal(textSizeCount, 22);
assert.equal(nodeSizeCount, 26);
assert.ok(nodeSizeCount > textSizeCount);

// 5. CharacterCount storage applies custom textCounter and wordCounter implementations
const customEditor = new Editor({
  extensions: [
    Doc,
    Paragraph,
    Text,
    CharacterCount.configure({
      textCounter: (str) => str.replace(/\s+/g, "").length,
      wordCounter: (str) => str.trim().split(/\s+/).filter(Boolean).length,
    }),
  ],
  content: {
    type: "doc",
    content: [
      {
        type: "paragraph",
        content: [{ type: "text", text: "alpha beta gamma" }],
      },
    ],
  },
});
assert.equal(customEditor.storage.characterCount.characters(), 14);
assert.equal(customEditor.storage.characterCount.words(), 3);

// 6. CharacterCount filterTransaction allows transactions within character limit
const limitedEditor = new Editor({
  extensions: [Doc, Paragraph, Text, CharacterCount.configure({ limit: 15 })],
  content: {
    type: "doc",
    content: [
      {
        type: "paragraph",
        content: [{ type: "text", text: "initial" }],
      },
    ],
  },
});
const plugin = limitedEditor.extensionManager.plugins.find(
  (p) => p.key && p.key.startsWith("characterCount")
);
assert.ok(plugin, "Plugin for characterCount must exist");
const withinLimitTr = limitedEditor.state.tr.insertText(" add");
assert.equal(plugin.spec.filterTransaction(withinLimitTr, limitedEditor.state), true);

// 7. CharacterCount filterTransaction blocks non-paste transactions exceeding character limit
const exceedingLimitTr = limitedEditor.state.tr.insertText(" this string exceeds fifteen chars");
assert.equal(plugin.spec.filterTransaction(exceedingLimitTr, limitedEditor.state), false);

// 8. CharacterCount filterTransaction trims pasted content exceeding character limit
const pasteTr = limitedEditor.state.tr.insertText(" pasted long text").setMeta("paste", true);
const pasteAllowed = plugin.spec.filterTransaction(pasteTr, limitedEditor.state);
assert.equal(pasteAllowed, true);

// 9. CharacterCount is exported from both package entrypoint and character-count subpath
assert.equal(SubpathCharacterCount.name, "characterCount");
assert.equal(SubpathCharacterCount.type, "extension");
assert.equal(SubpathCharacterCount.options.limit, CharacterCount.options.limit);
assert.equal(SubpathCharacterCount.options.mode, CharacterCount.options.mode);
assert.equal(typeof SubpathCharacterCount.options.textCounter, "function");
assert.equal(typeof SubpathCharacterCount.options.wordCounter, "function");

console.log("Contract verified successfully.");