Skip to content

Make sure deprecated is always a string #2271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 9 commits into from
Dec 7, 2025
+48 −45
Merged

Make sure deprecated is always a string #2271

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
455185e
Update deprecation messages in generated TypeScript definitions and K…
Bashamega Dec 5, 2025
3b3f60c
Update webkitLineClamp support status in KDL and adjust TypeScript ha…
Bashamega Dec 5, 2025
6d142a0
lint
Bashamega Dec 5, 2025
359d50d
Merge branch 'microsoft:main' into deprecated-string-only
Bashamega Dec 7, 2025
c02102f
Update KDL to deprecate webkitLineClamp in CSSStyleProperties and enh…
Bashamega Dec 7, 2025
37b41cb
no `supported` anymore
saschanaz Dec 7, 2025
f3ec07b
random property values are all for removals
saschanaz Dec 7, 2025
bd3d1e7
optionalNestedMember
saschanaz Dec 7, 2025
1075f7b
amend deprecation messages
saschanaz Dec 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions baselines/dom.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -947,12 +947,12 @@ interface KeySystemTrackConfiguration {
}

interface KeyboardEventInit extends EventModifierInit {
/** @deprecated */
/** @deprecated CharCode is inconsistent across environments, consider using .key instead */
charCode?: number;
code?: string;
isComposing?: boolean;
key?: string;
/** @deprecated */
/** @deprecated KeyCode is inconsistent across environments, consider using .key instead */
keyCode?: number;
location?: number;
repeat?: boolean;
Expand Down Expand Up @@ -9195,7 +9195,7 @@ interface CSSStyleProperties extends CSSStyleDeclarationBase {
*/
wordSpacing: string;
/**
* @deprecated
* @deprecated The 'wordWrap' property is non-standard and has been replaced by 'overflow-wrap' in modern CSS.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/Reference/Properties/overflow-wrap)
*/
Expand Down Expand Up @@ -39462,7 +39462,7 @@ interface WindowEventHandlers {
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unhandledrejection_event) */
onunhandledrejection: ((this: WindowEventHandlers, ev: PromiseRejectionEvent) => any) | null;
/**
* @deprecated
* @deprecated The unload event is not reliable, consider visibilitychange or pagehide events
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unload_event)
*/
Expand Down Expand Up @@ -41831,7 +41831,7 @@ declare var onstorage: ((this: Window, ev: StorageEvent) => any) | null;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unhandledrejection_event) */
declare var onunhandledrejection: ((this: Window, ev: PromiseRejectionEvent) => any) | null;
/**
* @deprecated
* @deprecated The unload event is not reliable, consider visibilitychange or pagehide events
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unload_event)
*/
Expand Down
10 changes: 5 additions & 5 deletions baselines/ts5.5/dom.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -944,12 +944,12 @@ interface KeySystemTrackConfiguration {
}

interface KeyboardEventInit extends EventModifierInit {
/** @deprecated */
/** @deprecated CharCode is inconsistent across environments, consider using .key instead */
charCode?: number;
code?: string;
isComposing?: boolean;
key?: string;
/** @deprecated */
/** @deprecated KeyCode is inconsistent across environments, consider using .key instead */
keyCode?: number;
location?: number;
repeat?: boolean;
Expand Down Expand Up @@ -9185,7 +9185,7 @@ interface CSSStyleProperties extends CSSStyleDeclarationBase {
*/
wordSpacing: string;
/**
* @deprecated
* @deprecated The 'wordWrap' property is non-standard and has been replaced by 'overflow-wrap' in modern CSS.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/Reference/Properties/overflow-wrap)
*/
Expand Down Expand Up @@ -39436,7 +39436,7 @@ interface WindowEventHandlers {
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unhandledrejection_event) */
onunhandledrejection: ((this: WindowEventHandlers, ev: PromiseRejectionEvent) => any) | null;
/**
* @deprecated
* @deprecated The unload event is not reliable, consider visibilitychange or pagehide events
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unload_event)
*/
Expand Down Expand Up @@ -41805,7 +41805,7 @@ declare var onstorage: ((this: Window, ev: StorageEvent) => any) | null;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unhandledrejection_event) */
declare var onunhandledrejection: ((this: Window, ev: PromiseRejectionEvent) => any) | null;
/**
* @deprecated
* @deprecated The unload event is not reliable, consider visibilitychange or pagehide events
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unload_event)
*/
Expand Down
10 changes: 5 additions & 5 deletions baselines/ts5.6/dom.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -944,12 +944,12 @@ interface KeySystemTrackConfiguration {
}

interface KeyboardEventInit extends EventModifierInit {
/** @deprecated */
/** @deprecated CharCode is inconsistent across environments, consider using .key instead */
charCode?: number;
code?: string;
isComposing?: boolean;
key?: string;
/** @deprecated */
/** @deprecated KeyCode is inconsistent across environments, consider using .key instead */
keyCode?: number;
location?: number;
repeat?: boolean;
Expand Down Expand Up @@ -9192,7 +9192,7 @@ interface CSSStyleProperties extends CSSStyleDeclarationBase {
*/
wordSpacing: string;
/**
* @deprecated
* @deprecated The 'wordWrap' property is non-standard and has been replaced by 'overflow-wrap' in modern CSS.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/Reference/Properties/overflow-wrap)
*/
Expand Down Expand Up @@ -39459,7 +39459,7 @@ interface WindowEventHandlers {
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unhandledrejection_event) */
onunhandledrejection: ((this: WindowEventHandlers, ev: PromiseRejectionEvent) => any) | null;
/**
* @deprecated
* @deprecated The unload event is not reliable, consider visibilitychange or pagehide events
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unload_event)
*/
Expand Down Expand Up @@ -41828,7 +41828,7 @@ declare var onstorage: ((this: Window, ev: StorageEvent) => any) | null;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unhandledrejection_event) */
declare var onunhandledrejection: ((this: Window, ev: PromiseRejectionEvent) => any) | null;
/**
* @deprecated
* @deprecated The unload event is not reliable, consider visibilitychange or pagehide events
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unload_event)
*/
Expand Down
10 changes: 5 additions & 5 deletions baselines/ts5.9/dom.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -944,12 +944,12 @@ interface KeySystemTrackConfiguration {
}

interface KeyboardEventInit extends EventModifierInit {
/** @deprecated */
/** @deprecated CharCode is inconsistent across environments, consider using .key instead */
charCode?: number;
code?: string;
isComposing?: boolean;
key?: string;
/** @deprecated */
/** @deprecated KeyCode is inconsistent across environments, consider using .key instead */
keyCode?: number;
location?: number;
repeat?: boolean;
Expand Down Expand Up @@ -9192,7 +9192,7 @@ interface CSSStyleProperties extends CSSStyleDeclarationBase {
*/
wordSpacing: string;
/**
* @deprecated
* @deprecated The 'wordWrap' property is non-standard and has been replaced by 'overflow-wrap' in modern CSS.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/CSS/Reference/Properties/overflow-wrap)
*/
Expand Down Expand Up @@ -39459,7 +39459,7 @@ interface WindowEventHandlers {
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unhandledrejection_event) */
onunhandledrejection: ((this: WindowEventHandlers, ev: PromiseRejectionEvent) => any) | null;
/**
* @deprecated
* @deprecated The unload event is not reliable, consider visibilitychange or pagehide events
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unload_event)
*/
Expand Down Expand Up @@ -41828,7 +41828,7 @@ declare var onstorage: ((this: Window, ev: StorageEvent) => any) | null;
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unhandledrejection_event) */
declare var onunhandledrejection: ((this: Window, ev: PromiseRejectionEvent) => any) | null;
/**
* @deprecated
* @deprecated The unload event is not reliable, consider visibilitychange or pagehide events
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/unload_event)
*/
Expand Down
4 changes: 2 additions & 2 deletions inputfiles/patches/cssom.kdl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ interface CSSStyleDeclaration \
forwardExtends=CSSStyleProperties

interface CSSStyleProperties replaceReference=CSSStyleDeclaration {
property wordWrap deprecated=#true
property wordWrap deprecated="The 'wordWrap' property is non-standard and has been replaced by 'overflow-wrap' in modern CSS."

// The corresponding standardized property is not supported by
// anyone as of 2024-10.
property webkitLineClamp deprecated=#false
property webkitLineClamp supported=#true
Copy link
Contributor

@saschanaz saschanaz Dec 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A better way would be to remove the field through removals, although it's not supported yet. Maybe that should be the first step.

Copy link
Contributor Author

@Bashamega Bashamega Dec 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you share the syntax for it @saschanaz I can't imagine it

Copy link
Contributor

@saschanaz saschanaz Dec 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something like

removals {
  interface CSSStyleProperties {
    property webkitLineClamp deprecated=#null
  }
}

Or perhaps it's easier to keep using each property's own type, like deprecated="" and let it converted to null via the removal conversion function. Either way would be fine for me.

}
4 changes: 1 addition & 3 deletions inputfiles/patches/html.kdl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,5 @@ interface HTMLDocument extends=Document exposed=Window
interface-mixin MessageEventTarget overrideThis=T typeParameters=T

interface-mixin WindowEventHandlers {
// TODO: pass a string instead for deprecated
// The unload event is not reliable, consider visibilitychange or pagehide events
property onunload deprecated=#true
property onunload deprecated="The unload event is not reliable, consider visibilitychange or pagehide events"
}
7 changes: 2 additions & 5 deletions inputfiles/patches/uievents.kdl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
dictionary KeyboardEventInit {
// TODO: pass a string instead for deprecated
// charCode is inconsistent across environments, consider using .key instead
member charCode deprecated=#true
// keyCode is inconsistent across environments, consider using .key instead
member keyCode deprecated=#true
member charCode deprecated="CharCode is inconsistent across environments, consider using .key instead"
member keyCode deprecated="KeyCode is inconsistent across environments, consider using .key instead"
}
5 changes: 3 additions & 2 deletions src/build/patches.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,8 @@ function handleProperty(child: Node): Partial<Property> {
? handleTyped(typeNode)
: optionalMember("type", "string", child.properties?.type)),
...optionalMember("readonly", "boolean", child.properties?.readonly),
...optionalMember("deprecated", "boolean", child.properties?.deprecated),
...optionalMember("deprecated", "string", child.properties?.deprecated),
...(child.properties?.supported && { deprecated: false }),
};
}

Expand Down Expand Up @@ -366,7 +367,7 @@ function handleMember(c: Node): Partial<Member> {
name,
...optionalMember("type", "string", c.properties?.type),
...optionalMember("required", "boolean", c.properties?.required),
...optionalMember("deprecated", "boolean", c.properties?.deprecated),
...optionalMember("deprecated", "string", c.properties?.deprecated),
...optionalMember("overrideType", "string", c.properties?.overrideType),
};
}
Expand Down