@vertekum/schema-builder 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2026 Thomas Schemmer
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,125 @@
+# @vertekum/schema-builder
+
+Declare a token vocabulary as grammar; build it into ordinary JSON Schema files.
+
+A vocabulary schema governs **names and order** — which token names may exist, in what
+order, and where the order ends. Writing that shape by hand means dozens of lines of JSON
+Schema per branch. This extension adds a definition language (`.dfn` files) that states the
+same thing in one expression, and a build step that materializes the JSON Schema files your
+`schemas` config binds. Core, `check`, and every consumer keep seeing plain schema files —
+the grammar is authoring source, never a runtime notation.
+
+## Get started
+
+1. Add the extension to your config:
+
+```ts
+import { defineConfig } from '@vertekum/core';
+import { schemaBuilderExtension } from '@vertekum/schema-builder';
+
+export default defineConfig({
+  collection: './tokens',
+  extensions: [schemaBuilderExtension],
+  schemas: [{ from: './schemas', domain: 'vocabulary', use: { 'house.json': '*.json' } }],
+});
+```
+
+2. Declare the vocabulary — `schemas/house.dfn`:
+
+```dfn
+emphasis = subtle | bold
+
+root = color.text.[neutral | brand | success].<emphasis>
+```
+
+3. Build it, then check as usual:
+
+```bash
+npx vertekum schema build          # writes schemas/house.json beside the module
+npx vertekum check                 # the built schema now governs your token names
+```
+
+`schema build` accepts a single module argument, defaults to every `.dfn` under
+`./schemas`, and supports `--dry-run` (list without writing), `--json`, and `--check`
+(verify built files are current; exit 1 when stale — the CI guard).
+
+## The definition language
+
+A module is line-oriented: `#` comments, pragmas, `use` imports, and productions. An
+indented line continues the statement above it.
+
+### Statements
+
+| statement | meaning |
+| --- | --- |
+| `name = expression` | a **production**: a named fragment (a denotation, a branch, a whole subtree) |
+| `root = expression` | the reserved production `build` materializes; one per module |
+| `use "./other.dfn"` | import a module (relative path or package specifier) |
+| `id "…"` `title "…"` `description "…"` | pragmas: the built schema's `$id`, `title`, `description` |
+| `scope "branch"` | the schema governs only its named top-level branches — the document root stays unsealed so sibling vocabularies can bind over the same files (default: `"document"`, which seals it) |
+
+### Expressions
+
+| syntax | meaning |
+| --- | --- |
+| `a.b.c` | nesting — one name-tree level per step |
+| `a \| b` | alternation — the set of permitted names |
+| `[ … ]` | grouping; groups may hold full sub-paths (branches) |
+| `<name>` | reference a local production |
+| `<@name>` | reference an imported production; an imported module's *root* goes by its basename |
+| `<name [a, b]>` | **pick** — only the listed members of the set |
+| `<name ![a, b]>` | **omit** — the set minus the listed members |
+| `<name*>` / `[a \| b *]` | **open set** — additions beyond the listed names are permitted, and every member (listed or added) takes the same tail |
+| `step?` | **optional slot** — the step may be skipped: `<role>.<emphasis>?.<state>?` grants `role`, `role.<emphasis>`, `role.<state>`, and the full path |
+| `100-900/100` | a numeric range with step, inclusive both ends, enumerated at build |
+
+Pick and omit validate every listed name against the set's members — a typo is a build
+error, and a modified set is a new set. Naming one derives a narrowed denotation:
+
+```dfn
+use "./colors.dfn"
+
+limited-accents = <@accent-color [red, blue]>
+```
+
+### Style: the root reads as the syntagm
+
+State the high-level shape in the root and let unused slots collapse; give forks their own
+named productions instead of nesting:
+
+```dfn
+property = background | text | icon | border
+role = brand | danger | neutral | success | warning
+emphasis = subtle | bold
+state = hovered | pressed
+
+root = color.[
+    <property>.<role>?.<emphasis>?.<state>?
+  | <code>
+  ]
+
+code = text.code.[comments | keywords | strings]
+```
+
+## Built artifacts and ownership
+
+A built file lands beside its module (`house.dfn` → `house.json`) and carries a `$comment`
+stamp naming its source. The stamp is the ownership contract: `schema build` regenerates
+stamped files and **never overwrites a file whose stamp was removed** — hand-edit the JSON
+and delete the stamp to take ownership, and the builder leaves it alone from then on.
+
+## Ejecting grammar
+
+`vertekum schema eject` copies any resolvable file verbatim — including `.dfn` modules
+from packages that ship them:
+
+```bash
+npx vertekum schema eject @vertekum/schema-atlassian/color.dfn ./schemas/color.dfn
+npx vertekum schema build
+```
+
+Ejecting the grammar (rather than the built JSON) means your edits stay one-line grammar
+edits with a rebuild, instead of surgery on generated schema. Two notes: an ejected module
+that `use`s relative imports needs them ejected alongside it; and the config hint `eject`
+prints applies to schemas you bind directly — an ejected `.dfn` is not bound, its *built*
+`.json` is.

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@vertekum/schema-builder",
+  "version": "0.1.0",
+  "description": "Declare token vocabularies as grammar; build them into JSON Schema files",
+  "license": "Apache-2.0",
+  "keywords": [
+    "design-tokens",
+    "dtcg",
+    "schema",
+    "vocabulary",
+    "grammar"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moros-oxus/vertekum.git",
+    "directory": "packages/schemas/builder"
+  },
+  "homepage": "https://github.com/moros-oxus/vertekum",
+  "bugs": "https://github.com/moros-oxus/vertekum/issues",
+  "files": [
+    "CHANGELOG.md",
+    "src",
+    "tsconfig.json",
+    "!src/**/*.test.ts"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts",
+    "./api": "./src/api.ts",
+    "./cli": "./src/cli.ts"
+  },
+  "peerDependencies": {
+    "@vertekum/core": "0.1.0"
+  },
+  "dependencies": {
+    "zod": "^3.25.76"
+  },
+  "devDependencies": {
+    "@vertekum/core": "0.1.0",
+    "@vertekum/schema-vocabulary": "0.1.0"
+  }
+}

