Skip to content

Match whole words when bolding member names in MDN comments #2576

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

Open
Ngo Quoc Viet (NgoQuocViet2001) wants to merge 1 commit into
base: main
Choose a base branch
from
+39 −38
Open

Match whole words when bolding member names in MDN comments #2576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions baselines/dom.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12310,7 +12310,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down Expand Up @@ -19177,7 +19177,7 @@ interface HTMLImageElement extends HTMLElement {
*/
readonly x: number;
/**
* The read-onl**`y`** y property of the HTMLImageElement interface indicates the y-coordinate of the <img> element's top border edge relative to the root element's origin.
* The read-only **`y`** property of the HTMLImageElement interface indicates the y-coordinate of the <img> element's top border edge relative to the root element's origin.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLImageElement/y)
*/
Expand Down Expand Up @@ -33875,7 +33875,7 @@ interface SVGMaskElement extends SVGElement {
*/
readonly x: SVGAnimatedLength;
/**
* The read-onl**`y`** y property of the SVGMaskElement interface returns an SVGAnimatedLength object containing the value of the y attribute of the <mask>. It represents the y-axis coordinate of the top-left corner of the masking area.
* The read-only **`y`** property of the SVGMaskElement interface returns an SVGAnimatedLength object containing the value of the y attribute of the <mask>. It represents the y-axis coordinate of the top-left corner of the masking area.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGMaskElement/y)
*/
Expand Down Expand Up @@ -37290,7 +37290,7 @@ interface TextEvent extends UIEvent {
*/
readonly data: string;
/**
* The **`initTextEvent`**Event() method of the TextEvent interface initializes the value of a TextEvent after it has been created.
* The initTextEventEvent() method of the TextEvent interface initializes the value of a TextEvent after it has been created.
* @deprecated
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEvent/initTextEvent)
Expand Down Expand Up @@ -42275,7 +42275,7 @@ interface Window extends EventTarget, AnimationFrameProvider, GlobalEventHandler
*/
readonly toolbar: BarProp;
/**
* Returns a reference to the **`top`**most window in the window hierarchy.
* Returns a reference to the topmost window in the window hierarchy.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/top)
*/
Expand Down Expand Up @@ -44522,7 +44522,7 @@ declare var statusbar: BarProp;
*/
declare var toolbar: BarProp;
/**
* Returns a reference to the **`top`**most window in the window hierarchy.
* Returns a reference to the topmost window in the window hierarchy.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/top)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/serviceworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3325,7 +3325,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/sharedworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3106,7 +3106,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
12 changes: 6 additions & 6 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 @@ -12299,7 +12299,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down Expand Up @@ -19159,7 +19159,7 @@ interface HTMLImageElement extends HTMLElement {
*/
readonly x: number;
/**
* The read-onl**`y`** y property of the HTMLImageElement interface indicates the y-coordinate of the <img> element's top border edge relative to the root element's origin.
* The read-only **`y`** property of the HTMLImageElement interface indicates the y-coordinate of the <img> element's top border edge relative to the root element's origin.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLImageElement/y)
*/
Expand Down Expand Up @@ -33850,7 +33850,7 @@ interface SVGMaskElement extends SVGElement {
*/
readonly x: SVGAnimatedLength;
/**
* The read-onl**`y`** y property of the SVGMaskElement interface returns an SVGAnimatedLength object containing the value of the y attribute of the <mask>. It represents the y-axis coordinate of the top-left corner of the masking area.
* The read-only **`y`** property of the SVGMaskElement interface returns an SVGAnimatedLength object containing the value of the y attribute of the <mask>. It represents the y-axis coordinate of the top-left corner of the masking area.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGMaskElement/y)
*/
Expand Down Expand Up @@ -37264,7 +37264,7 @@ interface TextEvent extends UIEvent {
*/
readonly data: string;
/**
* The **`initTextEvent`**Event() method of the TextEvent interface initializes the value of a TextEvent after it has been created.
* The initTextEventEvent() method of the TextEvent interface initializes the value of a TextEvent after it has been created.
* @deprecated
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEvent/initTextEvent)
Expand Down Expand Up @@ -42249,7 +42249,7 @@ interface Window extends EventTarget, AnimationFrameProvider, GlobalEventHandler
*/
readonly toolbar: BarProp;
/**
* Returns a reference to the **`top`**most window in the window hierarchy.
* Returns a reference to the topmost window in the window hierarchy.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/top)
*/
Expand Down Expand Up @@ -44496,7 +44496,7 @@ declare var statusbar: BarProp;
*/
declare var toolbar: BarProp;
/**
* Returns a reference to the **`top`**most window in the window hierarchy.
* Returns a reference to the topmost window in the window hierarchy.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/top)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/ts5.5/serviceworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3322,7 +3322,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/ts5.5/sharedworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3103,7 +3103,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/ts5.5/webworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3829,7 +3829,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
12 changes: 6 additions & 6 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 @@ -12307,7 +12307,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down Expand Up @@ -19174,7 +19174,7 @@ interface HTMLImageElement extends HTMLElement {
*/
readonly x: number;
/**
* The read-onl**`y`** y property of the HTMLImageElement interface indicates the y-coordinate of the <img> element's top border edge relative to the root element's origin.
* The read-only **`y`** property of the HTMLImageElement interface indicates the y-coordinate of the <img> element's top border edge relative to the root element's origin.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLImageElement/y)
*/
Expand Down Expand Up @@ -33872,7 +33872,7 @@ interface SVGMaskElement extends SVGElement {
*/
readonly x: SVGAnimatedLength;
/**
* The read-onl**`y`** y property of the SVGMaskElement interface returns an SVGAnimatedLength object containing the value of the y attribute of the <mask>. It represents the y-axis coordinate of the top-left corner of the masking area.
* The read-only **`y`** property of the SVGMaskElement interface returns an SVGAnimatedLength object containing the value of the y attribute of the <mask>. It represents the y-axis coordinate of the top-left corner of the masking area.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGMaskElement/y)
*/
Expand Down Expand Up @@ -37287,7 +37287,7 @@ interface TextEvent extends UIEvent {
*/
readonly data: string;
/**
* The **`initTextEvent`**Event() method of the TextEvent interface initializes the value of a TextEvent after it has been created.
* The initTextEventEvent() method of the TextEvent interface initializes the value of a TextEvent after it has been created.
* @deprecated
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEvent/initTextEvent)
Expand Down Expand Up @@ -42272,7 +42272,7 @@ interface Window extends EventTarget, AnimationFrameProvider, GlobalEventHandler
*/
readonly toolbar: BarProp;
/**
* Returns a reference to the **`top`**most window in the window hierarchy.
* Returns a reference to the topmost window in the window hierarchy.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/top)
*/
Expand Down Expand Up @@ -44519,7 +44519,7 @@ declare var statusbar: BarProp;
*/
declare var toolbar: BarProp;
/**
* Returns a reference to the **`top`**most window in the window hierarchy.
* Returns a reference to the topmost window in the window hierarchy.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/top)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/ts5.6/serviceworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3322,7 +3322,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/ts5.6/sharedworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3103,7 +3103,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/ts5.6/webworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3829,7 +3829,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
12 changes: 6 additions & 6 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 @@ -12307,7 +12307,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down Expand Up @@ -19174,7 +19174,7 @@ interface HTMLImageElement extends HTMLElement {
*/
readonly x: number;
/**
* The read-onl**`y`** y property of the HTMLImageElement interface indicates the y-coordinate of the <img> element's top border edge relative to the root element's origin.
* The read-only **`y`** property of the HTMLImageElement interface indicates the y-coordinate of the <img> element's top border edge relative to the root element's origin.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLImageElement/y)
*/
Expand Down Expand Up @@ -33872,7 +33872,7 @@ interface SVGMaskElement extends SVGElement {
*/
readonly x: SVGAnimatedLength;
/**
* The read-onl**`y`** y property of the SVGMaskElement interface returns an SVGAnimatedLength object containing the value of the y attribute of the <mask>. It represents the y-axis coordinate of the top-left corner of the masking area.
* The read-only **`y`** property of the SVGMaskElement interface returns an SVGAnimatedLength object containing the value of the y attribute of the <mask>. It represents the y-axis coordinate of the top-left corner of the masking area.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGMaskElement/y)
*/
Expand Down Expand Up @@ -37287,7 +37287,7 @@ interface TextEvent extends UIEvent {
*/
readonly data: string;
/**
* The **`initTextEvent`**Event() method of the TextEvent interface initializes the value of a TextEvent after it has been created.
* The initTextEventEvent() method of the TextEvent interface initializes the value of a TextEvent after it has been created.
* @deprecated
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEvent/initTextEvent)
Expand Down Expand Up @@ -42272,7 +42272,7 @@ interface Window extends EventTarget, AnimationFrameProvider, GlobalEventHandler
*/
readonly toolbar: BarProp;
/**
* Returns a reference to the **`top`**most window in the window hierarchy.
* Returns a reference to the topmost window in the window hierarchy.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/top)
*/
Expand Down Expand Up @@ -44519,7 +44519,7 @@ declare var statusbar: BarProp;
*/
declare var toolbar: BarProp;
/**
* Returns a reference to the **`top`**most window in the window hierarchy.
* Returns a reference to the topmost window in the window hierarchy.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/top)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/ts5.9/serviceworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3322,7 +3322,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/ts5.9/sharedworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3103,7 +3103,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/ts5.9/webworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3829,7 +3829,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
2 changes: 1 addition & 1 deletion baselines/webworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3832,7 +3832,7 @@ interface DOMPointReadOnly {
*/
readonly x: number;
/**
* The DOMPointReadOnl**`y`** interface's y property holds the vertical coordinate, y, for a read-only point in space.
* The DOMPointReadOnly interface's **`y`** property holds the vertical coordinate, y, for a read-only point in space.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/y)
*/
Expand Down
5 changes: 3 additions & 2 deletions src/build/mdn-comments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,9 @@ function generateComment(summary: string, name: string): string | undefined {
return summary
.replace(/\n/g, " ") // remove newlines
.replace(
// Match optional preceding identifier + dot OR just the name itself
new RegExp(`(?:\\b\\w+\\.)?${name}(\\(\\))?`),
// Match optional preceding identifier + dot OR just the name itself,
// as a whole word so that e.g. `y` does not match the end of `read-only`
new RegExp(`(?:\\b\\w+\\.)?\\b${name}\\b(\\(\\))?`),
(match) => `**\`${match}\`**`,
)
.trim();
Expand Down
Loading