@tailor-platform/erp-kit 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @tailor-platform/erp-kit
 
+## 0.2.0
+
+### Minor Changes
+
+- 373b856: Add doc-driven deterministic code generation, defineQuery functions, type-safe command errors with Result type, license check command, auto-generated CLI docs, and item-management module. Fix cross-module type references in Kysely codegen and module scaffold structure. Refactor shared module skills, cross-module dependency handling, and scaffold templates.
+
+## 0.1.2
+
+### Patch Changes
+
+- 0c9a2e5: CQRS query support and app/module subcommands
+
 ## 0.1.1
 
 ### Patch Changes

package/README.md

@@ -11,18 +11,29 @@ npm install @tailor-platform/erp-kit
 ## Quick Start
 
 ```bash
-# Set up your repo (agent skills, rules)
+# Set up your repo (agent skills)
 erp-kit init
 
-# Validate docs against schemas
-erp-kit check --modules-root modules
-erp-kit check --app-root examples
+# List available modules
+erp-kit module list
+
+# Validate module docs against schemas
+erp-kit module check --root src/modules
 
 # Check source ↔ doc correspondence
-erp-kit sync-check --modules-root modules
+erp-kit module sync-check --root src/modules
+
+# Generate a new module doc from template
+erp-kit module scaffold command inventory createOrder --root src/modules
+
+# Validate app docs
+erp-kit app check --root examples
+
+# Check dependency licenses
+erp-kit license check --config license.config.json
 
-# Generate a new doc from template
-erp-kit scaffold --modules-root modules <type> <parent> [name]
+# List available license groups
+erp-kit license list
 
 # Start mock API servers
 erp-kit mock start
@@ -33,47 +44,98 @@ erp-kit mock validate
 
 ## Commands
 
-### `check`
+### `module`
 
-Validates markdown documentation against YAML schemas.
+Module documentation management.
+
+#### `module list`
+
+Lists all available modules with command, model, and feature counts.
 
 ```bash
-erp-kit check --modules-root modules
-erp-kit check --app-root examples
-erp-kit check --modules-root modules --app-root examples
+erp-kit module list
 ```
 
-### `sync-check`
+#### `module check`
 
-Ensures every source file has a corresponding doc and vice versa. Detects missing and orphaned documentation.
+Validates module markdown documentation against YAML schemas.
 
 ```bash
-erp-kit sync-check --modules-root modules
-erp-kit sync-check --app-root examples
+erp-kit module check --root src/modules
 ```
 
-### `scaffold`
+#### `module sync-check`
+
+Ensures every source file has a corresponding doc and vice versa.
+
+```bash
+erp-kit module sync-check --root src/modules
+```
+
+#### `module scaffold`
 
 Generates documentation files from schema templates.
 
-**Module types:**
+When the type is `module`, it also creates a starter `src/` directory with the following structure:
+
+```
+src/
+├── db/              (.gitkeep)
+├── command/         (.gitkeep)
+├── executor/        (.gitkeep)
+├── generated/       (.gitkeep)
+├── query/           (.gitkeep)
+├── lib/
+│   ├── errors.ts
+│   └── types.ts
+├── testing/
+│   └── fixtures.ts
+├── module.ts
+├── index.ts
+├── permissions.ts
+└── tailor.config.ts
+```
+
+Templates for these files are defined in `src/commands/scaffold-templates.ts`.
+
+```bash
+erp-kit module scaffold module inventory --root src/modules
+erp-kit module scaffold feature inventory stock-tracking --root src/modules
+erp-kit module scaffold command inventory createOrder --root src/modules
+erp-kit module scaffold model inventory StockItem --root src/modules
+```
+
+### `app`
+
+App-compose documentation management.
+
+#### `app check`
+
+Validates app documentation against YAML schemas.
+
+```bash
+erp-kit app check --root examples
+```
+
+#### `app sync-check`
+
+Ensures every source file has a corresponding doc and vice versa.
 
 ```bash
-erp-kit scaffold --modules-root modules module inventory
-erp-kit scaffold --modules-root modules feature inventory stock-tracking
-erp-kit scaffold --modules-root modules command inventory CreateOrder
-erp-kit scaffold --modules-root modules model inventory StockItem
+erp-kit app sync-check --root examples
 ```
 
-**App-compose types:**
+#### `app scaffold`
+
+Generates documentation files from schema templates.
 
 ```bash
-erp-kit scaffold --app-root examples requirements my-app
-erp-kit scaffold --app-root examples actors my-app admin
-erp-kit scaffold --app-root examples business-flow my-app onboarding
-erp-kit scaffold --app-root examples story my-app onboarding/admin--create-user
-erp-kit scaffold --app-root examples screen my-app supplier-list
-erp-kit scaffold --app-root examples resolver my-app create-supplier
+erp-kit app scaffold requirements my-app --root examples
+erp-kit app scaffold actors my-app admin --root examples
+erp-kit app scaffold business-flow my-app onboarding --root examples
+erp-kit app scaffold story my-app onboarding/admin--create-user --root examples
+erp-kit app scaffold screen my-app supplier-list --root examples
+erp-kit app scaffold resolver my-app create-supplier --root examples
 ```
 
 ### `mock start`
@@ -118,38 +180,78 @@ erp-kit mock validate
 erp-kit mock validate mocks/shopify/admin-api mocks/sendgrid/send-email
 ```
 
