Embedded json schema

apps/class-solid/README.md

@@ -54,7 +54,7 @@ This allows you to trigger tests from the [playwright ui](https://playwright.dev
 An experiment can get started from a preset.
 
 The presets are stored in the `src/lib/presets/` directory.
-The format is JSON with content adhering to the [JSON schema](https://github.com/classmodel/class-web/blob/main/packages/class/src/config.json).
+The format is JSON with content adhering to the [JSON schema](https://github.com/classmodel/class-web/blob/main/packages/class/src/config.ts).
 
 The `src/lib/presets.ts` is used as an index of presets.
 If you add a preset the `src/lib/presets.ts` file needs to be updated.

packages/class/README.md

@@ -36,6 +36,9 @@ pnpx @classmodel/class run --output output.csv --format csv config.json
 
 # To read from stdin use
 cat config.json | pnpx @classmodel/class -
+
+# To get the JSON schema of the config file use
+pnpx @classmodel/class schema -o config.schema.json
 ```
 If you do not have `pnpx` installed you can use `npx` instead.
 
@@ -70,20 +73,10 @@ This package is part of a [monorepo](https://github.com/classmodel/class-web) wi
 
 ### JSON schema
 
-The Class model uses a JSON schema to validate the input configuration. The schema is defined in the `@classmodel/class` package and can be found at [src/config.json](https://github.com/classmodel/class-web/blob/main/packages/class/src/config.json) (in [repo](./src/config.json)). The schema is used to validate the input configuration and to generate a form to input the configuration.
+The Class model uses a JSON schema to validate the input configuration. The schema is defined in the `@classmodel/class` package and can be found at [src/config.ts](https://github.com/classmodel/class-web/blob/main/packages/class/src/config.ts) (in [repo](./src/config.ts)). The schema is used to validate the input configuration and to generate a form to input the configuration.
 
 The `src/config.ts` file contains the embedded JSON schema and its Typescript type definition.
 
-<!-- When runnning `pnpm dev` or `pnpm build` the `src/config.ts` file is generated from the `src/config.json` file.
-
-To manually generate the `src/config.ts` file run the following command:
-
-```shell
-pnpm json2ts
-``` -->
-
-At the moment you manually have to keep the `src/config.ts` file in sync with the `src/config.json` file. By copying the content over and updating the TypeScript Config type.
-
 See the [form package](../form/README.md#json-schema) for additional keywords in the JSON schema.
 
 #### Conditional properties

packages/class/package.json

@@ -23,7 +23,6 @@
         "types": "./dist/config.d.ts"
       }
     },
-    "./config.json": "./dist/config.json",
     "./config_utils": {
       "import": {
         "default": "./dist/config_utils.js",
@@ -54,23 +53,17 @@
   "files": ["dist"],
   "license": "GPL-3.0-only",
   "scripts": {
-    "dev": "concurrently -n \"tsc,json2ts\" -c \"blue,green\" \"pnpm dev:tsc\" \"pnpm json2ts --watch\"",
-    "dev:tsc": "tsc --watch",
-    "build:tsc": "tsc",
-    "build:config": "cp src/config.json dist/config.json",
-    "build": "pnpm json2ts && pnpm build:tsc && pnpm build:config",
+    "dev": "tsc --watch",
+    "build": "tsc",
     "prepack": "pnpm build",
     "test": "tsx --test src/*.test.ts",
     "typecheck": "tsc --noEmit",
-    "json2ts": "node scripts/json2ts.mjs",
     "docs": "typedoc",
     "clean": "rm -rf dist"
   },
   "bin": "./dist/cli.js",
   "devDependencies": {
     "@types/node": "^20.13.1",
-    "concurrently": "^9.0.1",
-    "json-schema-to-typescript": "^15.0.2",
     "tsx": "^4.16.5",
     "typedoc": "^0.26.10",
     "typescript": "^5.3.3"

packages/class/src/cli.ts

@@ -6,6 +6,7 @@
 import { readFile, writeFile } from "node:fs/promises";
 import { EOL } from "node:os";
 import { Command, Option } from "@commander-js/extra-typings";
+import { jsonSchemaOfConfig } from "./config.js";
 import type { ClassOutput } from "./runner.js";
 import { runClass } from "./runner.js";
 import { parse } from "./validate.js";
@@ -142,6 +143,19 @@ function buildCommand() {
       }
     });
 
+  program
+    .command("schema")
+    .description("Print the JSON schema for the configuration file")
+    .option("-o, --output <output-file>", "Output file. Default is stdout", "-")
+    .action((options) => {
+      const output = JSON.stringify(jsonSchemaOfConfig, null, 2);
+      if (options.output === "-") {
+        console.log(output);
+      } else {
+        writeTextFile(output, options.output);
+      }
+    });
+
   return program;
 }