JSONSpecs CLI

CLI backend and local studio host for jsonspecs rules projects.

Commands

• jsonspecs init <project-name>
• jsonspecs studio
• jsonspecs validate
• jsonspecs build

Studio architecture

jsonspecs-cli serves a built SPA from / and exposes a JSON API under /api/*. The current bundled frontend is expected to be built from the separate jsonspecs-studio-ui project and copied into static/.

Runtime model

jsonspecs-cli is an authoring/build tool. It works with a rules project that contains:

• source rules in rules/
• project metadata in manifest.json
• project-local Node operator packs in operators/node
• sample payloads in samples/

Custom operators

Project-local custom operators are loaded from manifest.json:

{
  "operatorPacks": {
    "node": ["./operators/node"]
  }
}

A local node operator pack should export an object with check, predicate and optional meta sections:

module.exports = {
  check: {
    amount_gt_zero(rule, ctx) {
      const got = ctx.get(rule.field);
      if (!got.ok()) return { ok: false, actual: undefined };

      const n = Number(got.value);
      return { ok: Number.isFinite(n) && n > 0, actual: got.value };
    },
  },
  predicate: {},
  meta: {
    operators: {
      amount_gt_zero: {
        description: "должно быть больше нуля",
      },
    },
  },
};

Stable operator context

Custom operators should use the runtime context passed by jsonspecs:

• ctx.get(path) — reads a payload field in a stable way
• ctx.has(path) — checks field presence
• ctx.payload — raw payload map
• ctx.getDictionary(id) — access a dictionary by id

Project-local operator packs should not import deepGet or jsonspecs directly.

Install

npm install
npm link

Test

npm test