Support deprecated by Suyog241005 · Pull Request #136 · hyperjump-io/json-language-server

Suyog241005 · 2026-10-04T10:23:23Z

Summary

This PR adds support for the standard deprecated keyword and VS Code's custom deprecationMessage and markdownDeprecationMessage keywords. It was rebuilt on top of #139 and follows its split between location annotations and value annotations.

What changed

Registered deprecationMessage and markdownDeprecationMessage in the vscode vocabulary, with meta-schema entries.
JsonSchemaAnnotation gets a deprecated() accessor for the standard keyword. VscodeAnnotation adds deprecationMessage() and markdownDeprecationMessage(), and overrides deprecated() so a message deprecates on its own. Schemas that don't use the vocabulary still work through the unknown# annotations.
A small findDeprecated helper picks the deprecated annotation that carries a message, so every feature below applies the same rule.
Hover: appends ⚠️ **Deprecated:** <message>, or ⚠️ **Deprecated** when only deprecated: true is set. Hovering a key uses location annotations; hovering a value adds value annotations, the same way descriptions already work.
Diagnostics: new DeprecatedDiagnosticsProvider reports a Warning tagged Deprecated. A deprecated location is marked on the property key, a deprecated value is marked on the value, and both are marked when both apply.
Property completions: tagged Deprecated with the message as documentation, based on location annotations only. A property whose values are only conditionally deprecated is not tagged.
Value completions: tagged based on each completion's own annotations, so a deprecated anyOf alternative is tagged while values of a deprecated location are not.

Screenshots

Deprecated locations are marked on the key, deprecated values on the value. foo is a deprecated location, "a" is a deprecated value, baz and "c" are both.

A value of a deprecated location isn't deprecated unless z, and "legacy" remain marked.

Value completions are tagged per value. "a" is deprecatedentation, "b" is not.

Closes #97
Closes #86

Suyog241005 · 2026-10-04T11:43:32Z

Hi @jdesrosiers, this is ready for review whenever you have time.

jdesrosiers

As I described in #139, you're going to have to do this again. But, this time you'll have the right foundation to do it right. Sorry for the churn.

Suyog241005 · 2026-10-08T09:38:29Z

@jdesrosiers No problem, done. Rebuilt on top of #139 using the location vs value annotation split. The anyOf case from #86 now works too, since completions carry their own annotations. Description and screenshots are updated. Ready for another look.

jdesrosiers

I pushed a couple bug fixes and some additional tests. There are a few additional things inline for you to look into.

jdesrosiers · 2026-10-09T20:10:43Z

+        const deprecated = findDeprecated(annotations);
+        if (deprecated) {
+          const message = deprecated.markdownDeprecationMessage();
+          lines.push(message ? `⚠️ **Deprecated:** ${message}` : "⚠️ **Deprecated**");
+        }
+


We don't want deprecated messaging in Hover. The deprecated diagnostic already displays the message on hover, so this just duplicates it.

Removed, along with its tests.

jdesrosiers · 2026-10-09T20:18:19Z

+// The annotation that deprecates a location or value, preferring one that
+// says why. Undefined if none of them deprecate it.
+export const findDeprecated = (annotations: Annotation[]): Annotation | undefined => {
+  const deprecated = annotations.filter((annotation) => annotation.deprecated());
+  return deprecated.find((annotation) => annotation.markdownDeprecationMessage() !== undefined) ?? deprecated[0];
+};


Using find here is problematic because there could be multiple subschemas that applied to the location that include deprecation annotations. We need to take all of them into account similar to how we handle multiple title/description keywords in Hover.

Replaced with filtering every annotation that deprecates the location or value. Diagnostics join all the messages, and completion documentation does the same. Added tests for two allOf branches each contributing a message.

jdesrosiers · 2026-10-09T20:22:14Z

+          const message = deprecated.markdownDeprecationMessage();
+          if (message) {
+            completionItem.documentation = { kind: MarkupKind.Markdown, value: message };
+          }


The way markdownDeprecationMessage is implemented, you might get back the non-markdown deprecationMessage, but you're using MarkupKind.Markdown in either case. The non-markdown case should use Markup.PlainText.

Fixed. markdownDeprecationMessage no longer falls back to deprecationMessage, so the documentation kind is PlainText unless at least one annotation has a markdown message. Tests cover plain, markdown, and mixed.

Suyog241005 · 2026-10-11T07:45:36Z

Thanks for the fixes and extra tests. Addressed all three comments:

Hover no longer shows deprecation.
Every schema that deprecates a location or value contributes its message instead of picking one.
Completion documentation is plain text unless a markdownDeprecationMessage is present.

Registers deprecationMessage and markdownDeprecationMessage in the vscode vocabulary. JsonSchemaAnnotation gets a deprecated accessor for the standard keyword and VscodeAnnotation adds the message accessors, which also deprecate on their own. Hover shows a notice after the description.

A deprecated property is marked on its key no matter what its value is. A value deprecated by the schema branch that matched it, such as an anyOf alternative, is marked on the value.

Uses the location annotations of the candidate property, so a property whose values are only conditionally deprecated isn't tagged.

Uses the annotations of each completion value, so values of a deprecated location aren't tagged unless they're deprecated themselves.

walkNodes doesn't visit properties without a value node, so a deprecated key was never reported while the property was still being typed. Check properties from their object instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

…ated tag Without the deprecated tag, the client can't strike through deprecated text, so the diagnostics would just be noise. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Cover invalid values, nested properties, deprecation reached through $ref, allOf, oneOf, and not, deprecated type alternatives, intersections, and properties deprecated in an alternative of their parent. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

