optolith-database-schema 0.5.0 → 0.5.2

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.5.2](https://github.com/elyukai/optolith-database-schema/compare/v0.5.1...v0.5.2) (2022-12-02)
+
+
+### Bug Fixes
+
+* validation error output type did not match type for error printing ([709f2f4](https://github.com/elyukai/optolith-database-schema/commit/709f2f46a68ff438cd158defddf93f508871eef9))
+
+### [0.5.1](https://github.com/elyukai/optolith-database-schema/compare/v0.5.0...v0.5.1) (2022-12-02)
+
+
+### Features
+
+* explicit verbose error-printing option ([ebf055c](https://github.com/elyukai/optolith-database-schema/commit/ebf055c92302c5cfd80493dff1fd38276d05aa30))
+
 ## [0.5.0](https://github.com/elyukai/optolith-database-schema/compare/v0.4.1...v0.5.0) (2022-12-01)
 
 

package/lib/main.d.ts

@@ -1,6 +1,5 @@
-import { DefinedError } from "ajv";
 import { TypeMap } from "./config.js";
-import { TypeValidationError } from "./validation/schema.js";
+import { TypeValidationResultErrors } from "./validation/schema.js";
 declare type Result = {
     tag: "Ok";
     value: {
@@ -8,11 +7,14 @@ declare type Result = {
     };
 } | {
     tag: "Error";
-    errors: Record<string, DefinedError[]>;
+    errors: Record<string, TypeValidationResultErrors>;
 };
 export declare type EntityDirectoryPaths = {
     [K in keyof TypeMap]: string;
 };
 export declare const validate: (entityDirPaths: EntityDirectoryPaths, checkIntegrity: boolean) => Promise<Result>;
-export declare const printErrors: (errorsByFile: Record<string, TypeValidationError[]>) => string;
+export declare const printErrors: (errorsByFile: Record<string, TypeValidationResultErrors>, printOptions?: PrintOptions) => string;
+export declare type PrintOptions = {
+    verbose?: boolean;
+};
 export {};

package/lib/main.js

@@ -87,7 +87,7 @@ const rawResultMapToResult = (rawResultMap) => Object.entries(rawResultMap).redu
             tag: "Error",
             errors: {
                 ...outerResult.errors,
-                [filePath]: [...(outerResult.errors[filePath] ?? []), ...fileResult.errors]
+                [filePath]: fileResult.errors
             }
         };
     }
@@ -108,12 +108,30 @@ export const validate = async (entityDirPaths, checkIntegrity) => {
     ]))));
     return rawResultMapToResult(rawResultMap);
 };
-export const printErrors = (errorsByFile) => Object.entries(errorsByFile)
-    .flatMap(([filePath, errors]) => errors.map(error => {
-    const pathSegments = [filePath, ...error.instancePath.split("/").slice(1)];
-    return [
-        ...pathSegments.map((segment, i) => `${" ".repeat(i * 2)}in "${segment}":`),
-        `${" ".repeat(pathSegments.length * 2)}${error.message ?? ""}`
-    ].join("\n");
-}))
-    .join("\n\n");
+export const printErrors = (errorsByFile, printOptions = {}) => {
+    const { verbose = false } = printOptions;
+    return Object.entries(errorsByFile)
+        .flatMap(([filePath, errors]) => {
+        if (verbose) {
+            return filterNullable([
+                errors.fileNameError ? errorMessageBlock([filePath], errors.fileNameError.message) : undefined,
+                ...errors.schemaErrors.map(error => {
+                    const pathSegments = [filePath, ...error.instancePath.split("/").slice(1)];
+                    return errorMessageBlock(pathSegments, error.message ?? "");
+                })
+            ]);
+        }
+        else {
+            return filterNullable([
+                errors.fileNameError ? errorMessageBlock([filePath], errors.fileNameError.message) : undefined,
+                errors.schemaErrors.length > 0 ? errorMessageBlock([filePath], "does not match schema") : undefined
+            ]);
+        }
+    })
+        .join("\n\n");
+};
+const errorMessageBlock = (path, message) => [
+    ...path.map((segment, i) => `${" ".repeat(i * 2)}in "${segment}":`),
+    `${" ".repeat(path.length * 2)}${message}`
+].join("\n");
+const filterNullable = (arr) => arr.filter((x) => x != null);

package/lib/validation/schema.d.ts

@@ -4,13 +4,16 @@ export declare type FileNameError = {
     instancePath: string;
     message: string;
 };
-export declare type TypeValidationError = DefinedError | FileNameError;
 export declare type TypeValidationResult<T> = {
     tag: "Ok";
     value: T;
 } | {
     tag: "Error";
-    errors: TypeValidationError[];
+    errors: TypeValidationResultErrors;
+};
+export declare type TypeValidationResultErrors = {
+    fileNameError?: FileNameError;
+    schemaErrors: DefinedError[];
 };
 export declare type TypeValidator<T> = (validator: Ajv, data: unknown, filePath: string) => TypeValidationResult<T>;
 export declare type TypeValidatorOptions = {

package/lib/validation/schema.js

@@ -22,11 +22,13 @@ export const validateSchemaCreator = (importMetaUrl, { ignoreFileNamePattern = f
             return { tag: "Ok", value: data };
         }
         else {
-            const errors = [
-                ...(validator.errors ?? []),
-                ...(!correctFileName ? [fileNameError(fileName)] : [])
-            ];
-            return { tag: "Error", errors };
+            return {
+                tag: "Error",
+                errors: {
+                    fileNameError: correctFileName ? undefined : fileNameError(fileName),
+                    schemaErrors: validator.errors ?? [],
+                }
+            };
         }
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "Definitions and utilities for the flat-file database of Optolith, a character creation tool for the Pen and Paper RPG “The Dark Eye 5”, and its external integrations into other software.",
   "keywords": [
     "tde",