zcb 0.2.4 → 0.2.6

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zcb",
   "description": "Build configs with type safety from zod schema.",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "author": "Dylan Aubrey",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/zod-config-builder",
@@ -45,47 +45,37 @@
     "zod-to-json-schema": "^3.21.0"
   },
   "peerDependencies": {
-    "@babel/runtime": "<8",
     "core-js": "<4",
     "lodash-es": "<5",
     "ts-node": "<11"
   },
   "devDependencies": {
-    "@babel/cli": "^7.21.5",
-    "@babel/core": "^7.21.8",
-    "@babel/eslint-parser": "^7.21.8",
-    "@babel/plugin-proposal-decorators": "^7.23.3",
-    "@babel/plugin-syntax-import-assertions": "^7.20.0",
-    "@babel/plugin-transform-class-properties": "^7.23.3",
-    "@babel/plugin-transform-export-namespace-from": "^7.23.4",
-    "@babel/plugin-transform-modules-commonjs": "^7.23.3",
-    "@babel/plugin-transform-runtime": "^7.21.4",
-    "@babel/preset-env": "^7.21.5",
-    "@babel/preset-react": "^7.18.6",
-    "@babel/preset-typescript": "^7.21.5",
-    "@babel/runtime": "^7.21.5",
     "@commitlint/cli": "^17.6.3",
     "@commitlint/config-conventional": "^17.6.3",
     "@commitlint/prompt-cli": "^17.6.3",
-    "@jest/globals": "^29.5.0",
-    "@repodog/babel-config": "^1.1.11",
-    "@repodog/cli": "^1.4.1",
-    "@repodog/commitlint-config": "^1.1.6",
-    "@repodog/eslint-config": "^1.1.19",
-    "@repodog/eslint-config-jest": "^1.1.10",
-    "@repodog/jest-config": "^1.1.11",
-    "@repodog/markdownlint-config": "^1.1.5",
-    "@repodog/prettier-config": "^1.1.5",
-    "@repodog/rollup-config": "^1.1.8",
-    "@repodog/syncpack-config": "^1.2.3",
-    "@repodog/ts-config": "^1.3.0",
+    "@jest/globals": "^29.7.0",
+    "@repodog/babel-config": "^1.2.1",
+    "@repodog/cli": "^1.6.24",
+    "@repodog/commitlint-config": "^1.2.2",
+    "@repodog/eslint-config": "^1.2.2",
+    "@repodog/eslint-config-jest": "^1.2.1",
+    "@repodog/jest-config": "^1.2.3",
+    "@repodog/markdownlint-config": "^1.2.1",
+    "@repodog/prettier-config": "^1.2.1",
+    "@repodog/rollup-config": "^1.2.2",
+    "@repodog/swc-config": "^0.2.5",
+    "@repodog/syncpack-config": "^1.3.1",
+    "@repodog/ts-config": "^1.4.1",
     "@rollup/plugin-babel": "^6.0.3",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-image": "^3.0.2",
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.0.2",
+    "@rollup/plugin-swc": "^0.3.0",
     "@rollup/plugin-terser": "^0.4.1",
-    "@types/jest": "^25.2.3",
+    "@swc/core": "^1.4.1",
+    "@swc/jest": "^0.2.36",
+    "@types/jest": "^29.5.12",
     "@types/lodash-es": "^4.17.9",
     "@types/node": "^20.11.0",
     "@typescript-eslint/eslint-plugin": "^5.59.5",
@@ -111,17 +101,17 @@
     "generate-changelog": "^1.8.0",
     "husky": "^8.0.3",
     "identity-obj-proxy": "^3.0.0",
-    "jest": "^29.5.0",
+    "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-environment-node": "^29.7.0",
     "lodash-es": "^4.17.21",
-    "markdownlint-cli": "^0.34.0",
+    "markdownlint-cli2": "^0.12.1",
     "prettier": "^2.8.8",
     "rollup": "^3.21.6",
     "rollup-plugin-analyzer": "^4.0.0",
     "rollup-plugin-copy": "^3.4.0",
     "rollup-plugin-sourcemaps": "^0.6.3",
-    "suppress-experimental-warnings": "^1.1.17",
+    "suppress-experimental-warnings": "^2.0.0",
     "syncpack": "^12.3.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
@@ -145,7 +135,7 @@
     "lint": "eslint . --ext .ts,.cjs",
     "repodog": "repodog",
     "syncpack": "syncpack format && syncpack list-mismatches && syncpack lint-semver-ranges",
-    "test": "node --require=suppress-experimental-warnings --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test": "COMPILER=swc node --require=suppress-experimental-warnings --experimental-vm-modules node_modules/jest/bin/jest.js",
     "type-check": "tsc --noEmit",
     "validate": "pnpm run syncpack && pnpm run build && pnpm run lint && pnpm run type-check && pnpm run test",
     "zcb:build": "NODE_OPTIONS=\"--loader ts-node/esm\" node ./bin/zcb.mjs build ./src/__testUtils__/configBuilder.ts ./src/__testUtils__/builtConfig.ts",

package/src/__testUtils__/builtConfig.ts

@@ -68,6 +68,7 @@ export default {
       path: "contact-details"
     }
   ],
