chore: Migrate to the new documenter API #82
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
taheramr
commented
May 22, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #82 +/- ##
=======================================
Coverage 99.28% 99.28%
=======================================
Files 29 29
Lines 280 280
Branches 34 34
=======================================
Hits 278 278
Misses 1 1
Partials 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
taheramr
commented
May 22, 2025
| @@ -2,9 +2,16 @@ | |||
| // SPDX-License-Identifier: Apache-2.0 | |||
| import { expect, test } from "vitest"; | |||
|
|
|||
| // @ts-expect-error no types here | |||
| import apiDocs from "../../lib/components/internal/api-docs/components"; | |||
| import componentDefinitions from "../../lib/components/internal/api-docs/components"; | |||
There was a problem hiding this comment.
decided to follow how we define the documenter tests everywhere by using the getAllComponents util
taheramr
force-pushed
the
migrate-documenter
branch
from
135f176 to
9c7f0c3
Compare
just-boris
reviewed
May 22, 2025
Comment on lines
+10
to
+14
| // overriding with a fake value so that when there are icon changes in components this test doesn't block it | ||
| const iconNameDefinition = definition.properties.find(({ name }: { name: string }) => name === "iconName"); | ||
| if (iconNameDefinition && iconNameDefinition.inlineType?.type === "union") { | ||
| iconNameDefinition.inlineType.values = ["comes from @cloudscape-design/components"]; | ||
| } |
There was a problem hiding this comment.
This is not needed in this package
We can add it later, if we really start using icons in snapshots
just-boris
reviewed
May 22, 2025
Comment on lines
+1
to
+4
| /* eslint-env node */ | ||
| /* eslint-disable header/header */ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 |
There was a problem hiding this comment.
If you put comments in this order, they pass the linter without disabling
Suggested change
| /* eslint-env node */ | |
| /* eslint-disable header/header */ | |
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | |
| // SPDX-License-Identifier: Apache-2.0 | |
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | |
| // SPDX-License-Identifier: Apache-2.0 | |
| /* eslint-env node */ |
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.
Description
Same as cloudscape-design/components#3475 and cloudscape-design/chat-components#72 but for this package
Related links, issue #, if available: n/a
How has this been tested?
Review checklist
The following items are to be evaluated by the author(s) and the reviewer(s).
Correctness
CONTRIBUTING.md.CONTRIBUTING.md.Testing
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.