zcb 0.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 dylanaubrey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,8 @@
+# zod-config-builder
+
+Build configs with type safety from zod schema.
+
+[![npm version](https://badge.fury.io/js/%40zod-config-builder.svg)](https://badge.fury.io/js/%40zod-config-builder)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+**WORK IN PROGRESS**

package/bin/zcb.mjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+const { cli } = await import('../dist/main/cli.mjs'); // eslint-disable-line import/no-unresolved
+cli();

package/package.json

@@ -0,0 +1,129 @@
+{
+  "name": "zcb",
+  "description": "Build configs with type safety from zod schema.",
+  "version": "0.0.6",
+  "author": "Dylan Aubrey",
+  "license": "MIT",
+  "homepage": "https://github.com/badbatch/zod-config-builder",
+  "repository": "badbatch/zod-config-builder",
+  "bugs": "https://github.com/badbatch/zod-config-builder/issues",
+  "type": "module",
+  "bin": {
+    "zcb": "./bin/zcb.mjs"
+  },
+  "main": "./dist/main/index.mjs",
+  "types": "./dist/types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "fs-extra": "^11.1.1",
+    "handlebars": "^4.7.7",
+    "json-schema": "^0.4.0",
+    "shelljs": "^0.8.4",
+    "ts-node": "^10.9.1",
+    "yargs": "^15.1.0",
+    "zod": "^3.21.4",
+    "zod-to-json-schema": "^3.21.0"
+  },
+  "peerDependencies": {
+    "@babel/runtime": "<8",
+    "core-js": "<4",
+    "lodash": "<5"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.21.5",
+    "@babel/core": "^7.21.8",
+    "@babel/eslint-parser": "^7.21.8",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-export-namespace-from": "^7.18.9",
+    "@babel/plugin-syntax-dynamic-import": "^7.8.3",
+    "@babel/plugin-syntax-import-assertions": "^7.20.0",
+    "@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.0.0",
+    "@repodog/cli": "^1.1.1",
+    "@repodog/commitlint-config": "^1.0.0",
+    "@repodog/eslint-config": "^1.0.0",
+    "@repodog/jest-config": "^1.0.0",
+    "@repodog/markdownlint-config": "^1.0.0",
+    "@repodog/prettier-config": "^1.0.0",
+    "@repodog/rollup-config": "^1.0.0",
+    "@repodog/syncpack-config": "1.0.0",
+    "@repodog/ts-config": "^1.0.0",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@rollup/plugin-image": "^3.0.2",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@rollup/plugin-terser": "^0.4.1",
+    "@types/fs-extra": "^11.0.1",
+    "@types/jest": "^29.5.1",
+    "@types/json-schema": "^7.0.11",
+    "@types/lodash": "^4.14.191",
+    "@types/node": "^18.11.18",
+    "@types/shelljs": "^0.8.11",
+    "@types/yargs": "^15.0.4",
+    "@typescript-eslint/eslint-plugin": "^5.59.5",
+    "@typescript-eslint/parser": "^5.59.5",
+    "babel-jest": "^29.5.0",
+    "babel-plugin-codegen": "^4.1.5",
+    "babel-plugin-macros": "^3.1.0",
+    "core-js": "^3.27.2",
+    "del-cli": "^3.0.0",
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-sort-class-members": "^1.18.0",
+    "eslint-plugin-sort-destructure-keys": "^1.5.0",
+    "eslint-plugin-sort-keys-fix": "^1.1.2",
+    "eslint-plugin-typescript-sort-keys": "^2.3.0",
+    "eslint-plugin-unicorn": "^47.0.0",
+    "generate-changelog": "^1.8.0",
+    "husky": "^8.0.3",
+    "identity-obj-proxy": "^3.0.0",
+    "jest": "^29.5.0",
+    "lodash": "^4.17.21",
+    "markdownlint-cli": "^0.34.0",
+    "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",
+    "syncpack": "^9.8.6",
+    "ts-toolbelt": "^9.6.0",
+    "type-fest": "^3.10.0",
+    "typescript": "^5.0.3"
+  },
+  "scripts": {
+    "build": "pnpm run clean:dist && pnpm run compile",
+    "clean:deps": "del-cli ./node_modules",
+    "clean:dist": "del-cli ./dist",
+    "commit": "commit",
+    "compile": "pnpm run /^compile:.*/",
+    "compile:main": "rollup -c ./rollup.config.cjs",
+    "compile:types": "tsc --project ./tsconfig.json",
+    "cut:changelog": "changelog",
+    "cut:post-version": "pnpm run build",
+    "lint": "eslint . --ext .ts,.cjs",
+    "repodog": "repodog",
+    "syncpack": "syncpack",
+    "test": "node --require=suppress-experimental-warnings --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "type-check": "tsc --noEmit",
+    "validate": "syncpack format && syncpack lint-semver-ranges && pnpm run build && pnpm run lint && pnpm run type-check && pnpm run test",
+    "zcb:watch": "NODE_OPTIONS=\"--loader ts-node/esm\" node ./bin/zcb.mjs watch ./src/__testUtils__/configBuilder.ts ./src/__testUtils__/builtConfig.ts"
+  }
+}

package/src/__testUtils__/builtConfig.ts

@@ -0,0 +1,74 @@
+/* eslint-disable prettier/prettier, import/no-default-export, unicorn/numeric-separators-style */
+
+export default {
+  countryCode: "GB",
+  countryName: "United Kingdom",
+  distanceUnit: "km",
+  languageCodes: [
+    "en"
+  ],
+  locales: [
+    "en_GB"
+  ],
+  name: "alpha",
+  pages: {
+    contactDetails: {
+      name: "contactDetails",
+      sections: [
+        {
+          name: "header"
+        },
+        {
+          name: "body",
+          sections: [
+            {
+              name: "main"
+            },
+            {
+              name: "sidebar"
+            }
+          ]
+        },
+        {
+          name: "footer"
+        }
+      ]
+    },
+    personalDetails: {
+      name: "personalDetails",
+      sections: [
+        {
+          name: "header"
+        },
+        {
+          name: "body",
+          sections: [
+            {
+              name: "main"
+            },
+            {
+              name: "sidebar"
+            }
+          ]
+        },
+        {
+          name: "footer"
+        }
+      ]
+    }
+  },
+  routes: [
+    {
+      page: "personalDetails",
+      path: "personal-details"
+    },
+    {
+      page: "contactDetails",
+      path: "contact-details"
+    }
+  ],
+  timeouts: {
+    apollo: 10000
+  },
+  timezone: "Europe/London"
+} as const;

package/src/__testUtils__/config.ts

@@ -0,0 +1,32 @@
+export const config = {
+  countryCode: 'GB',
+  countryName: 'United Kingdom',
+  distanceUnit: 'km',
+  languageCodes: ['en'],
+  locales: ['en_GB'],
+  name: 'alpha',
+  pages: {
+    contactDetails: {
+      name: 'contactDetails',
+      sections: [
+        { name: 'header' },
+        { name: 'body', sections: [{ name: 'main' }, { name: 'sidebar' }] },
+        { name: 'footer' },
+      ],
+    },
+    personalDetails: {
+      name: 'personalDetails',
+      sections: [
+        { name: 'header' },
+        { name: 'body', sections: [{ name: 'main' }, { name: 'sidebar' }] },
+        { name: 'footer' },
+      ],
+    },
+  },
+  routes: [
+    { page: 'personalDetails', path: 'personal-details' },
+    { page: 'contactDetails', path: 'contact-details' },
+  ],
+  timeouts: { apollo: 10_000 },
+  timezone: 'Europe/London',
+} as const;

package/src/__testUtils__/configBuilder.ts

@@ -0,0 +1,58 @@
+import kebabCase from 'lodash/kebabCase.js';
+import { createConfigBuilder } from '../createConfigBuilder.ts';
+import {
+  type ConfigType,
+  type PageType,
+  type RouteType,
+  type SectionType,
+  configSchema,
+  pageSchema,
+  routeSchema,
+  sectionSchema,
+} from './schema.ts';
+
+const configBuilder = createConfigBuilder<ConfigType>(configSchema);
+const routeBuilder = createConfigBuilder<RouteType>(routeSchema, { path: ({ page }) => kebabCase(page) });
+const pageBuilder = createConfigBuilder<PageType>(pageSchema);
+const sectionBuilder = createConfigBuilder<SectionType>(sectionSchema);
+const subsectionBuilder = sectionBuilder.fork();
+
+configBuilder
+  .countryCode('GB')
+  .countryName('United Kingdom')
+  .distanceUnit('km')
+  .languageCodes(['en'])
+  .locales(({ countryCode, languageCodes }) =>
+    languageCodes?.length && countryCode ? languageCodes.map(code => `${code}_${countryCode}`) : []
+  )
+  .name('alpha')
+  .pages({
+    contactDetails: pageBuilder
+      .name('contactDetails')
+      .sections([
+        sectionBuilder.name('header').flush(),
+        sectionBuilder
+          .name('body')
+          .sections([subsectionBuilder.name('main').flush(), subsectionBuilder.name('sidebar').flush()])
+          .flush(),
+        sectionBuilder.name('footer').flush(),
+      ])
+      .flush(),
+    personalDetails: pageBuilder
+      .name('personalDetails')
+      .sections([
+        sectionBuilder.name('header').flush(),
+        sectionBuilder
+          .name('body')
+          .sections([subsectionBuilder.name('main').flush(), subsectionBuilder.name('sidebar').flush()])
+          .flush(),
+        sectionBuilder.name('footer').flush(),
+      ])
+      .flush(),
+  })
+  .routes([routeBuilder.page('personalDetails').flush(), routeBuilder.page('contactDetails').flush()])
+  .timeouts({ apollo: 10_000 })
+  .timezone('Europe/London');
+
+// eslint-disable-next-line import/no-default-export
+export default configBuilder;

package/src/__testUtils__/schema.ts

@@ -0,0 +1,56 @@
+import { z } from 'zod';
+import { countryCodes } from '../data/countryCodes.ts';
+import { countryNames } from '../data/countryNames.ts';
+import { distanceUnits } from '../data/distanceUnits.ts';
+import { languageCodes } from '../data/languageCodes.ts';
+import { timezones } from '../data/timezones.ts';
+
+export const baseSectionSchema = z.object({
+  name: z.string(),
+});
+
+export type SectionType = z.infer<typeof baseSectionSchema> & {
+  sections?: SectionType[];
+};
+
+export const sectionSchema: z.ZodType<SectionType> = baseSectionSchema.extend({
+  sections: z.lazy(() => sectionSchema.array()).optional(),
+});
+
+export const pageSchema = z.object({
+  name: z.string(),
+  path: z.string().optional(),
+  queryParams: z.array(z.string()).optional(),
+  sections: z.array(sectionSchema).optional(),
+});
+
+export type PageType = z.infer<typeof pageSchema>;
+
+const baseRouteSchema = z.object({
+  aliases: z.array(z.string()).optional(),
+  page: z.string(),
+  path: z.string(),
+});
+
+export type RouteType = z.infer<typeof baseRouteSchema> & {
+  routes?: RouteType[];
+};
+
+export const routeSchema: z.ZodType<RouteType> = baseRouteSchema.extend({
+  routes: z.lazy(() => routeSchema.array()).optional(),
+});
+
+export const configSchema = z.object({
+  countryCode: z.enum(countryCodes).optional(),
+  countryName: z.enum(countryNames).optional(),
+  distanceUnit: z.enum(distanceUnits).optional(),
+  languageCodes: z.array(z.enum(languageCodes)).optional(),
+  locales: z.array(z.string().regex(/[a-z]{2}_[A-Z]{2}/)).optional(),
+  name: z.string().optional(),
+  pages: z.record(pageSchema).optional(),
+  routes: z.array(routeSchema).optional(),
+  timeouts: z.record(z.number()).optional(),
+  timezone: z.enum(timezones).optional(),
+});
+
+export type ConfigType = z.infer<typeof configSchema>;

package/src/cli.ts

@@ -0,0 +1,86 @@
+import { watchFile } from 'node:fs';
+import { resolve } from 'node:path';
+import shelljs from 'shelljs';
+import yargs from 'yargs';
+import type { ExperimentsCallback } from './types.ts';
+import { writeConfig } from './utils/writeConfig.ts';
+
+export const cli = () => {
+  yargs
+    .command(
+      'watch <inputFile> <outputFile>',
+      'watch a config builder and write ',
+      cmdYargs =>
+        cmdYargs
+          .positional('inputFile', {
+            demandOption: true,
+            desc: 'The relative path to the config builder root file',
+            type: 'string',
+          })
+          .positional('outputFile', {
+            demandOption: true,
+            desc: 'The relative path to the output config file',
+            type: 'string',
+          })
+          .option('experiments-callback', {
+            desc: 'The relative path to the experiment callback file',
+            type: 'string',
+          }),
+      argv => {
+        const fullWatchFilePath = resolve(process.cwd(), argv.inputFile);
+        shelljs.echo(`zcd watch => watching file: ${argv.inputFile}`);
+
+        watchFile(fullWatchFilePath, () => {
+          import(fullWatchFilePath)
+            .then(
+              ({
+                default: configBuilder,
+              }: {
+                default: ReturnType<typeof import('./createConfigBuilder.ts')['createConfigBuilder']>;
+              }) => {
+                shelljs.echo('zcd watch => file change detected');
+
+                if (!configBuilder.validate()) {
+                  shelljs.echo('zcd watch => invalid config');
+                  shelljs.echo(`zcd watch => errors:\n${JSON.stringify(configBuilder.errors(), undefined, 2)}\n`);
+                  shelljs.exit(1);
+                }
+
+                shelljs.echo('zcd watch => valid config');
+                shelljs.echo(`zcd watch => config values:\n${configBuilder.toJson()}\n`);
+
+                if (argv['experiments-callback']) {
+                  import(resolve(process.cwd(), argv['experiments-callback']))
+                    .then(({ default: experimentsCallback }: { default: ExperimentsCallback }) => {
+                      void writeConfig(configBuilder.values(), { experimentsCallback, outputFile: argv.outputFile });
+                    })
+                    .catch((error: unknown) => {
+                      if (error instanceof Error) {
+                        shelljs.echo(`zcd watch => error message: ${error.message}`);
+
+                        if (error.stack) {
+                          shelljs.echo(`zcd watch => error stack:\n${error.stack}\n`);
+                        }
+                      }
+                    });
+
+                  return;
+                }
+
+                void writeConfig(configBuilder.values(), { outputFile: argv.outputFile });
+              }
+            )
+            .catch((error: unknown) => {
+              if (error instanceof Error) {
+                shelljs.echo(`zcd watch => error message: ${error.message}`);
+
+                if (error.stack) {
+                  shelljs.echo(`zcd watch => error stack:\n${error.stack}\n`);
+                }
+              }
+            });
+        });
+      }
+    )
+    .help().argv;
+};