-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: show internal schema errors in a nicer way (#227)
- Loading branch information
Showing
8 changed files
with
105 additions
and
92 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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,43 @@ | ||
| import { isReferenceNode, isRegularNode, ReferenceNode, SchemaNode, SchemaNodeKind } from '@stoplight/json-schema-tree'; | ||
| import { Box, Icon, Tooltip } from '@stoplight/mosaic'; | ||
| import * as React from 'react'; | ||
|
|
||
| import { isFlattenableNode } from '../../tree'; | ||
| import { getInternalSchemaError } from '../../utils/getInternalSchemaError'; | ||
|
|
||
| function useRefNode(schemaNode: SchemaNode) { | ||
| return React.useMemo<ReferenceNode | null>(() => { | ||
| if (isReferenceNode(schemaNode)) { | ||
| return schemaNode; | ||
| } | ||
|
|
||
| if ( | ||
| isRegularNode(schemaNode) && | ||
| (isFlattenableNode(schemaNode) || | ||
| (schemaNode.primaryType === SchemaNodeKind.Array && schemaNode.children?.length === 1)) | ||
| ) { | ||
| return (schemaNode.children?.find(isReferenceNode) as ReferenceNode | undefined) ?? null; | ||
| } | ||
|
|
||
| return null; | ||
| }, [schemaNode]); | ||
| } | ||
|
|
||
| export const Error: React.FC<{ schemaNode: SchemaNode }> = ({ schemaNode }) => { | ||
| const refNode = useRefNode(schemaNode); | ||
| const error = getInternalSchemaError(schemaNode) ?? refNode?.error; | ||
|
|
||
| if (typeof error !== 'string') return null; | ||
|
|
||
| return ( | ||
| <Tooltip | ||
| renderTrigger={ | ||
| <Box as="span" display="inline-block" ml={1.5}> | ||
| <Icon aria-label={error} color="var(--color-danger)" icon={['fas', 'exclamation-triangle']} size="1x" /> | ||
| </Box> | ||
| } | ||
| > | ||
| {error} | ||
| </Tooltip> | ||
| ); | ||
| }; |
This file contains 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
This file contains 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,29 @@ | ||
| import { isPlainObject } from '@stoplight/json'; | ||
| import type { SchemaNode } from '@stoplight/json-schema-tree'; | ||
|
|
||
| export function getInternalSchemaError(schemaNode: SchemaNode): string | undefined { | ||
| let errorMessage; | ||
| const fragment: unknown = schemaNode.fragment; | ||
| if (!isPlainObject(fragment)) return; | ||
|
|
||
| const xStoplight = fragment['x-stoplight']; | ||
|
|
||
| if (isPlainObject(xStoplight) && typeof xStoplight['error-message'] === 'string') { | ||
| errorMessage = xStoplight['error-message']; | ||
| } else { | ||
| const fragmentErrorMessage = fragment['x-sl-error-message']; | ||
| if (typeof fragmentErrorMessage === 'string') { | ||
| errorMessage = fragmentErrorMessage; | ||
| } else { | ||
| const items: unknown = fragment['items']; | ||
| if (typeof items === 'object' && items !== null) { | ||
| const itemsErrorMessage = items['x-sl-error-message']; | ||
| if (typeof itemsErrorMessage === 'string') { | ||
| errorMessage = itemsErrorMessage; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return errorMessage; | ||
| } |