Skip to content

Commit 419dec7

Browse files
committed
chore(internal): make zod validation message more readably
This uses `zod-validation-error` library to return a more readably validation message.
1 parent d8a41a1 commit 419dec7

File tree

3 files changed

+19
-4
lines changed

3 files changed

+19
-4
lines changed

Diff for: packages/common-all/package.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@
5252
"spark-md5": "^3.0.2",
5353
"title": "^3.4.4",
5454
"vscode-uri": "^3.0.3",
55-
"zod": "3.19.1"
55+
"zod": "3.19.1",
56+
"zod-validation-error": "^0.2.1"
5657
},
5758
"devDependencies": {
5859
"@types/fast-levenshtein": "^0.0.2",
@@ -62,8 +63,8 @@
6263
"@types/luxon": "^1.25.0",
6364
"@types/minimatch": "^3.0.5",
6465
"@types/nanoid-dictionary": "^4.2.0",
65-
"@types/normalize-path": "^3.0.0",
6666
"@types/node": "13.11.0",
67+
"@types/normalize-path": "^3.0.0",
6768
"@types/semver": "^7.3.4",
6869
"@types/title": "^3.4.1",
6970
"@types/unist": "^2.0.3",

Diff for: packages/common-all/src/parse.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { z } from "zod";
2+
import { fromZodError } from "zod-validation-error";
23
import type { ZodType } from "zod";
34
import { ok, err } from "./utils";
45
import type { Result } from "neverthrow";
@@ -36,8 +37,7 @@ export const parse = <T extends z.ZodTypeAny>(
3637
return err(
3738
new DendronError({
3839
message: [
39-
...(msg ? [msg] : []),
40-
JSON.stringify(parsed.error.issues, null, 2),
40+
fromZodError(parsed.error, { prefix: msg }).message,
4141
...(schema.description ? [`Schema:${schema.description}`] : []),
4242
].join("\n"),
4343
})

Diff for: yarn.lock

+14
Original file line numberDiff line numberDiff line change
@@ -3823,6 +3823,13 @@
38233823
dependencies:
38243824
tslib "^2.4.0"
38253825

3826+
"@swc/helpers@^0.4.11":
3827+
version "0.4.12"
3828+
resolved "https://registry.npmjs.org/@swc/helpers/-/helpers-0.4.12.tgz#203243e78cff3c87c081c97ae548ab33e2503573"
3829+
integrity sha512-R6RmwS9Dld5lNvwKlPn62+piU+WDG1sMfsnfJioXCciyko/gZ0DQ4Mqglhq1iGU1nQ/RcGkAwfMH+elMSkJH3Q==
3830+
dependencies:
3831+
tslib "^2.4.0"
3832+
38263833
"@szmarczak/http-timer@^1.1.2":
38273834
version "1.1.2"
38283835
resolved "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-1.1.2.tgz#b1665e2c461a2cd92f4c1bbf50d5454de0d4b421"
@@ -27247,6 +27254,13 @@ zen-observable@^0.8.0:
2724727254
resolved "https://registry.npmjs.org/zen-observable/-/zen-observable-0.8.15.tgz#96415c512d8e3ffd920afd3889604e30b9eaac15"
2724827255
integrity sha512-PQ2PC7R9rslx84ndNBZB/Dkv8V8fZEpk83RLgXtYd0fwUgEjseMn1Dgajh2x6S8QbZAFa9p2qVCEuYZNgve0dQ==
2724927256

27257+
zod-validation-error@^0.2.1:
27258+
version "0.2.1"
27259+
resolved "https://registry.npmjs.org/zod-validation-error/-/zod-validation-error-0.2.1.tgz#d855c8bba835f43692756670d407453424a7ba5b"
27260+
integrity sha512-zGg6P5EHi5V0dvyEeC8HBZd2pzp7QDKTngkSWgWunljrY+0SHkHyjI519D+u8/37BHkGHAFseWgnZ2Uq8LNFKg==
27261+
dependencies:
27262+
"@swc/helpers" "^0.4.11"
27263+
2725027264
2725127265
version "3.19.1"
2725227266
resolved "https://registry.npmjs.org/zod/-/zod-3.19.1.tgz#112f074a97b50bfc4772d4ad1576814bd8ac4473"

0 commit comments

Comments
 (0)