package/src/api.ts

@@ -0,0 +1,16 @@
+import type { ActivateContext } from '@vertekum/core';
+import { schemaBuildCommand } from './cli';
+import type { schemaBuilderManifest } from './index';
+
+export { assertOpenSetsAreNameSets, build, type TreeNode } from './build';
+export { buildModule, schemaBuildCommand } from './cli';
+export { emit, isStamped, STAMP_PREFIX, stamp } from './emit';
+export { parse } from './parser';
+export { type ResolvedModule, resolveModule } from './resolve';
+
+/** Headless activation: contributes the `schema build` command and nothing else. */
+export function activate(
+  ctx: ActivateContext<typeof schemaBuilderManifest>,
+): void {
+  ctx.commands.register(schemaBuildCommand);
+}

package/src/ast.ts

@@ -0,0 +1,86 @@
+/**
+ * The definition-file AST — a normalized description of a `.dfn` module. Nodes describe the NAME
+ * TREE a vocabulary permits: nesting (`.`), alternation (`|`), references (`<x>` / `<@x>`), and
+ * range terms. The parser knows the grammar, not the semantics: a `ref` node knows its name is
+ * `color-role`, not what that production expands to — expansion lives in the builder.
+ */
+
+/** A parsed module: imports, named productions, and the reserved `root` (absent in fragments). */
+export interface Module {
+  /** `use "<specifier>"` statements, in order: relative paths or package specifiers. */
+  uses: string[];
+  /** Productions by name. `root` is never stored here. */
+  productions: Map<string, Node>;
+  /** The reserved `root` production, when declared. */
+  root: Node | undefined;
+  /** Pragmas (`id "…"`, `title "…"`, `description "…"`) — document metadata for emission. */
+  meta: ModuleMeta;
+}
+
+/** The pragma statements a module may carry, each at most once. */
+export interface ModuleMeta {
+  id?: string;
+  title?: string;
+  description?: string;
+  /**
+   * `scope "branch"`: the schema governs only the top-level branches it names — the document
+   * root stays unsealed, so sibling vocabularies can bind over the same files. The default,
+   * `document`, seals the root: nothing beyond the granted names may exist.
+   */
+  scope?: 'document' | 'branch';
+}
+
+export type Node = Alt | Path | Name | Range | Ref | Group;
+
+/** `a | b | c` — set union of the options' name trees. */
+export interface Alt {
+  kind: 'alt';
+  options: Node[];
+}
+
+/** `a.b.c` — nesting, one level per step, left to right. */
+export interface Path {
+  kind: 'path';
+  steps: Step[];
+}
+
+/** One step of a path; `optional` records a trailing `?` (parsed, reserved — no artifact effect). */
+export interface Step {
+  term: Name | Range | Ref | Group;
+  optional: boolean;
+}
+
+/** A literal name segment — an identifier or a bare number. */
+export interface Name {
+  kind: 'name';
+  value: string;
+}
+
+/** `min-max/step` — an inclusive numeric name set, enumerated at build time. */
+export interface Range {
+  kind: 'range';
+  min: number;
+  max: number;
+  step: number;
+}
+
+/**
+ * `<name>` / `<@name>`; `open` records a trailing `*` (the set admits additions). Set
+ * modifiers: `[a, b]` is PICK (only the listed members), `![a, b]` is OMIT (the set minus
+ * them) — a modified reference is a new set.
+ */
+export interface Ref {
+  kind: 'ref';
+  name: string;
+  imported: boolean;
+  open: boolean;
+  pick: string[];
+  omit: string[];
+}
+
+/** `[ … ]`; `open` records a trailing `*` before the closing bracket. */
+export interface Group {
+  kind: 'group';
+  node: Node;
+  open: boolean;
+}