+  templateString: 'Simple {{name}} met a {{profession}} going to the fair',
   timeouts: {
     apollo: 10000
   },

package/src/createConfigParser.ts

@@ -1,5 +1,5 @@
 import { runExperiments } from './transformers/runExperiments.ts';
-import type { ConfigParserOptions, TransformConfigHandler } from './types.ts';
+import { type ConfigParserOptions, type TransformConfigHandler } from './types.ts';
 import { transformConfig } from './utils/transformConfig.ts';
 
 export const createConfigParser = async <Config extends object>(

package/src/createConfigReader.test.ts

@@ -17,6 +17,34 @@ describe('createConfigReader', () => {
     });
   });
 
+  describe('when vars options are passed in', () => {
+    const vars = {
+      name: 'Simon',
+      profession: 'pieman',
+    };
+
+    describe('when a user accesses a property that is not a string', () => {
+      it('should throw the correct error', () => {
+        const reader = createReader();
+
+        // @ts-expect-error path does not resovle to a string
+        expect(() => reader.read('pages.contactDetails', { vars })).toThrow(
+          new Error(
+            'config reader received variables to use in string template, but the path did not resolve to a string.'
+          )
+        );
+      });
+    });
+
+    describe('when a user accesses a property that is a string', () => {
+      it('should return the correct string value with template placeholders populated', () => {
+        const reader = createReader();
+        const value = reader.read('templateString', { vars });
+        expect(value).toBe('Simple Simon met a pieman going to the fair');
+      });
+    });
+  });
+
   describe('when the reader is scoped', () => {
     describe('when a user accesses a known property', () => {
       it('should return the correct value', () => {

package/src/createConfigReader.ts

@@ -1,15 +1,35 @@
-import { get } from 'lodash-es';
-import type { Get } from 'type-fest';
-import type { Path, Scope } from './types.ts';
+import { get, isString } from 'lodash-es';
+import { type Get } from 'type-fest';
+import { type Path, type Scope } from './types.ts';
+
+export type ReadOptions = {
+  vars?: Record<string, string | number>;
+};
 
 export interface ConfigReader<Config extends object> {
-  read: <P extends Path<Config>>(path: P) => Get<Config, P>;
+  read: <P extends Path<Config>>(path: P, options?: ReadOptions) => Get<Config, P>;
   scope: <S extends Scope<Config>>(scope: S) => ConfigReader<Get<Config, S>>;
 }
 
 export const createConfigReader = <Config extends object>(config: Config): ConfigReader<Config> => {
   const configReader = {
-    read: <P extends Path<Config>>(path: P) => get(config, path),
+    read: <P extends Path<Config>>(path: P, { vars }: ReadOptions = {}) => {
+      if (!vars) {
+        return get(config, path);
+      }
+
+      const output = get(config, path);
+
+      if (!isString(output)) {
+        throw new Error(
+          'config reader received variables to use in string template, but the path did not resolve to a string.'
+        );
+      }
+
+      return Object.keys(vars).reduce<string>((acc, key) => {
+        return acc.replace(new RegExp(`{{${key}}}`), String(vars[key]));
+      }, output);
+    },
     scope: <S extends Scope<Config>>(scope: S) => createConfigReader(get(config, scope) as Get<Config, S>),
   } as ConfigReader<Config>;
 

package/src/types.ts

@@ -1,5 +1,5 @@
-import type { List } from 'ts-toolbelt';
-import type { Includes, Join } from 'type-fest';
+import { type List } from 'ts-toolbelt';
+import { type Includes, type Join } from 'type-fest';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type AnyRecord = Record<string, any>;

package/src/utils/arrayHasInvalidDefaults.ts

@@ -1,4 +1,4 @@
-import type { JSONSchema7 } from 'json-schema';
+import { type JSONSchema7 } from 'json-schema';
 
 export const arrayHasInvalidDefaults = (propertyDefinition: JSONSchema7) => {
   const { items } = propertyDefinition;

package/src/utils/collateObjectPropertyDefaults.ts

@@ -1,6 +1,6 @@
-import type { JSONSchema7 } from 'json-schema';
+import { type JSONSchema7 } from 'json-schema';
 import { isBoolean, isUndefined } from 'lodash-es';
-import type { Jsonifiable } from 'type-fest';
+import { type Jsonifiable } from 'type-fest';
 import { objectPropertyHasDefaults } from './objectPropertyHasDefaults.ts';
 
 export const collateObjectPropertyDefaults = (propertyDefinition: JSONSchema7) => {

package/src/utils/importValidateTransformWriteConfig.ts

@@ -1,8 +1,8 @@
 import { resolve } from 'node:path';
 import shelljs from 'shelljs';
-import type { Commands } from '../cli.ts';
-import type { ConfigBuilder } from '../createConfigBuilder.ts';
-import type { SetupExperimentsCallback } from '../types.ts';
+import { type Commands } from '../cli.ts';
+import { type ConfigBuilder } from '../createConfigBuilder.ts';
+import { type SetupExperimentsCallback } from '../types.ts';
 import { transformWriteConfig } from './transformWriteConfig.ts';
 
 export const importValidateTransformWriteConfig = (

package/src/utils/isSchemaValid.ts

@@ -1,3 +1,3 @@
-import type { JSONSchema7 } from 'json-schema';
+import { type JSONSchema7 } from 'json-schema';
 
 export const isSchemaValid = (schema: JSONSchema7) => schema.type !== 'object';

package/src/utils/isValidPropertyDefinition.ts

@@ -1,4 +1,4 @@
-import type { JSONSchema7, JSONSchema7Definition } from 'json-schema';
+import { type JSONSchema7, type JSONSchema7Definition } from 'json-schema';
 
 export const isValidPropertyDefinition = (
   propertyDefinition: JSONSchema7Definition | undefined

package/src/utils/jsonStringifyReplacer.ts

@@ -1,4 +1,4 @@
-import type { Jsonifiable } from 'type-fest';
+import { type Jsonifiable } from 'type-fest';
 import { ZodType } from 'zod';
 import { zodToJsonSchema } from 'zod-to-json-schema';
 

package/src/utils/objectPropertyHasDefaults.ts

@@ -1,4 +1,4 @@
-import type { JSONSchema7 } from 'json-schema';
+import { type JSONSchema7 } from 'json-schema';
 
 export const objectPropertyHasDefaults = (propertyDefinition: JSONSchema7) =>
   propertyDefinition.properties &&

package/src/utils/recordHasInvalidDefaults.ts

@@ -1,4 +1,4 @@
-import type { JSONSchema7 } from 'json-schema';
+import { type JSONSchema7 } from 'json-schema';
 
 export const recordHasInvalidDefaults = (propertyDefinition: JSONSchema7) =>
   propertyDefinition.additionalProperties &&

package/src/utils/transformWriteConfig.ts

@@ -6,7 +6,7 @@ import { fileURLToPath } from 'node:url';
 import shelljs from 'shelljs';
 import { removeDisabledSlices } from '../transformers/removeDisabledSlices.ts';
 import { setupExperiments } from '../transformers/setupExperiments.ts';
-import type { TransformConfigHandler, WriteConfigOptions } from '../types.ts';
+import { type TransformConfigHandler, type WriteConfigOptions } from '../types.ts';
 import { transformConfig } from './transformConfig.ts';
 
 export const transformWriteConfig = async <Config extends object>(