The deprecated diagnostic already shows the message on hover.

More than one schema can deprecate the same location, so all of their messages are reported instead of just one. Completion documentation is plain text unless a markdownDeprecationMessage is present.

The diagnostic used the empty string as its message instead of falling back to "Deprecated", while hover and completions treated it as no message. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

deprecated is an unknown keyword in draft-04/06/07, so its annotation was only found under the unknown keyword URI. VS Code's JSON support honors it in those dialects too. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

getPointerForNode walks up to the root and looks up array indexes with indexOf, so calling it for every node made deprecated diagnostics and collectIncompleteLocations quadratic in the size of large arrays. walkNodes now passes each node's pointer to the callback. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

When any deprecation message is markdown, completion documentation is markdown, so plain text messages joined with it were rendered as markup. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

jdesrosiers requested changes Oct 7, 2026

View reviewed changes

Suyog241005 force-pushed the support-deprecated branch from c20daba to e1fd17e Compare October 8, 2026 09:13

Suyog241005 requested a review from jdesrosiers October 8, 2026 15:01

jdesrosiers requested changes Oct 9, 2026

View reviewed changes

Suyog241005 force-pushed the support-deprecated branch 2 times, most recently from 3b1156a to 0135a8d Compare October 11, 2026 07:40

Suyog241005 requested a review from jdesrosiers October 11, 2026 07:45

srivastava-diya mentioned this pull request Oct 11, 2026

Show title and description in completions #154

Open

Suyog241005 and others added 14 commits October 13, 2026 13:34

Report deprecated locations and values as diagnostics

989452d

A deprecated property is marked on its key no matter what its value is. A value deprecated by the schema branch that matched it, such as an anyOf alternative, is marked on the value.

Tag deprecated properties in property completions

4cb21ac

Uses the location annotations of the candidate property, so a property whose values are only conditionally deprecated isn't tagged.

Tag deprecated values in value completions

97a920b

Uses the annotations of each completion value, so values of a deprecated location aren't tagged unless they're deprecated themselves.

Only report deprecated diagnostics to clients that support the deprec…

88ed491

…ated tag Without the deprecated tag, the client can't strike through deprecated text, so the diagnostics would just be noise. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Don't show deprecation in Hover

40aea92

The deprecated diagnostic already shows the message on hover.

Combine the messages of every schema that deprecates a location or value

686be6e

More than one schema can deprecate the same location, so all of their messages are reported instead of just one. Completion documentation is plain text unless a markdownDeprecationMessage is present.

Treat an empty deprecation message as no message

81b9d37

The diagnostic used the empty string as its message instead of falling back to "Deprecated", while hover and completions treated it as no message. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Support the deprecated keyword in dialects before 2019-09

de24958

deprecated is an unknown keyword in draft-04/06/07, so its annotation was only found under the unknown keyword URI. VS Code's JSON support honors it in those dialects too. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Share deprecated tagging between property and value completions

56f8679

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Escape plain text deprecation messages combined with markdown ones

d4faac9

When any deprecation message is markdown, completion documentation is markdown, so plain text messages joined with it were rendered as markup. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

jdesrosiers force-pushed the support-deprecated branch from 0135a8d to d4faac9 Compare October 13, 2026 21:17

jdesrosiers approved these changes Oct 13, 2026

View reviewed changes

jdesrosiers merged commit 5470552 into hyperjump-io:main Oct 13, 2026
3 checks passed

Navigation Menu

Repository navigation

Support deprecated - #136

Support deprecated#136
jdesrosiers merged 14 commits into
hyperjump-io:mainfrom
Suyog241005:support-deprecated

Suyog241005 commented Oct 4, 2026 •

edited

Loading

Uh oh!

Suyog241005 commented Oct 4, 2026

Uh oh!

jdesrosiers left a comment

Uh oh!

Suyog241005 commented Oct 8, 2026

Uh oh!

jdesrosiers left a comment

Uh oh!

jdesrosiers Oct 9, 2026

Uh oh!

Suyog241005 Oct 11, 2026

Uh oh!

jdesrosiers Oct 9, 2026

Uh oh!

Suyog241005 Oct 11, 2026

Uh oh!

jdesrosiers Oct 9, 2026

Uh oh!

Suyog241005 Oct 11, 2026

Uh oh!

Suyog241005 commented Oct 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Suyog241005 commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What changed

Screenshots

Uh oh!

Suyog241005 commented Oct 4, 2026

Uh oh!

jdesrosiers left a comment

Choose a reason for hiding this comment

Uh oh!

Suyog241005 commented Oct 8, 2026

Uh oh!

jdesrosiers left a comment

Choose a reason for hiding this comment

Uh oh!

jdesrosiers Oct 9, 2026

Choose a reason for hiding this comment

Uh oh!

Suyog241005 Oct 11, 2026

Choose a reason for hiding this comment

Uh oh!

jdesrosiers Oct 9, 2026

Choose a reason for hiding this comment

Uh oh!

Suyog241005 Oct 11, 2026

Choose a reason for hiding this comment

Uh oh!

jdesrosiers Oct 9, 2026

Choose a reason for hiding this comment

Uh oh!

Suyog241005 Oct 11, 2026

Choose a reason for hiding this comment

Uh oh!

Suyog241005 commented Oct 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Suyog241005 commented Oct 4, 2026 •

edited

Loading