docs(ecc-utils-design): fix missing exports in custom elements manifests#436
Conversation
Adds the `@element` JSDoc tag to components in the `ecc-utils-design` package. This ensures that the custom elements analyzer can correctly map the classes to their respective HTML tags in the generated `custom-elements.json` manifest, fixing missing exports and improving IDE IntelliSense. Fixes elixir-cloud-aai#417
|
@revaarathore11 is attempting to deploy a commit to the elixir-cloud-aai Team on Vercel. A member of the Team first needs to authorize it. |
Reviewer's GuideAdds or corrects JSDoc metadata so all ecc-utils-design web components are properly declared as custom elements (with kebab-case tag names) in the Custom Elements Manifest, plus a minor doc fix for the skeleton component. Flow diagram for CEM analyzer using @element tags to restore exports and toolingflowchart LR
subgraph Source_Code
A_ts_files[TypeScript_components]
A_jsdoc[JSDoc_annotations_with_element_tags]
end
subgraph Tooling
B_cem_analyzer[Custom_Elements_Manifest_analyzer]
C_manifest[custom_elements_json]
end
subgraph Consumers
D_ide[IDE_Typescript_IntelliSense]
E_react_generator[React_wrapper_generator]
F_apps[Consumer_apps_and_docs]
end
A_ts_files --> A_jsdoc
A_jsdoc --> B_cem_analyzer
B_cem_analyzer --> C_manifest
C_manifest --> D_ide
C_manifest --> E_react_generator
D_ide --> F_apps
E_react_generator --> F_apps
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- In
card.tsandtabs.tseach component’s JSDoc now contains the same@elementtag twice; please remove the duplicated annotations so each component has a single@elemententry.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `card.ts` and `tabs.ts` each component’s JSDoc now contains the same `@element` tag twice; please remove the duplicated annotations so each component has a single `@element` entry.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Summary
Adds missing
@elementJSDoc annotations to all components in theecc-utils-designpackage so the Custom Elements Manifest analyzer can correctly map classes to their HTML tags.This fixes missing exports in
custom-elements.json, restores IDE IntelliSense, and ensures React wrapper generation works correctly by enforcing kebab-case tag names.Details
@element ecc-utils-design-*JSDoc tags to all 12 componentsdist/custom-elements.jsonecc-docs(Next.js)Fixes #417
Summary by Sourcery
Annotate ecc-utils-design web components with element metadata for accurate custom elements manifest generation and improved tooling support.
Enhancements:
Documentation: