@clearlydev/nx-archweave 0.0.0-stage → 0.1.1

package/src/generators/feature/schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "id": "Feature",
+  "title": "Scaffold a new FSD feature slice",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Slice name in kebab-case (e.g. \"add-to-cart\") — becomes <app>/src/features/<name>. Invalid values are refused with a report, not thrown"
+    },
+    "publicApiName": {
+      "type": "string",
+      "description": "Exported stub function name. Defaults to the camelCase form of name"
+    },
+    "segments": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Extra segments to start the slice with, each as <segment>/index.ts (e.g. ui,api). model always exists — it holds the stub. Names are by purpose: ui, api, lib, config … (components/hooks/utils/types are refused)"
+    },
+    "project": {
+      "type": "string",
+      "description": "The frontend app whose source root holds the FSD layers (run add-fsd-lite first). Omitted: the workspace's one frontend application; with more than one, the run is refused with the candidates listed"
+    },
+    "locale": {
+      "type": "string",
+      "enum": ["ko", "en"],
+      "description": "Generated content language. Defaults to toolkit.config.json's locale, else en"
+    },
+    "dryRun": {
+      "type": "boolean",
+      "default": false,
+      "description": "Print the files that would be generated without writing anything"
+    }
+  },
+  "required": ["name"]
+}

package/src/generators/init/schema.json

@@ -0,0 +1,98 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "id": "Init",
+  "title": "Run the preset-driven init pipeline (FSD Lite, agent rules, GitHub templates, review)",
+  "type": "object",
+  "properties": {
+    "preset": {
+      "type": "string",
+      "enum": [
+        "quick-start",
+        "solo",
+        "team"
+      ],
+      "description": "Preset that determines each sub-generator's default configuration (buildPresetConfig). Recorded in toolkit.config.json; omitted: the recorded one (required when none is recorded)"
+    },
+    "frontend": {
+      "type": "string",
+      "enum": [
+        "react-vite",
+        "next",
+        "none"
+      ],
+      "description": "Target frontend; 'none' is a backend-only workspace (needs --backend; FSD is skipped). Recorded in toolkit.config.json; omitted: the recorded one (required when none is recorded)"
+    },
+    "backend": {
+      "type": "string",
+      "enum": [
+        "express",
+        "nest",
+        "none"
+      ],
+      "description": "Backend app wiring: delegates app creation to the official @nx generators and wires shared-types, scope tags, and module-boundary constraints. 'none' leaves the workspace frontend-only. Omitted: toolkit.config.json's backend (add-backend records it), else none — no schema default, which would shadow the recorded one"
+    },
+    "locale": {
+      "type": "string",
+      "enum": [
+        "ko",
+        "en"
+      ],
+      "description": "Generated content language, passed through to every enabled sub-generator and recorded in toolkit.config.json. Omitted: the recorded locale, else en (no schema default — Nx would apply it even when the flag is omitted and shadow the recorded value)"
+    },
+    "reviewProvider": {
+      "type": "string",
+      "enum": ["claude", "gemini", "gpt", "cursor"],
+      "description": "Review provider when review is on. Omitted: toolkit.config.json's review.provider (unless --aiHosts changes the first host), else the first AI host's (Claude Code → claude, Codex → gpt, Cursor → cursor, Gemini CLI → gemini)"
+    },
+    "aiHosts": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": ["claude-code", "codex", "cursor", "gemini-cli"]
+      },
+      "description": "The AI coding tools the workspace is set up for: they decide the agent-rules files (Claude Code → CLAUDE.md; Codex, Cursor, Gemini CLI → AGENTS.md) and the review provider default (the first one's). Recorded in toolkit.config.json. Default: Claude Code."
+    },
+    "fsd": {
+      "type": "boolean",
+      "description": "Toggle add-fsd-lite. Defaults to the preset's enablement (always on)"
+    },
+    "agentRules": {
+      "type": "boolean",
+      "description": "Toggle add-agent-rules. Defaults to the preset's enablement (on)"
+    },
+    "githubTemplates": {
+      "type": "boolean",
+      "description": "Toggle add-github-templates. Defaults to the preset's enablement (on)"
+    },
+    "review": {
+      "type": "boolean",
+      "description": "Toggle add-review. Defaults to the preset's review.enabled default (quick-start: off, solo/team: on)"
+    },
+    "dryRun": {
+      "type": "boolean",
+      "default": false,
+      "description": "Preview the full pipeline: zero writes, and the post-run validation callback never runs"
+    },
+    "allowDirty": {
+      "type": "boolean",
+      "default": false,
+      "description": "Run even when the working tree has uncommitted changes. The report then warns that `git restore .` also reverts those pre-existing changes. Used by create-nx-archweave, whose own plugin-install step dirties the fresh workspace right before init runs"
+    },
+    "applyEslint": {
+      "type": "boolean",
+      "default": false,
+      "description": "Write the ESLint rules for real — the scope depConstraints into the root config (add-backend) and the archweave/fsd-boundaries rule into the frontend app's config (add-fsd-lite) — instead of printing report-only snippets. The create CLI passes this on workspaces it just created; leave it off to keep existing configs untouched"
+    },
+    "packageManager": {
+      "type": "string",
+      "enum": [
+        "pnpm",
+        "npm",
+        "yarn",
+        "bun"
+      ],
+      "description": "Package manager of the workspace (default: detected from lockfiles, then the one recorded in toolkit.config.json, then pnpm). Recorded in toolkit.config.json."
+    }
+  }
+}

package/src/generators/install-integration/schema.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "id": "InstallIntegration",
+  "title": "Install a supported external integration through its official CLI, verify it live, record and declare it",
+  "type": "object",
+  "properties": {
+    "tool": {
+      "type": "string",
+      "enum": ["ponytail"],
+      "description": "The plugin to install, by its plugin-catalog id (@nx-archweave/integrations plugin-catalog.ts). The enum is kept equal to the catalog by a test."
+    },
+    "target": {
+      "type": "string",
+      "enum": ["claude-code"],
+      "default": "claude-code",
+      "description": "The host environment to install into. Hosts with a plugin adapter; today only 'claude-code'."
+    },
+    "scope": {
+      "type": "string",
+      "enum": ["user", "project", "local"],
+      "description": "Claude Code plugin scope for `claude plugin install --scope` (default project, which records it in the workspace's .claude/settings.json; local writes its personal .claude/settings.local.json; user installs for every project of this user). When given explicitly, an existing install at a different scope is reported instead of counted as installed."
+    },
+    "versionRange": {
+      "type": "string",
+      "description": "Version to show as requested. Not enforced — the marketplace decides the plugin version, and the version actually installed is the one recorded."
+    },
+    "apply": {
+      "type": "boolean",
+      "default": false,
+      "description": "Run the official install command, re-verify live, record the manifest entry and declare the integration in toolkit.config.json. Without it (default) the generator only checks the current state and shows the exact command. Ignored when Nx's own --dry-run is set."
+    }
+  },
+  "required": ["tool"]
+}

package/src/generators/page/schema.json

@@ -0,0 +1,53 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "id": "Page",
+  "title": "Scaffold a new FSD page slice",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Slice name in kebab-case (e.g. \"home\") — becomes <app>/src/pages/<name> (a screen composed from the layers below). Invalid values are refused with a report, not thrown"
+    },
+    "publicApiName": {
+      "type": "string",
+      "description": "Exported stub function name. Defaults to the camelCase form of name"
+    },
+    "segments": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Extra segments to start the slice with, each as <segment>/index.ts (e.g. ui,api). model always exists — it holds the stub. Names are by purpose: ui, api, lib, config … (components/hooks/utils/types are refused)"
+    },
+    "project": {
+      "type": "string",
+      "description": "The frontend app whose source root holds the FSD layers. Omitted: the workspace's one frontend application; with more than one, the run is refused with the candidates listed"
+    },
+    "frontend": {
+      "type": "string",
+      "enum": [
+        "react-vite",
+        "next"
+      ],
+      "description": "Decides the layer directory: pages/ on react-vite, _pages/ on next (Next.js reads src/pages as its Pages Router). Omitted: toolkit.config.json's frontend (init records it), else detected from a next.config file in the app, else react-vite"
+    },
+    "locale": {
+      "type": "string",
+      "enum": [
+        "ko",
+        "en"
+      ],
+      "description": "Generated content language. Defaults to toolkit.config.json's locale, else en"
+    },
+    "dryRun": {
+      "type": "boolean",
+      "default": false,
+      "description": "Print the files that would be generated without writing anything"
+    }
+  },
+  "required": [
+    "name"
+  ],
+  "description": "Scaffold a new FSD page slice. On Next.js the layer directory is _pages (Next.js reads src/pages as its Pages Router)"
+}

