basic

@tskm/example-basic

The smallest end-to-end tskm loop: write a schema → generate a concrete type → import it and validate at runtime.

Files

• src/user.schema.ts: the schemas you author (userSchema, productSchema).
• src/category.schema.ts: a RECURSIVE schema via recursive((self) => …), with no hand-written type, and the transform inside the cycle still resolves to its real output type.
• src/user.schema.gen.ts / src/category.schema.gen.ts: generated by tskm gen. Concrete types, no Infer<…>, including the materialized self-referential Category.
• src/main.ts: a consumer that imports the generated User / Product types and validates with safeParse.

tsconfig.json maps @tskm/core to the workspace source via paths so the checker can resolve the inferred output type. In a real project @tskm/core is a normal dependency and no paths entry is needed.

Generate

From the repository root (after bun install + bun run build):

bun packages/compiler/dist/cli.mjs gen --root examples/basic
# in a published project this is simply:  bunx tskm gen

(The recursive categorySchema is resolved by an isolated worker that imports the schema module, so the worker runtime must be able to import .ts: bun here, or worker.execPath in tskm.config.ts.)

This rewrites src/user.schema.gen.ts. Sidecar mode always rewrites the file (and reports wrote), but the content is stable: once it matches the current compiler, re-running leaves the file diff-free.

Try the other modes

# Rewrite `export type T = Infer<typeof X>` markers in place instead of a sidecar (experimental):
node packages/compiler/dist/cli.mjs gen --root examples/basic --mode inplace

# Emit JSON Schema next to each source (experimental; needs a runtime that can import the .ts module):
node packages/compiler/dist/cli.mjs json-schema --root examples/basic

# Regenerate on every change:
node packages/compiler/dist/cli.mjs watch --root examples/basic

In a Vite app, add the plugin instead of running the CLI:

import { tskm } from "@tskm/vite"

export default {
  plugins: [tskm()],
}

Next

examples/advanced goes further: a discriminatedUnion with derived tag metadata, a recursive (cyclic) JSON schema written data-first with recursive(), and the explicit export type T = Infer<typeof schema> marker. examples/ssot then composes the single-source-of-truth primitives (templateLiteral, faithful optional keys, keyed record, exactObject, severity warnings) in one place.