-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: items of layout schema (#29)
* refactor: items of layout schema Utilizing the if-then-else for items provides more meaningful error messages when validating JSON. Previously, if one property was missing, you would see that error for all layout item types. * fix: remove underscore from UUIDs * fix: restrict allowed characters of layout item keys --------- Co-authored-by: Richard Herman <[email protected]>
- Loading branch information
Showing
7 changed files
with
997 additions
and
761 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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,156 @@ | ||
| import type { JSONSchema7 } from "json-schema"; | ||
| import { Schema } from "ts-json-schema-generator"; | ||
|
|
||
| /** | ||
| * Applies the custom keywords, aggregating the schema to form a valid structure. | ||
| * @param schema Schema to apply the custom keywords to. | ||
| */ | ||
| export function customKeywordTransformer(schema: JSONSchema7): void { | ||
| visitNode(schema, (node, keyword, value) => { | ||
| switch (keyword) { | ||
| case "description": | ||
| node.markdownDescription = value?.toString(); | ||
| break; | ||
|
|
||
| case "filePath": | ||
| validateFilePathOptions(value); | ||
| node.pattern = generatePathPattern(value); | ||
| node.errorMessage = generatePathErrorMessage(value); | ||
|
|
||
| break; | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Validates the specified {@link options} are an instance of {@link FilePathOptions}. | ||
| * @param options Options to validate. | ||
| */ | ||
| function validateFilePathOptions(options: unknown): asserts options is FilePathOptions { | ||
| if (options === null) { | ||
| throw new TypeError(`"filePath" options must not be null`); | ||
| } | ||
|
|
||
| if (typeof options === "boolean") { | ||
| if (options === false) { | ||
| throw new TypeError(`"false" is not a valid value for "filePath", expected: "true"`); | ||
| } | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| if (typeof options !== "object" || !("extensions" in options) || !("includeExtension" in options)) { | ||
| throw new TypeError(`${JSON.stringify(options)} is not a complete set of "filePath" options, expected: { "extensions": string[], "includeExtension": boolean }`); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Generates the regular expression pattern of a property based file path's {@link options}. | ||
| * - {@link https://regexr.com/7qpi6 File path, with unknown extension} | ||
| * - {@link https://regexr.com/7qpj7 File path, with extension} | ||
| * - {@link https://regexr.com/7qp5k File path, without extension} | ||
| * @param options Options used to determine how the pattern should be generated. | ||
| * @returns Regular expression pattern. | ||
| */ | ||
| function generatePathPattern(options: FilePathOptions): string { | ||
| let pattern = "^(?![~\\.]*[\\\\\\/]+)"; // ensure the value doesn't start with a slash, or period followed by a slash. | ||
|
|
||
| // When the file path's extension is unknown, we simply ensure the start of the string. | ||
| if (typeof options === "boolean") { | ||
| return (pattern += ".*$"); | ||
| } | ||
|
|
||
| // Otherwise, construct the pattern based on the valid extensions. | ||
| const exts = options.extensions | ||
| .map((extension) => { | ||
| const chars = Array.from(extension) | ||
| .slice(1) | ||
| .map((c) => `[${c.toUpperCase()}${c.toLowerCase()}]`) | ||
| .join(""); | ||
|
|
||
| return `(${chars})`; | ||
| }) | ||
| .join("|"); | ||
|
|
||
| if (options.includeExtension) { | ||
| // Ensure the value ends with a valid extension | ||
| pattern += `.*\\.(${exts})$`; | ||
| } else { | ||
| // Use a negative look-ahead to ensure the extension isn't specified. | ||
| pattern += `(?!.*\\.(${exts})$).*$`; | ||
| } | ||
|
|
||
| return pattern; | ||
| } | ||
|
|
||
| /** | ||
| * Generates the custom error message associated with a file path. | ||
| * @param options Options that define the valid file path. | ||
| * @returns Custom error message. | ||
| */ | ||
| function generatePathErrorMessage(options: FilePathOptions): string { | ||
| if (typeof options === "boolean") { | ||
| return "String must reference file in the plugin directory."; | ||
| } | ||
|
|
||
| const exts = options.extensions.reduce((prev, current, index) => { | ||
| return index === 0 ? current : index === options.extensions.length - 1 ? prev + `, or ${current}` : prev + `, ${current}`; | ||
| }, ""); | ||
|
|
||
| const errorMessage = `String must reference ${exts} file in the plugin directory`; | ||
| return options.includeExtension ? `${errorMessage}.` : `${errorMessage}, with the file extension omitted.`; | ||
| } | ||
|
|
||
| /** | ||
| * Traverses the specified {@link schema} and applies the visitor to each property. | ||
| * @param schema Schema to traverse | ||
| * @param visitor Visitor to each of the schema's properties. | ||
| */ | ||
| function visitNode(schema: ExtendedSchema, visitor: (schema: ExtendedSchema, keyword: keyof ExtendedSchema, value: unknown) => void): void { | ||
| if (typeof schema === "object") { | ||
| for (const [keyword, value] of Object.entries(schema)) { | ||
| if (typeof value === "object") { | ||
| visitNode(value, visitor); | ||
| } | ||
|
|
||
| visitor(schema, keyword as keyof ExtendedSchema, value); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Provides an extended JSON schema that includes the `markdownDescription` property. | ||
| */ | ||
| type ExtendedSchema = Schema & { | ||
| /** | ||
| * Custom error message shown when the value does not confirm to the defined schemas. | ||
| */ | ||
| errorMessage?: string; | ||
|
|
||
| /** | ||
| * Determines whether the value must represent a file path. | ||
| */ | ||
| filePath?: FilePathOptions; | ||
|
|
||
| /** | ||
| * Markdown representation of the description. | ||
| */ | ||
| markdownDescription?: string; | ||
| }; | ||
|
|
||
| /** | ||
| * Options used to determine a valid file path, used to generate the regular expression pattern. | ||
| */ | ||
| type FilePathOptions = | ||
| | true | ||
| | { | ||
| /** | ||
| * Collection of valid file extensions. | ||
| */ | ||
| extensions: string[]; | ||
|
|
||
| /** | ||
| * Determines whether the extension must be present, or omitted, from the file path. | ||
| */ | ||
| includeExtension: boolean; | ||
| }; |
Oops, something went wrong.