Skip to content

docs: add TS plugin internals documentation#358

Merged
mizdra merged 8 commits intomainfrom
claude/wizardly-sutherland
Apr 12, 2026
Merged

docs: add TS plugin internals documentation#358
mizdra merged 8 commits intomainfrom
claude/wizardly-sutherland

Conversation

@mizdra
Copy link
Copy Markdown
Owner

@mizdra mizdra commented Apr 12, 2026

Summary

  • Add docs/ts-plugin-internals.md documenting the internal architecture of the TS plugin
    • Covers Volar.js virtual code generation, position mappings (CodeMapping), the single-quote span problem and its solution, linkedCodeMappings, and the language service proxy
    • Intended to help contributors (including Claude Code) understand the TS plugin codebase
  • Add docs/ts-plugin-internals.md to fmt.ignorePatterns in vite.config.ts to prevent oxfmt from stripping single quotes in code blocks

Test plan

  • Verify the document renders correctly on GitHub
  • Verify code blocks contain properly quoted property names (e.g., 'a_1')

🤖 Generated with Claude Code

mizdra and others added 4 commits April 12, 2026 15:53
Document the internal architecture of the TypeScript Language Service Plugin,
covering Volar.js virtual code generation, position mappings, the single-quote
span problem and its solution, linkedCodeMappings, and the language service proxy.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add docs/ts-plugin-internals.md to fmt.ignorePatterns in vite.config.ts
to prevent oxfmt from stripping single quotes in code blocks. Restore
the single-quoted property names that are essential to the document's
technical explanation.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 12, 2026

⚠️ No Changeset found

Latest commit: 3d8aa90

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

mizdra and others added 3 commits April 12, 2026 16:50
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@mizdra mizdra enabled auto-merge (squash) April 12, 2026 08:16
@mizdra mizdra disabled auto-merge April 12, 2026 08:16
@mizdra mizdra enabled auto-merge (squash) April 12, 2026 08:18
@mizdra mizdra merged commit 7ae3ebc into main Apr 12, 2026
20 checks passed
@mizdra mizdra deleted the claude/wizardly-sutherland branch April 12, 2026 08:20
@mizdra mizdra added the Type: Documentation Documentation only changes label Apr 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Documentation Documentation only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant