-
Notifications
You must be signed in to change notification settings - Fork 4
feat(*): introducing multi api overrides for wc #1756
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.
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
base: vnext
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR refactors the API documentation path configuration to use a structured object-based approach instead of scattered string properties. The main change introduces ApiDocPaths interface to consolidate API documentation root paths and their overrides into a single, well-typed structure.
Key changes:
- Introduced
ApiDocPathsandApiDocOverrideinterfaces for better type safety - Refactored
apiDocRootfrom string to object withdefaultandoverrideproperties - Consolidated override logic previously spread across multiple properties (
apiDocOverrideRoot,apiDocOverridePackages,apiDocOverrideComponents) into structured override objects - Applied extensive code formatting fixes (spacing, indentation alignment)
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/ext/MappingLoader.ts | Added new TypeScript interfaces ApiDocOverride and ApiDocPaths for API documentation path configuration |
| src/ext/MarkdownTransformer.ts | Updated to use new ApiDocPaths type, refactored override logic to iterate through override array, extensive formatting improvements |
| docConfig.json | Restructured API documentation configuration from flat properties to nested object structure with default and overrides arrays |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ing or encoding Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (5)
src/ext/MarkdownTransformer.ts:142
- The
apiRootparameter is now of typeApiDocPaths(an object), but is being used as a string. This should beapiRoot.default + blazorNamespace + "." + resolvedType + ".html"to access the default API root path.
linkText = apiRoot + blazorNamespace + "." + resolvedType + ".html";
src/ext/MarkdownTransformer.ts:195
- The
apiRootparameter is now of typeApiDocPaths(an object), but is being used as a string. This should beapiRoot.default + "classes/" + packageText + resolvedType.toLowerCase() + ".html"to access the default API root path.
linkText = apiRoot + "classes/" + packageText + resolvedType.toLowerCase() + ".html";
src/ext/MarkdownTransformer.ts:197
- The
apiRootparameter is now of typeApiDocPaths(an object), but is being used as a string. This should beapiRoot.default + "enums/" + packageText + resolvedType.toLowerCase() + ".html"to access the default API root path.
linkText = apiRoot + "enums/" + packageText + resolvedType.toLowerCase() + ".html";
src/ext/MarkdownTransformer.ts:199
- The
apiRootparameter is now of typeApiDocPaths(an object), but is being used as a string. This should beapiRoot.default + "interfaces/" + packageText + resolvedType.toLowerCase() + ".html"to access the default API root path.
linkText = apiRoot + "interfaces/" + packageText + resolvedType.toLowerCase() + ".html";
src/ext/MarkdownTransformer.ts:201
- The
apiRootparameter is now of typeApiDocPaths(an object), but is being used as a string. This should beapiRoot.default + "types/" + packageText + resolvedType.toLowerCase() + ".html"to access the default API root path.
linkText = apiRoot + "types/" + packageText + resolvedType.toLowerCase() + ".html";
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…niteUI/igniteui-xplat-docs into sstoychev/better-api-handling
No description provided.