feat(ApiLink): add kind="sass" for SASS API documentation links#45
Open
dobromirts wants to merge 1 commit into
Open
feat(ApiLink): add kind="sass" for SASS API documentation links#45dobromirts wants to merge 1 commit into
dobromirts wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends the MDX ApiLink component to support linking into SASS API documentation by introducing a new kind="sass" variant and a corresponding optional sassApiUrl in PlatformContext.
Changes:
- Added
sassApiUrl?: stringtoPlatformContextfor configuring a SASS API docs base URL. - Extended
ApiLinkwithkind="sass", plusmoduleandcodeprops, and adjusted label rendering for sass links. - Refactored
ApiLinkURL/label construction to handle both TypeDoc kinds and the new sass kind.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/lib/types.ts |
Adds sassApiUrl?: string to the platform context to support SASS API link generation. |
src/components/mdx/ApiLink/ApiLink.astro |
Adds kind="sass" handling, new props, and conditional code formatting for sass labels. |
Comments suppressed due to low confidence (1)
src/components/mdx/ApiLink/ApiLink.astro:119
typewas made optional to supportkind="sass", but the non-sass branch still buildsbaseTypevia${prefix}${type}whenprefixedis true. Iftypeis omitted this will produceIgrundefined(and invalid TypeDoc slugs/labels) instead of failing fast. Consider modelingPropsas a discriminated union (sass vs typedoc) sotypestays required for non-sass kinds, or add a runtime guard that errors whentypeis missing outside ofkind="sass".
const pkgConfig = apiPackages[pkg] ?? apiPackages['core'];
const baseType = prefixed ? `${prefix}${type}` : (type ?? '');
const segment = KIND_SEGMENT[kind];
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+112
to
+115
| if (kind === 'sass') { | ||
| const anchor = type ? `#${type}` : ''; | ||
| url = `${ctx.sassApiUrl ?? ''}/${module ?? ''}${anchor}`; | ||
| displayLabel = label ?? type ?? module ?? ''; |
| @@ -63,4 +63,5 @@ export interface PlatformContext { | |||
| forums: string; | |||
| repoSamples: string; | |||
| }; | |||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
by default, matching TypeDoc link behaviour.