package/src/generators/record-integration/schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "id": "RecordIntegration",
+  "title": "Verify a manually installed integration and record its verified state",
+  "type": "object",
+  "properties": {
+    "tool": {
+      "type": "string",
+      "enum": ["ponytail"],
+      "description": "The plugin to verify and record, by its plugin-catalog id (@nx-archweave/integrations plugin-catalog.ts). The enum is kept equal to the catalog by a test."
+    },
+    "target": {
+      "type": "string",
+      "enum": ["claude-code"],
+      "default": "claude-code",
+      "description": "The host environment to verify against. Hosts with a plugin adapter; today only 'claude-code'."
+    },
+    "apply": {
+      "type": "boolean",
+      "default": false,
+      "description": "Write the manifest entry (only if live verification succeeds). Without it (default) the generator performs the same live read-only verification and shows what would be recorded, writing nothing. Ignored when Nx's own --dry-run is set."
+    }
+  },
+  "required": ["tool"]
+}

package/src/generators/shared/schema.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "id": "Shared",
+  "title": "Scaffold a new FSD shared slice",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Slice name in kebab-case (e.g. \"date-format\") — becomes <app>/src/shared/<name>. Invalid values are refused with a report, not thrown"
+    },
+    "publicApiName": {
+      "type": "string",
+      "description": "Exported stub function name. Defaults to the camelCase form of name"
+    },
+    "project": {
+      "type": "string",
+      "description": "The frontend app whose source root holds the FSD layers (run add-fsd-lite first). Omitted: the workspace's one frontend application; with more than one, the run is refused with the candidates listed"
+    },
+    "locale": {
+      "type": "string",
+      "enum": ["ko", "en"],
+      "description": "Generated content language. Defaults to toolkit.config.json's locale, else en"
+    },
+    "dryRun": {
+      "type": "boolean",
+      "default": false,
+      "description": "Print the files that would be generated without writing anything"
+    }
+  },
+  "required": ["name"]
+}

package/src/generators/widget/schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "id": "Widget",
+  "title": "Scaffold a new FSD widget slice",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Slice name in kebab-case (e.g. \"header\") — becomes <app>/src/widgets/<name> (a self-contained block of UI composed from features and entities). Invalid values are refused with a report, not thrown"
+    },
+    "publicApiName": {
+      "type": "string",
+      "description": "Exported stub function name. Defaults to the camelCase form of name"
+    },
+    "segments": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Extra segments to start the slice with, each as <segment>/index.ts (e.g. ui,api). model always exists — it holds the stub. Names are by purpose: ui, api, lib, config … (components/hooks/utils/types are refused)"
+    },
+    "project": {
+      "type": "string",
+      "description": "The frontend app whose source root holds the FSD layers. Omitted: the workspace's one frontend application; with more than one, the run is refused with the candidates listed"
+    },
+    "locale": {
+      "type": "string",
+      "enum": [
+        "ko",
+        "en"
+      ],
+      "description": "Generated content language. Defaults to toolkit.config.json's locale, else en"
+    },
+    "dryRun": {
+      "type": "boolean",
+      "default": false,
+      "description": "Print the files that would be generated without writing anything"
+    }
+  },
+  "required": [
+    "name"
+  ],
+  "description": "Scaffold a new FSD widget slice. widgets is outside the Lite default scope — this generator is how a workspace opts in; the lint rule already knows the layer"
+}