Update kompendium #3708
Draft
Update kompendium #3708
Conversation
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
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
adrianschmidt
force-pushed
the
update-kompendium
branch
from
5199126 to
68a62db
Compare
adrianschmidt
force-pushed
the
update-kompendium
branch
2 times, most recently
from
9d7703d to
88e506c
Compare
adrianschmidt
force-pushed
the
update-kompendium
branch
6 times, most recently
from
25cc503 to
71c2d7d
Compare
adrianschmidt
force-pushed
the
update-kompendium
branch
from
71c2d7d to
fe4e7c3
Compare
|
Documentation has been published to https://lundalogik.github.io/lime-elements/versions/PR-3708/ |
After upgrading Kompendium (which upgraded TypeDoc from 0.17 to 0.23), many types were missing from documentation. TypeDoc 0.23 changed how it follows exports and removed the `isExported` flag. Root cause: - Examples import from '@limetech/lime-elements' causing circular imports - Stencil's generated components.d.ts included these circular imports - TypeDoc couldn't parse the entry point when tsconfig excluded dist/ Solution: Two-step build process 1. Build dist with stencil.config.dist.ts (excludes examples via tsconfig.dist.json) 2. Build docs with stencil.config.docs.ts (uses clean dist/types from step 1) Changes: - Update tsconfig.docs.json and tsconfig.dev.json to include dist/types - Update docs:build script to run dist build before docs build - Point stencil.config.docs.ts to dist/types/index.d.ts for consistent type resolution - Remove duplicate exports from interface.ts already in components.d.ts (FormError, ValidationError, ValidationStatus, ListSeparator) - Add explanatory comments to config files documenting the architecture Result: All public API types now documented (ChartItem, Tab, ListItem, FormSchema, PickerValue, CustomColorSwatch, Link, etc.) Dev build (npm start) will have imperfect docs due to circular imports from examples, but production docs (npm run docs:build) are complete.
…json` This file was previously output directly to Stencil's build output directory by Kompendium. However, Stencil automatically cleans that directory, causing a race condition where the `kompendium.json` would sometimes have been removed by the time the publish script tried to copy it. With the latest Kompendium, the `kompendium.json` file is always written to the `.kompendium` folder, so we can safely copy it from there.
adrianschmidt
force-pushed
the
update-kompendium
branch
from
e9f6e2a to
8cb1b90
Compare
adrianschmidt
force-pushed
the
update-kompendium
branch
from
8cb1b90 to
e0a90d4
Compare
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.
🚨 Test-PR for updates in Kompendium.
See jgroth/kompendium#150
@coderabbitai summary
Review:
Browsers tested:
(Check any that applies, it's ok to leave boxes unchecked if testing something didn't seem relevant.)
Windows:
Linux:
macOS:
Mobile: