Skip to content

fix(stability): don't mark definitions as deprecated #456

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
merged 1 commit into from
Oct 16, 2025
Merged

fix(stability): don't mark definitions as deprecated #456

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
3 changes: 3 additions & 0 deletions src/generators/metadata/constants.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// On "About this Documentation", we define the stability indices, and thus
// we don't need to check it for stability references
export const IGNORE_STABILITY_STEMS = ['documentation'];
7 changes: 6 additions & 1 deletion src/generators/metadata/utils/parse.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import createMetadata from '../../../metadata.mjs';
import createNodeSlugger from '../../../utils/parser/slugger.mjs';
import createQueries from '../../../utils/queries/index.mjs';
import { getRemark } from '../../../utils/remark.mjs';
import { IGNORE_STABILITY_STEMS } from '../constants.mjs';

/**
* This generator generates a flattened list of metadata entries from a API doc
Expand Down Expand Up @@ -74,6 +75,10 @@ export const parseApiDoc = ({ file, tree }) => {
tree.children.unshift(createTree('heading', { depth: 1 }, []));
}

// On "About this Documentation", we define the stability indices, and thus
// we don't need to check it for stability references
const ignoreStability = IGNORE_STABILITY_STEMS.includes(file.stem);

// Handles iterating the tree and creating subtrees for each API doc entry
// where an API doc entry is defined by a Heading Node
// (so all elements after a Heading until the next Heading)
Expand Down Expand Up @@ -110,7 +115,7 @@ export const parseApiDoc = ({ file, tree }) => {
// Visits all Stability Index nodes from the current subtree if there's any
// and then apply the Stability Index metadata to the current metadata entry
visit(subTree, createQueries.UNIST.isStabilityNode, node =>
addStabilityMetadata(node, apiEntryMetadata)
addStabilityMetadata(node, ignoreStability ? undefined : apiEntryMetadata)
);

// Visits all HTML nodes from the current subtree and if there's any that matches
Expand Down
4 changes: 2 additions & 2 deletions src/utils/queries/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ const createQueries = () => {
* Parses a Stability Index Entry and updates the current Metadata
*
* @param {import('@types/mdast').Blockquote} node Thead Link Reference Node
* @param {ReturnType<import('../../metadata.mjs').default>} apiEntryMetadata The API entry Metadata
* @param {ReturnType<import('../../metadata.mjs').default>} [apiEntryMetadata] The API entry Metadata
*/
const addStabilityMetadata = (node, apiEntryMetadata) => {
// `node` is a `blockquote` node, and the first child will always be
Expand Down Expand Up @@ -151,7 +151,7 @@ const createQueries = () => {
);

// Adds the Stability Index metadata to the current Metadata entry
apiEntryMetadata.addStability(stabilityIndexNode);
apiEntryMetadata?.addStability(stabilityIndexNode);
}

return [SKIP];
Expand Down
Loading