Merge pull request #352 from enormora/zod

Migrate effect/Schema to zod

Author: lo1tuma

package-lock.json

@@ -41,6 +41,7 @@
     },
     "dependencies": {
         "@effect/schema": "0.60.4",
+        "@schema-hub/zod-error-formatter": "0.0.10",
         "@topcli/spinner": "3.0.0",
         "@ts-morph/common": "0.28.0",
         "cmd-ts": "0.14.2",
@@ -55,7 +56,8 @@
         "true-myth": "8.6.0",
         "ts-morph": "24.0.0",
         "tslib": "2.8.1",
-        "unix-permissions": "6.0.1"
+        "unix-permissions": "6.0.1",
+        "zod": "4.1.11"
     },
     "devDependencies": {
         "@ava/typescript": "6.0.0",

package.json

@@ -1,7 +1,8 @@
 import type _npmFetch from 'npm-registry-fetch';
 import type { publish as _publish } from 'libnpmpublish';
 import { Maybe } from 'true-myth';
-import { struct, string, optional, record, is, type Schema } from '@effect/schema/Schema';
+import { z } from 'zod/mini';
+import { safeParse } from '@schema-hub/zod-error-formatter';
 import type { RegistrySettings } from '../config/registry-settings.js';
 import type { BundlePackageJson } from '../version-manager/manifest/builder.js';
 
@@ -30,21 +31,21 @@ function encodePackageName(name: string): string {
     return name.replace('/', '%2F');
 }
 
-const distTagsSchema = struct({
-    latest: optional(string, { exact: true })
+const distTagsSchema = z.object({
+    latest: z.optional(z.string())
 });
 
-const versionDataSchema = struct({
-    dist: struct({ shasum: string, tarball: string })
+const versionDataSchema = z.object({
+    dist: z.object({ shasum: z.string(), tarball: z.string() })
 });
 
-const abbreviatedPackageResponseSchema = struct({
-    name: string,
+const abbreviatedPackageResponseSchema = z.object({
+    name: z.string(),
     'dist-tags': distTagsSchema,
-    versions: record(string, versionDataSchema)
+    versions: z.record(z.string(), versionDataSchema)
 });
 
-type AbbreviatedPackageResponse = Schema.To<typeof abbreviatedPackageResponseSchema>;
+type AbbreviatedPackageResponse = z.infer<typeof abbreviatedPackageResponseSchema>;
 
 const httpStatusCode = {
     notFound: 404,
@@ -86,10 +87,12 @@ export function createRegistryClient(dependencies: Readonly<RegistryClientDepend
         const endpointUri = `/${encodePackageName(packageName)}`;
         try {
             const response = await fetchRegistryEndpoint(endpointUri, registrySettings);
-            if (!is(abbreviatedPackageResponseSchema)(response)) {
+            const result = safeParse(abbreviatedPackageResponseSchema, response);
+
+            if (!result.success) {
                 throw new Error('Got an invalid response from registry API');
             }
-            return Maybe.just(response);
+            return Maybe.just(result.data);
         } catch (error: unknown) {
             if (
                 isFetchError(error) &&

source/bundle-emitter/registry-client.ts

@@ -13,53 +13,59 @@ test('validation succeeds when valid data is given', checkValidationSuccess, {
 test('validation fails when a non-object is given', checkValidationFailure, {
     schema: additionalFileDescriptionSchema,
     data: true,
-    expectedMessages: ['Expected object; but got boolean']
+    expectedMessages: ['expected object, but got boolean']
 });
 
 test('validation fails when the an empty object is given', checkValidationFailure, {
     schema: additionalFileDescriptionSchema,
     data: {},
-    expectedMessages: ['At sourceFilePath: missing key or index', 'At targetFilePath: missing key or index']
+    expectedMessages: ['at sourceFilePath: missing property', 'at targetFilePath: missing property']
 });
 
 test('validation fails when sourceFilePath is missing', checkValidationFailure, {
     schema: additionalFileDescriptionSchema,
     data: { targetFilePath: 'foo' },
-    expectedMessages: ['At sourceFilePath: missing key or index']
+    expectedMessages: ['at sourceFilePath: missing property']
 });
 
 test('validation fails when sourceFilePath is not a string', checkValidationFailure, {
     schema: additionalFileDescriptionSchema,
     data: { sourceFilePath: [], targetFilePath: 'foo' },
-    expectedMessages: ['At sourceFilePath: expected string; but got array']
+    expectedMessages: [
+        'at sourceFilePath: expected string, but got array',
+        'at sourceFilePath: array must contain at least 1 element'
+    ]
 });
 
 test('validation fails when sourceFilePath is an empty string', checkValidationFailure, {
     schema: additionalFileDescriptionSchema,
     data: { sourceFilePath: '', targetFilePath: 'foo' },
-    expectedMessages: ['At sourceFilePath: expected a non empty string; but got string']
+    expectedMessages: ['at sourceFilePath: string must contain at least 1 character']
 });
 
 test('validation fails when targetFilePath is missing', checkValidationFailure, {
     schema: additionalFileDescriptionSchema,
     data: { sourceFilePath: 'foo' },
-    expectedMessages: ['At targetFilePath: missing key or index']
+    expectedMessages: ['at targetFilePath: missing property']
 });
 
 test('validation fails when targetFilePath is not a string', checkValidationFailure, {
     schema: additionalFileDescriptionSchema,
     data: { targetFilePath: [], sourceFilePath: 'foo' },
-    expectedMessages: ['At targetFilePath: expected string; but got array']
+    expectedMessages: [
+        'at targetFilePath: expected string, but got array',
+        'at targetFilePath: array must contain at least 1 element'
+    ]
 });
 
 test('validation fails when targetFilePath is an empty string', checkValidationFailure, {
     schema: additionalFileDescriptionSchema,
     data: { targetFilePath: '', sourceFilePath: 'foo' },
-    expectedMessages: ['At targetFilePath: expected a non empty string; but got string']
+    expectedMessages: ['at targetFilePath: string must contain at least 1 character']
 });
 
 test('validation fails when an additional unknown property is given', checkValidationFailure, {
     schema: additionalFileDescriptionSchema,
     data: { targetFilePath: 'bar', sourceFilePath: 'foo', something: 'else' },
-    expectedMessages: ['At something: unexpected extra key or index']
+    expectedMessages: ['unexpected additional property: "something"']
 });

source/config/additional-files.test.ts

@@ -1,11 +1,11 @@
-import { type Schema, struct } from '@effect/schema/Schema';
-import { type NoExpand, nonEmptyStringSchema } from './base-validations.js';
+import { z } from 'zod/mini';
+import { nonEmptyStringSchema } from './base-validations.js';
 
-const $additionalFileDescriptionSchema = struct({
-    sourceFilePath: nonEmptyStringSchema,
-    targetFilePath: nonEmptyStringSchema
-});
+export const additionalFileDescriptionSchema = z.readonly(
+    z.strictObject({
+        sourceFilePath: nonEmptyStringSchema,
+        targetFilePath: nonEmptyStringSchema
+    })
+);
 
-export type AdditionalFileDescription = NoExpand<Schema.To<typeof $additionalFileDescriptionSchema>>;
-
-export const additionalFileDescriptionSchema: Schema<AdditionalFileDescription> = $additionalFileDescriptionSchema;
+export type AdditionalFileDescription = z.infer<typeof additionalFileDescriptionSchema>;

source/config/additional-files.ts

@@ -1,5 +1,3 @@
-import { string, nonEmpty } from '@effect/schema/Schema';
+import { z } from 'zod/mini';
 
-export const nonEmptyStringSchema = string.pipe(nonEmpty());
-
-export type NoExpand<T> = T & { readonly _?: never };
+export const nonEmptyStringSchema = z.string().check(z.minLength(1));