Definition Context for Hover Info

[mizdra]

ref: #135, #179

With this PR, users will be able to preview token definitions in VS Code using Cmd + Hover.

This feature is implemented by setting the location of the token definition in the contextStart/contextEnd properties of the definitionAndBoundSpan response.

Preview

2025-06-15.23.33.23.mov

Pros

• The contextStart/contextEnd properties of the definitionAndBoundSpan response are the standard way to preview definitions.
  • It should work seamlessly with other editors besides VS Code.
• VS Code automatically strips definition indentation.
  • 
  • https://github.com/microsoft/vscode/blob/dd48c7f264782fc16486381e8792f79a3f7a19fa/src/vs/editor/contrib/gotoSymbol/browser/link/goToDefinitionAtPosition.ts#L237
  • [RFC] JSDoc for hovering #179 cannot do this.
• The implementation is simple.
  • Unlike [RFC] JSDoc for hovering #179, there is no need to change the .d.ts format.
• Value declarations (@value <name>: <value>) can also be previewed correctly.
  • [RFC] JSDoc for hovering #179 cannot do this.

Cons

• In VS Code, definitions cannot be previewed as easily as in [RFC] JSDoc for hovering #179.
  • Hover alone does not trigger the preview. The Cmd key must be pressed.
• In VS Code, hovering without the Cmd key and then pressing the Cmd key after hovering does not preview the definition.
  • https://github.com/user-attachments/assets/5c376c0b-473c-455a-938f-991f6ac0b2b2
  • This is a VS Code bug: Pressing cmd with hover open does not peek symbol microsoft/vscode#167781

[changeset-bot]

🦋 Changeset detected

Latest commit: b690b34

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages

Name	Type
@css-modules-kit/ts-plugin	Minor
@css-modules-kit/core	Minor
css-modules-kit-vscode	Patch
@css-modules-kit/codegen	Patch
@css-modules-kit/stylelint-plugin	Patch
@css-modules-kit/eslint-plugin	Patch

Not sure what this means? Click here to learn what changesets are.

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

[mizdra]

This is a movie for README.

2025-06-16.0.25.40.mov

[mizdra]

I tried to check if it works with Zed, but it seems that Zed does not support definition preview by hover.