fix(core): improve api custom elements schema#190
Open
coryrylan wants to merge 1 commit into
Open
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe pull request refines component JSDoc metadata, updates selected public attribute mappings and types, and revises CEM type normalization, inheritance, projection, public filtering, and Markdown generation with accompanying tests. ChangesComponent documentation and API metadata
CEM type processing and projection
CEM output filtering and validation
Estimated code review effort: 4 (Complex) | ~45 minutes Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
projects/core/src/accordion/accordion.tsESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox. projects/core/src/avatar/avatar-group.tsESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox. projects/core/src/avatar/avatar.tsESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox.
Comment |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
This PR improves the generated Custom Elements Manifest (CEM) + Markdown output for Elements, and updates many component JSDoc slot descriptions to be clearer and more consistent—especially around expected slot content and ID-ref vs element-ref APIs.
Changes:
- Expanded the CEM tooling to normalize attribute-facing types (e.g., element-ref properties -> string ID attributes), improve type rewriting/matching, and generate clearer Markdown (public-only members; distinct property vs attribute types).
- Updated slot descriptions and several related JSDoc annotations across many core components for clearer API documentation.
- Corrected/clarified a few public API surfaces and doc details (e.g.,
Pagination#stepSizesattribute name, richer value/property docs for Dropzone/PreferencesInput, type refinement for FormatNumber).
Reviewed changes
Copilot reviewed 42 out of 42 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| projects/internals/vite/src/plugins/cem.test.js | Adds unit tests covering new CEM helper utilities (type matching/rewriting, attribute type normalization, public-member filtering, Markdown formatting). |
| projects/internals/vite/src/plugins/cem.config.mjs | Implements new exported helpers and plugins to improve CEM output (attribute-facing types, public-only docs, type normalization, improved Markdown output). |
| projects/forms/src/mixins/button.types.ts | Clarifies JSDoc for readOnly and form to better describe behavior and expected inputs. |
| projects/core/src/tree/tree-node.ts | Converts inline “@Private” comments to JSDoc /** @private */ for better tooling/CEM privacy detection. |
| projects/core/src/tooltip/tooltip.ts | Improves slot description and marks internal queried arrow element as private. |
| projects/core/src/toolbar/toolbar.ts | Clarifies default slot documentation for expected toolbar content. |
| projects/core/src/toggletip/toggletip.ts | Marks internal queried arrow element as private. |
| projects/core/src/toast/toast.ts | Clarifies default slot documentation for toast message content. |
| projects/core/src/tag/tag.ts | Clarifies default slot documentation for tag label/content. |
| projects/core/src/tabs/tabs.ts | Clarifies default slot documentation for tab label content. |
| projects/core/src/steps/steps.ts | Rewrites status property documentation to more explicitly describe each visual/status outcome. |
| projects/core/src/skeleton/skeleton.ts | Clarifies default slot documentation and refines hidden property documentation to match accessibility behavior. |
| projects/core/src/progressive-filter-chip/progressive-filter-chip.ts | Clarifies default slot documentation to describe typical control elements. |
| projects/core/src/preferences-input/preferences-input.ts | Adds explicit JSDoc property/attribute typing for value (and disables a lint rule to preserve types for CEM). |
| projects/core/src/pagination/pagination.ts | Adds explicit step-sizes attribute mapping and clarifies step-size docs/events/slots. |
| projects/core/src/page/page-panel/page-panel.ts | Clarifies default slot documentation for expected panel-body children. |
| projects/core/src/page/page-panel/page-panel-header.ts | Marks auto-slotting slot host attribute as private. |
| projects/core/src/page/page-panel/page-panel-footer.ts | Marks auto-slotting slot host attribute as private. |
| projects/core/src/page-loader/page-loader.ts | Clarifies default slot documentation for loading status text. |
| projects/core/src/notification/notification.ts | Clarifies default slot documentation for notification message content. |
| projects/core/src/menu/menu-item.ts | Clarifies default slot documentation and adds doc comment for status usage. |
| projects/core/src/logo/logo.ts | Clarifies default slot documentation for logo/brand content. |
| projects/core/src/internal/types/index.ts | Clarifies base interface docs for element-reference properties (anchor, trigger) and fixes minor wording. |
| projects/core/src/grid/placeholder/placeholder.ts | Clarifies default slot documentation for loading/empty-state message content. |
| projects/core/src/grid/grid.ts | Clarifies default slot documentation to list expected grid child elements. |
| projects/core/src/grid/footer/footer.ts | Clarifies default slot documentation and marks auto-slotting slot host attribute as private. |
| projects/core/src/grid/column/column.ts | Clarifies default slot documentation for column heading content. |
| projects/core/src/grid/cell/cell.ts | Clarifies default slot documentation for cell content (data/controls). |
| projects/core/src/forms/control-message/control-message.ts | Clarifies default slot documentation and marks auto-slotting slot host attribute as private. |
| projects/core/src/format-number/format-number.ts | Narrows useGrouping to an explicit union (incl. boolean) for clearer API typing. |
| projects/core/src/dropzone/dropzone.ts | Adds explicit JSDoc property typing for value, clarifies slots/docs, and documents key properties. |
| projects/core/src/dropdown/dropdown.ts | Marks internal queried arrow element as private. |
| projects/core/src/dropdown-group/dropdown-group.ts | Removes outdated CSS prop docs and adds a public method doc comment for close(). |
| projects/core/src/drawer/drawer.ts | Clarifies default slot documentation for drawer body content. |
| projects/core/src/dialog/dialog.ts | Clarifies default slot documentation for dialog body content. |
| projects/core/src/copy-button/copy-button.ts | Clarifies default slot documentation for the visible label content. |
| projects/core/src/chat-message/chat-message.ts | Clarifies slot docs and adds docs for key style/layout properties. |
| projects/core/src/card/card.ts | Clarifies slot docs and adds privacy/docs for auto-slotting behavior on subcomponents. |
| projects/core/src/badge/badge.ts | Clarifies default slot documentation for badge text content. |
| projects/core/src/avatar/avatar.ts | Clarifies default slot documentation for avatar identifying content. |
| projects/core/src/avatar/avatar-group.ts | Clarifies default slot documentation for expected nve-avatar children. |
| projects/core/src/accordion/accordion.ts | Clarifies slot docs for header/accordion and refines container property documentation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@projects/core/src/format-number/format-number.ts`:
- Around line 113-114: Update the JSDoc for the useGrouping property to document
its boolean form alongside the existing string values, keeping the public type
declaration and documentation consistent.
In `@projects/internals/vite/src/plugins/cem.config.mjs`:
- Around line 1155-1161: Extract a shared helper near the type-formatting logic
to escape backslashes before escaping pipe characters, then use it for both
propertyType and attributeType in the type construction. Replace the duplicated
inline replace calls while preserving the existing output and mismatch
formatting in the surrounding logic.
- Around line 1590-1602: Update the attribute loop in the manifest generation
logic to apply the same name/direction exclusion as the member loop before
copying descriptions from baseInterface. Prevent baseInterface descriptions from
overwriting component-specific descriptions for attributes named “name” or
“direction,” while preserving the existing shouldUseStandardDescription, docs,
and typesMatch checks for other attributes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: fb366988-e8eb-42d9-8646-a23a9cbcef1a
📒 Files selected for processing (42)
projects/core/src/accordion/accordion.tsprojects/core/src/avatar/avatar-group.tsprojects/core/src/avatar/avatar.tsprojects/core/src/badge/badge.tsprojects/core/src/card/card.tsprojects/core/src/chat-message/chat-message.tsprojects/core/src/copy-button/copy-button.tsprojects/core/src/dialog/dialog.tsprojects/core/src/drawer/drawer.tsprojects/core/src/dropdown-group/dropdown-group.tsprojects/core/src/dropdown/dropdown.tsprojects/core/src/dropzone/dropzone.tsprojects/core/src/format-number/format-number.tsprojects/core/src/forms/control-message/control-message.tsprojects/core/src/grid/cell/cell.tsprojects/core/src/grid/column/column.tsprojects/core/src/grid/footer/footer.tsprojects/core/src/grid/grid.tsprojects/core/src/grid/placeholder/placeholder.tsprojects/core/src/internal/types/index.tsprojects/core/src/logo/logo.tsprojects/core/src/menu/menu-item.tsprojects/core/src/notification/notification.tsprojects/core/src/page-loader/page-loader.tsprojects/core/src/page/page-panel/page-panel-footer.tsprojects/core/src/page/page-panel/page-panel-header.tsprojects/core/src/page/page-panel/page-panel.tsprojects/core/src/pagination/pagination.tsprojects/core/src/preferences-input/preferences-input.tsprojects/core/src/progressive-filter-chip/progressive-filter-chip.tsprojects/core/src/skeleton/skeleton.tsprojects/core/src/steps/steps.tsprojects/core/src/tabs/tabs.tsprojects/core/src/tag/tag.tsprojects/core/src/toast/toast.tsprojects/core/src/toggletip/toggletip.tsprojects/core/src/toolbar/toolbar.tsprojects/core/src/tooltip/tooltip.tsprojects/core/src/tree/tree-node.tsprojects/forms/src/mixins/button.types.tsprojects/internals/vite/src/plugins/cem.config.mjsprojects/internals/vite/src/plugins/cem.test.js
coryrylan
force-pushed
the
topic-grid-api-docs
branch
from
July 23, 2026 19:42
fb1d727 to
e87d5d2
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@projects/core/src/badge/badge.ts`:
- Line 28: Update the badge component’s default-slot documentation to state that
it accepts short status text or an optional unnamed nve-icon promoted to
prefix-icon; only remove this behavior if the icon fallback is not intended to
be public.
In `@projects/core/src/dropzone/dropzone.ts`:
- Line 29: Update the change event JSDoc near the Dropzone event documentation
to state that selected files are available through event.target.value, replacing
the inaccurate claim that they are directly located in event.target. Use clear,
descriptive wording consistent with the API contract.
In `@projects/internals/vite/src/plugins/cem.config.mjs`:
- Around line 45-81: Update rewriteTypesText so Extract<> normalization assigns
the unwrapped text to the local value used by the subsequent alias-expansion
loop, rather than continuing with the stale original text. Strip the closing
Extract delimiter whether or not the expression is followed by an outer union,
while preserving the existing union and alias ordering behavior.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 5c9e0a99-a0df-44d7-af24-4af425f64b48
📒 Files selected for processing (42)
projects/core/src/accordion/accordion.tsprojects/core/src/avatar/avatar-group.tsprojects/core/src/avatar/avatar.tsprojects/core/src/badge/badge.tsprojects/core/src/card/card.tsprojects/core/src/chat-message/chat-message.tsprojects/core/src/copy-button/copy-button.tsprojects/core/src/dialog/dialog.tsprojects/core/src/drawer/drawer.tsprojects/core/src/dropdown-group/dropdown-group.tsprojects/core/src/dropdown/dropdown.tsprojects/core/src/dropzone/dropzone.tsprojects/core/src/format-number/format-number.tsprojects/core/src/forms/control-message/control-message.tsprojects/core/src/grid/cell/cell.tsprojects/core/src/grid/column/column.tsprojects/core/src/grid/footer/footer.tsprojects/core/src/grid/grid.tsprojects/core/src/grid/placeholder/placeholder.tsprojects/core/src/internal/types/index.tsprojects/core/src/logo/logo.tsprojects/core/src/menu/menu-item.tsprojects/core/src/notification/notification.tsprojects/core/src/page-loader/page-loader.tsprojects/core/src/page/page-panel/page-panel-footer.tsprojects/core/src/page/page-panel/page-panel-header.tsprojects/core/src/page/page-panel/page-panel.tsprojects/core/src/pagination/pagination.tsprojects/core/src/preferences-input/preferences-input.tsprojects/core/src/progressive-filter-chip/progressive-filter-chip.tsprojects/core/src/skeleton/skeleton.tsprojects/core/src/steps/steps.tsprojects/core/src/tabs/tabs.tsprojects/core/src/tag/tag.tsprojects/core/src/toast/toast.tsprojects/core/src/toggletip/toggletip.tsprojects/core/src/toolbar/toolbar.tsprojects/core/src/tooltip/tooltip.tsprojects/core/src/tree/tree-node.tsprojects/forms/src/mixins/button.types.tsprojects/internals/vite/src/plugins/cem.config.mjsprojects/internals/vite/src/plugins/cem.test.js
coryrylan
force-pushed
the
topic-grid-api-docs
branch
from
July 23, 2026 21:42
e87d5d2 to
4b56e54
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
projects/core/src/format-number/format-number.ts (1)
113-114: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winKeep
useGroupingdocumentation aligned with its public type.The type now accepts
boolean, but the JSDoc still documents only string values. Document the boolean form, or clarify that booleans are supported through JavaScript property assignment.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@projects/core/src/format-number/format-number.ts` around lines 113 - 114, Update the JSDoc for the useGrouping property to document its boolean support alongside the existing string values, or explicitly state that booleans are supported through JavaScript property assignment. Keep the public type declaration and runtime behavior unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@projects/core/src/accordion/accordion.ts`:
- Line 106: Update the JSDoc description for the `icon-button` slot in the
accordion component to identify it as an icon button control, matching the
`<nve-icon-button>` fallback rather than describing it as generic icon elements.
In `@projects/core/src/pagination/pagination.ts`:
- Around line 57-59: Update the JSDoc immediately above the stepSizes property
to document the step-sizes attribute as a JSON array, including an example such
as step-sizes="[10, 20, 50]". Keep the existing property declaration and
behavior unchanged.
In `@projects/internals/vite/src/plugins/cem.config.mjs`:
- Around line 51-56: Update the parsing branch around the text transformation to
match only the exact Extract< prefix, not aliases such as ExtractedType. Replace
the naive split(',')[1] logic with bracket-aware parsing that finds the
top-level comma inside Extract<…>, preserving nested generic operands; add
regressions covering both alias input and nested generic input.
---
Duplicate comments:
In `@projects/core/src/format-number/format-number.ts`:
- Around line 113-114: Update the JSDoc for the useGrouping property to document
its boolean support alongside the existing string values, or explicitly state
that booleans are supported through JavaScript property assignment. Keep the
public type declaration and runtime behavior unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 01c43ce5-2f80-4dec-90b6-c4aae9adc351
📒 Files selected for processing (42)
projects/core/src/accordion/accordion.tsprojects/core/src/avatar/avatar-group.tsprojects/core/src/avatar/avatar.tsprojects/core/src/badge/badge.tsprojects/core/src/card/card.tsprojects/core/src/chat-message/chat-message.tsprojects/core/src/copy-button/copy-button.tsprojects/core/src/dialog/dialog.tsprojects/core/src/drawer/drawer.tsprojects/core/src/dropdown-group/dropdown-group.tsprojects/core/src/dropdown/dropdown.tsprojects/core/src/dropzone/dropzone.tsprojects/core/src/format-number/format-number.tsprojects/core/src/forms/control-message/control-message.tsprojects/core/src/grid/cell/cell.tsprojects/core/src/grid/column/column.tsprojects/core/src/grid/footer/footer.tsprojects/core/src/grid/grid.tsprojects/core/src/grid/placeholder/placeholder.tsprojects/core/src/internal/types/index.tsprojects/core/src/logo/logo.tsprojects/core/src/menu/menu-item.tsprojects/core/src/notification/notification.tsprojects/core/src/page-loader/page-loader.tsprojects/core/src/page/page-panel/page-panel-footer.tsprojects/core/src/page/page-panel/page-panel-header.tsprojects/core/src/page/page-panel/page-panel.tsprojects/core/src/pagination/pagination.tsprojects/core/src/preferences-input/preferences-input.tsprojects/core/src/progressive-filter-chip/progressive-filter-chip.tsprojects/core/src/skeleton/skeleton.tsprojects/core/src/steps/steps.tsprojects/core/src/tabs/tabs.tsprojects/core/src/tag/tag.tsprojects/core/src/toast/toast.tsprojects/core/src/toggletip/toggletip.tsprojects/core/src/toolbar/toolbar.tsprojects/core/src/tooltip/tooltip.tsprojects/core/src/tree/tree-node.tsprojects/forms/src/mixins/button.types.tsprojects/internals/vite/src/plugins/cem.config.mjsprojects/internals/vite/src/plugins/cem.test.js
coryrylan
force-pushed
the
topic-grid-api-docs
branch
from
July 24, 2026 04:13
4b56e54 to
9a1cba1
Compare
| static styles = useStyles([styles]); | ||
|
|
||
| /** Applies danger styling to destructive or high-risk menu actions. */ | ||
| @property({ type: String, reflect: true }) status: 'danger'; |
Update slot descriptions across multiple components for clarity and consistency. Enhanced documentation for slots in Accordion, Avatar, Badge, Card, Chat Message, Copy Button, Dialog, Drawer, Dropdown, Grid, Menu Item, Notification, Toast, and others to specify expected content types and usage. Signed-off-by: Cory Rylan <crylan@nvidia.com>
coryrylan
force-pushed
the
topic-grid-api-docs
branch
from
July 24, 2026 18:32
9a1cba1 to
0597367
Compare
Comment on lines
+1684
to
+1688
| const nonPublicMemberNames = new Set( | ||
| declaration.members | ||
| ?.filter(member => member.privacy != null && member.privacy !== 'public') | ||
| .map(member => member.name) | ||
| ); |
There was a problem hiding this comment.
♻️ Duplicate comments (2)
projects/internals/vite/src/plugins/cem.config.mjs (2)
1650-1662: 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick winAttribute descriptions still missing the
name/directionexclusion applied to members.The member loop above (lines 1637-1646) excludes
member.name === 'name'/'direction'before lettingbaseInterfaceoverwrite the description, but this attribute loop has no matching guard. IfbaseInterface['name']/baseInterface['direction']exist andtypesMatchpasses, the attribute description is silently overwritten with the generic base description while the corresponding member's description stays component-specific — producing inconsistent property vs. attribute docs, which runs counter to this PR's goal of consistent descriptions. This mirrors a prior review comment on this same range that was not marked as addressed.🐛 Proposed fix
for (const attribute of declaration.attributes ?? []) { rewriteTypesText(attribute, stringLiteralsByTypeAlias); if ( + attribute.fieldName !== 'name' && + attribute.fieldName !== 'direction' && shouldUseStandardDescription(declaration, attribute) && baseInterface[attribute.name] && baseInterface[attribute.name].docs.length && typesMatch(attribute, baseInterface[attribute.name]) ) { attribute.description = baseInterface[attribute.name].docs[0]?.description; } addValueDescriptions(attribute); }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@projects/internals/vite/src/plugins/cem.config.mjs` around lines 1650 - 1662, Add the same name/direction exclusion used in the member loop to the attribute loop before the baseInterface description overwrite in the declaration attribute processing. Ensure attributes named "name" or "direction" retain their component-specific descriptions, while other attributes continue using the existing shouldUseStandardDescription, baseInterface, docs, and typesMatch checks.
45-58: 🩺 Stability & Availability | 🟠 Major | ⚡ Quick win
Extract<>handling still crashes on alias false-positives and mis-splits nested generics.Two defects from a prior unresolved review remain:
text.startsWith('Extract')matches any alias merely prefixed with"Extract"(e.g. a hypotheticalExtractedType). For such text,.split(',')[1]isundefinedand.trim()throws, crashing the wholepackageLinkPhase.- For nested-generic first operands like
Extract<Record<string, Foo>, Size>, the non-global>-removal regex leaves the innerFoo>intact, and.split(',')[1]then returns the wrong fragment ("Foo>"instead of"Size"), corrupting the generated type text.🐛 Proposed fix using bracket-aware parsing
- if (text.startsWith('Extract')) { - text = text - .replace('Extract<', '') - .replace(/>(?=\s*(?:\||$))/, '') - .split(',')[1] - .trim(); - entry.type.text = text; - } + if (/^Extract</.test(text)) { + const inner = text.slice(text.indexOf('<') + 1, text.lastIndexOf('>')); + let depth = 0; + let splitIndex = -1; + for (let i = 0; i < inner.length; i++) { + if (inner[i] === '<') depth++; + else if (inner[i] === '>') depth--; + else if (inner[i] === ',' && depth === 0) { + splitIndex = i; + break; + } + } + if (splitIndex !== -1) { + text = inner.slice(splitIndex + 1).trim(); + entry.type.text = text; + } + }Please also add regression tests covering an alias-like name (e.g.
ExtractedType) and a nested-generic first operand, as previously suggested.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@projects/internals/vite/src/plugins/cem.config.mjs` around lines 45 - 58, The rewriteTypesText function must only process the exact Extract<> utility and safely leave alias-like names such as ExtractedType unchanged. Replace the string replacement and comma split with bracket-aware parsing that identifies the top-level separator, correctly extracting the second operand from nested generics such as Extract<Record<string, Foo>, Size> without throwing or corrupting text. Add regression tests covering both alias-like input and nested-generic operands.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@projects/internals/vite/src/plugins/cem.config.mjs`:
- Around line 1650-1662: Add the same name/direction exclusion used in the
member loop to the attribute loop before the baseInterface description overwrite
in the declaration attribute processing. Ensure attributes named "name" or
"direction" retain their component-specific descriptions, while other attributes
continue using the existing shouldUseStandardDescription, baseInterface, docs,
and typesMatch checks.
- Around line 45-58: The rewriteTypesText function must only process the exact
Extract<> utility and safely leave alias-like names such as ExtractedType
unchanged. Replace the string replacement and comma split with bracket-aware
parsing that identifies the top-level separator, correctly extracting the second
operand from nested generics such as Extract<Record<string, Foo>, Size> without
throwing or corrupting text. Add regression tests covering both alias-like input
and nested-generic operands.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 7893fb95-5ae4-422b-923b-367dfe4e43b1
📒 Files selected for processing (42)
projects/core/src/accordion/accordion.tsprojects/core/src/avatar/avatar-group.tsprojects/core/src/avatar/avatar.tsprojects/core/src/badge/badge.tsprojects/core/src/card/card.tsprojects/core/src/chat-message/chat-message.tsprojects/core/src/copy-button/copy-button.tsprojects/core/src/dialog/dialog.tsprojects/core/src/drawer/drawer.tsprojects/core/src/dropdown-group/dropdown-group.tsprojects/core/src/dropdown/dropdown.tsprojects/core/src/dropzone/dropzone.tsprojects/core/src/format-number/format-number.tsprojects/core/src/forms/control-message/control-message.tsprojects/core/src/grid/cell/cell.tsprojects/core/src/grid/column/column.tsprojects/core/src/grid/footer/footer.tsprojects/core/src/grid/grid.tsprojects/core/src/grid/placeholder/placeholder.tsprojects/core/src/internal/types/index.tsprojects/core/src/logo/logo.tsprojects/core/src/menu/menu-item.tsprojects/core/src/notification/notification.tsprojects/core/src/page-loader/page-loader.tsprojects/core/src/page/page-panel/page-panel-footer.tsprojects/core/src/page/page-panel/page-panel-header.tsprojects/core/src/page/page-panel/page-panel.tsprojects/core/src/pagination/pagination.tsprojects/core/src/preferences-input/preferences-input.tsprojects/core/src/progressive-filter-chip/progressive-filter-chip.tsprojects/core/src/skeleton/skeleton.tsprojects/core/src/steps/steps.tsprojects/core/src/tabs/tabs.tsprojects/core/src/tag/tag.tsprojects/core/src/toast/toast.tsprojects/core/src/toggletip/toggletip.tsprojects/core/src/toolbar/toolbar.tsprojects/core/src/tooltip/tooltip.tsprojects/core/src/tree/tree-node.tsprojects/forms/src/mixins/button.types.tsprojects/internals/vite/src/plugins/cem.config.mjsprojects/internals/vite/src/plugins/cem.test.js
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.
Update slot descriptions across multiple components for clarity and consistency. Enhanced documentation for slots in Accordion, Avatar, Badge, Card, Chat Message, Copy Button, Dialog, Drawer, Dropdown, Grid, Menu Item, Notification, Toast, and others to specify expected content types and usage.
Summary by CodeRabbit
FormatNumber.useGroupingtyping to support additional documented string values (plus booleans).nve-paginationdocumentation and boundstepSizesto thestep-sizesattribute.