+### `license`
+
+License management. Uses [Google licenseclassifier](https://github.com/google/licenseclassifier) categories as built-in groups.
+
+#### `license list`
+
+Lists available license groups and their licenses.
+
+```bash
+erp-kit license list
+```
+
+#### `license check`
+
+Checks dependency licenses against a config-driven allowlist. Requires `pnpm` (uses `pnpm licenses list` under the hood).
+
+**Arguments:**
+
+- `-c, --config <path>` — Path to license config JSON file (required)
+
+```bash
+erp-kit license check --config license.config.json
+```
+
+**Config format:**
+
+```json
+{
+  "groups": ["reciprocal", "notice", "unencumbered"],
+  "allow": ["BlueOak-1.0.0", "WTFPL"],
+  "deny": ["BSD-4-Clause"]
+}
+```
+
+| Field    | Description                                                               |
+| -------- | ------------------------------------------------------------------------- |
+| `groups` | Built-in license groups to allow (`reciprocal`, `notice`, `unencumbered`) |
+| `allow`  | Additional individual licenses to allow                                   |
+| `deny`   | Licenses to exclude (applied after groups + allow)                        |
+
 ### `init`
 
 One-time setup for consumer repos. Idempotent — skips files that already exist.
 
 ```bash
 erp-kit init
+
+# Overwrite existing skills
+erp-kit init --force
 ```
 
 This will:
 
 1. Copy 12 agent skills to `.agents/skills/`
-2. Copy development rules to `.agents/rules/`
+2. Create symlink `.claude/skills` → `.agents/skills/`
 
 ## Options
 
-| Flag                    | Description                                               |
-| ----------------------- | --------------------------------------------------------- |
-| `--modules-root <path>` | Path to modules directory (required for module commands)  |
-| `--app-root <path>`     | Path to app-compose directory (required for app commands) |
-| `--mocks-root <path>`   | Path to mocks directory (default: `./mocks`)              |
-| `-p, --port <number>`   | Reverse proxy port for `mock start` (default: `3000`)     |
-
-At least one of `--modules-root` or `--app-root` is required for `check`, `sync-check`, and `scaffold`.
+| Flag                  | Alias | Applies to                                  | Description                                  |
+| --------------------- | ----- | ------------------------------------------- | -------------------------------------------- |
+| `--root <path>`       | `-r`  | `module check/sync-check/scaffold`, `app *` | Path to modules or app-compose directory     |
+| `--mocks-root <path>` |       | `mock start`, `mock validate`               | Path to mocks directory (default: `./mocks`) |
+| `--port <number>`     | `-p`  | `mock start`                                | Reverse proxy port (default: `3000`)         |
+| `--config <path>`     | `-c`  | `license`                                   | Path to license config JSON file             |
+| `--force`             | `-f`  | `init`                                      | Overwrite existing files (default: `false`)  |
 
 ## What's Bundled
 
-| Directory     | Contents                                                         |
-| ------------- | ---------------------------------------------------------------- |
-| `schemas/`    | YAML schema definitions for all doc types                        |
-| `sync-check/` | Source-to-doc mapping configs                                    |
-| `skills/`     | 12 agent skills for documentation, implementation, and mocking   |
-| `rules/`      | Development rules and best practices for modules and app-compose |
+| Directory  | Contents                                                       |
+| ---------- | -------------------------------------------------------------- |
+| `schemas/` | YAML schema definitions for all doc types                      |
+| `skills/`  | 12 agent skills for documentation, implementation, and mocking |
 
 ### Schemas
 
@@ -161,30 +263,24 @@ At least one of `--modules-root` or `--app-root` is required for `check`, `sync-
 
 Module workflow:
 
-1. `1-module-docs` — Create module documentation
-2. `2-module-feature-breakdown` — Break features into models and commands
-3. `3-module-doc-review` — Review feature-to-doc parity
-4. `4-module-tdd-implementation` — TDD implementation from docs
-5. `5-module-implementation-review` — Review implementation-to-doc parity
+1. `erp-kit-module-1-docs` — Create module documentation
+2. `erp-kit-module-2-feature-breakdown` — Break features into models and commands
+3. `erp-kit-module-3-doc-review` — Review feature-to-doc parity
+4. `erp-kit-module-4-tdd` — TDD implementation from docs
+5. `erp-kit-module-5-impl-review` — Review implementation-to-doc parity
 
 App-compose workflow:
 
-1. `app-compose-1-requirement-analysis` — Tier 1-2: requirements, actors, business flows
-2. `app-compose-2-requirements-breakdown` — Tier 3: stories and screens
-3. `app-compose-3-doc-review` — Review doc parity
-4. `app-compose-4-design-mock` — Create UI mockups from screen specs
-5. `app-compose-5-design-mock-review` — Review mockups against specs
-6. `app-compose-6-implementation-spec` — Tier 4: resolver specs
+1. `erp-kit-app-1-requirements` — Tier 1-2: requirements, actors, business flows
+2. `erp-kit-app-2-breakdown` — Tier 3: stories and screens
+3. `erp-kit-app-3-doc-review` — Review doc parity
+4. `erp-kit-app-4-design` — Create UI mockups from screen specs
+5. `erp-kit-app-5-design-review` — Review mockups against specs
+6. `erp-kit-app-6-impl-spec` — Tier 4: resolver specs
 
 Mock workflow:
 
-1. `mock-scenario` — Scaffold a new Mockoon mock scenario with CRUD routes and error scenarios
-
-### Development Rules
-
-- `module-development/` — Structure, commands, models, executors, testing, exports, errors
-- `app-compose/` — App structure, frontend screens, components, auth patterns
-- `sdk-best-practices/` — Database relations, SDK documentation references
+1. `erp-kit-mock-scenario` — Scaffold a new Mockoon mock scenario with CRUD routes and error scenarios
 
 ## Programmatic Mock Server