generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 7
fix: Move validate-props method to component-toolkit package #150
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
41eb432
fix: Move validate-props method to component-toolkit package
teodoranemes 9ab66f4
chore: Added validate-props function
teodoranemes c5f4c4d
chore: Initialize systemName in validate-props
teodoranemes 17fc988
chore: Updated error message
teodoranemes ab1fe3b
fix: Updated paths for validate-props tests
teodoranemes 758b247
fix: Make systemName a required property
teodoranemes fcd24f0
Merge branch 'main' into move-validate-props
teodoranemes 130209f
chore: Added validateProps to internal export list
teodoranemes f142c57
Merge branch 'move-validate-props' of https://github.com/cloudscape-d…
teodoranemes File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
12 changes: 12 additions & 0 deletions
12
src/internal/base-component/__tests__/validate-props-production.test.tsx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| import { validateProps } from '../validate-props'; | ||
| import { isDevelopment } from '../../is-development'; | ||
|
|
||
| jest.mock('../../is-development', () => ({ isDevelopment: false })); | ||
|
|
||
| test('does nothing in production builds', () => { | ||
| expect(isDevelopment).toBe(false); | ||
| expect(() => validateProps('TestComponent', { variant: 'foo' }, ['variant'], {}, 'default')).not.toThrow(); | ||
| }); | ||
26 changes: 26 additions & 0 deletions
26
src/internal/base-component/__tests__/validate-props.test.tsx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| import { validateProps } from '../validate-props'; | ||
|
|
||
| test('should pass validation', () => { | ||
| expect(() => validateProps('TestComponent', {}, [], {}, 'default')).not.toThrow(); | ||
| expect(() => | ||
| validateProps('TestComponent', { variant: 'foo' }, ['bar'], { variant: ['foo'] }, 'default') | ||
| ).not.toThrow(); | ||
| expect(() => | ||
| validateProps('TestComponent', { variant: undefined }, ['bar'], { variant: ['foo'] }, 'default') | ||
| ).not.toThrow(); | ||
| }); | ||
|
|
||
| test('should throw error when excluded prop is used', () => { | ||
| expect(() => validateProps('TestComponent', { variant: 'foo' }, ['variant'], {}, 'default')).toThrow( | ||
| new Error('TestComponent does not support "variant" property when used in default system') | ||
| ); | ||
| }); | ||
|
|
||
| test('should throw error when invalid prop is used', () => { | ||
| expect(() => validateProps('TestComponent', { variant: 'foo' }, [], { variant: ['bar'] }, 'default')).toThrow( | ||
| new Error('TestComponent does not support "variant" with value "foo" when used in default system') | ||
| ); | ||
| }); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| import { isDevelopment } from '../is-development'; | ||
|
|
||
| export function validateProps( | ||
| componentName: string, | ||
| props: Record<string, any>, | ||
| excludedProps: Array<string>, | ||
| allowedEnums: Record<string, Array<string>>, | ||
| systemName: string | ||
| ) { | ||
| if (!isDevelopment) { | ||
| return; | ||
| } | ||
| for (const [prop, value] of Object.entries(props)) { | ||
| if (excludedProps.includes(prop)) { | ||
| throw new Error(`${componentName} does not support "${prop}" property when used in ${systemName} system`); | ||
| } | ||
| if (value && allowedEnums[prop] && !allowedEnums[prop].includes(value)) { | ||
| throw new Error( | ||
| `${componentName} does not support "${prop}" with value "${value}" when used in ${systemName} system` | ||
| ); | ||
| } | ||
| } | ||
| } |
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
Oops, something went wrong.
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.
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.
In the components package, the tests were importing from the lib directory, but the build failed here with that approach.