@techninja/clearstack 0.3.12 → 0.3.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +12 -11
  2. package/bin/cli.js +3 -1
  3. package/docs/QUICKSTART.md +6 -3
  4. package/package.json +1 -1
  5. package/templates/shared/docs/clearstack/QUICKSTART.md +6 -3
package/README.md CHANGED
@@ -29,17 +29,17 @@ A project/task tracker that exercises every pattern in the spec: API-backed enti
29
29
 
30
30
  ## Specification
31
31
 
32
- | Document | What It Covers |
33
- |---|---|
32
+ | Document | What It Covers |
33
+ | --------------------------------------------------------------------------- | -------------------------------------------------------------- |
34
34
  | [FRONTEND_IMPLEMENTATION_RULES.md](./docs/FRONTEND_IMPLEMENTATION_RULES.md) | Philosophy, framework choice, project structure, atomic design |
35
- | [COMPONENT_PATTERNS.md](./docs/COMPONENT_PATTERNS.md) | Authoring, light DOM, styling, layout engine, JSDoc typing |
36
- | [STATE_AND_ROUTING.md](./docs/STATE_AND_ROUTING.md) | Store, routing, unified app state, realtime SSE sync |
37
- | [CONVENTIONS.md](./docs/CONVENTIONS.md) | Naming rules, anti-patterns |
38
- | [SERVER_AND_DEPS.md](./docs/SERVER_AND_DEPS.md) | Express server, import maps, vendor dependency loading |
39
- | [BACKEND_API_SPEC.md](./docs/BACKEND_API_SPEC.md) | REST CRUD, JSON Schema via HEAD, entity management |
40
- | [TESTING.md](./docs/TESTING.md) | Testing philosophy, tools, patterns, phase checkpoints |
41
- | [BUILD_LOG.md](./docs/BUILD_LOG.md) | How this project was built — LLM-human collaboration proof |
42
- | [QUICKSTART.md](./docs/QUICKSTART.md) | Scaffolder setup, development workflow, updating, compliance |
35
+ | [COMPONENT_PATTERNS.md](./docs/COMPONENT_PATTERNS.md) | Authoring, light DOM, styling, layout engine, JSDoc typing |
36
+ | [STATE_AND_ROUTING.md](./docs/STATE_AND_ROUTING.md) | Store, routing, unified app state, realtime SSE sync |
37
+ | [CONVENTIONS.md](./docs/CONVENTIONS.md) | Naming rules, anti-patterns |
38
+ | [SERVER_AND_DEPS.md](./docs/SERVER_AND_DEPS.md) | Express server, import maps, vendor dependency loading |
39
+ | [BACKEND_API_SPEC.md](./docs/BACKEND_API_SPEC.md) | REST CRUD, JSON Schema via HEAD, entity management |
40
+ | [TESTING.md](./docs/TESTING.md) | Testing philosophy, tools, patterns, phase checkpoints |
41
+ | [BUILD_LOG.md](./docs/BUILD_LOG.md) | How this project was built — LLM-human collaboration proof |
42
+ | [QUICKSTART.md](./docs/QUICKSTART.md) | Scaffolder setup, development workflow, updating, compliance |
43
43
 
44
44
  ## Using Clearstack
45
45
 
@@ -48,7 +48,8 @@ Install as a dev dependency, scaffold, and keep in sync:
48
48
  ```bash
49
49
  npm install -D @techninja/clearstack # add to your project
50
50
  npx clearstack init # scaffold (interactive)
51
- npx clearstack init -y # scaffold (defaults)
51
+ npx clearstack init -y # scaffold (fullstack defaults)
52
+ npx clearstack init --static # scaffold (static, no server)
52
53
  npm run spec # check compliance
53
54
  npm run spec:update # sync docs + configs on upgrade
54
55
  ```
package/bin/cli.js CHANGED
@@ -3,7 +3,7 @@
3
3
  /**
4
4
  * clearstack CLI — scaffold, update, and check spec-compliant projects.
5
5
  * Usage:
6
- * clearstack init [-y] [--mode fullstack|static] [--port 3000]
6
+ * clearstack init [-y] [--static|--fullstack] [--port 3000]
7
7
  * clearstack update
8
8
  * clearstack check [code|docs|imports|lint|lint es|format|types|audit|all]
9
9
  * clearstack → interactive menu
@@ -22,6 +22,8 @@ const flags = Object.fromEntries(
22
22
  }),
23
23
  );
24
24
  const yes = args.includes('-y') || args.includes('--yes');
25
+ if (flags.static) flags.mode = 'static';
26
+ if (flags.fullstack) flags.mode = 'fullstack';
25
27
 
26
28
  /** Show interactive menu. */
27
29
  async function interactive() {
package/docs/QUICKSTART.md CHANGED
@@ -22,8 +22,10 @@ pnpm add -D @techninja/clearstack
22
22
  From your project root:
23
23
 
24
24
  ```bash
25
- npx clearstack init # interactive
26
- npx clearstack init -y # non-interactive (defaults)
25
+ npx clearstack init # interactive
26
+ npx clearstack init -y # non-interactive (fullstack defaults)
27
+ npx clearstack init --static # non-interactive, static mode
28
+ npx clearstack init -y --static # same as above
27
29
  ```
28
30
 
29
31
  The interactive prompt asks for:
@@ -159,7 +161,8 @@ spec:code → spec:docs → lint → format → typecheck → test
159
161
  | Task | Command |
160
162
  | --------------------- | -------------------------------------- |
161
163
  | Install Clearstack | `npm install -D @techninja/clearstack` |
162
- | Scaffold a project | `npx clearstack init` |
164
+ | Scaffold (fullstack) | `npx clearstack init` |
165
+ | Scaffold (static) | `npx clearstack init --static` |
163
166
  | Install dependencies | `npm install` |
164
167
  | Start dev server | `npm run dev` |
165
168
  | Lint + format | `npm run lint:fix && npm run format` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@techninja/clearstack",
3
- "version": "0.3.12",
3
+ "version": "0.3.13",
4
4
  "type": "module",
5
5
  "description": "A no-build web component framework specification — scaffold, validate, and evolve spec-compliant projects",
6
6
  "bin": {
package/templates/shared/docs/clearstack/QUICKSTART.md CHANGED
@@ -22,8 +22,10 @@ pnpm add -D @techninja/clearstack
22
22
  From your project root:
23
23
 
24
24
  ```bash
25
- npx clearstack init # interactive
26
- npx clearstack init -y # non-interactive (defaults)
25
+ npx clearstack init # interactive
26
+ npx clearstack init -y # non-interactive (fullstack defaults)
27
+ npx clearstack init --static # non-interactive, static mode
28
+ npx clearstack init -y --static # same as above
27
29
  ```
28
30
 
29
31
  The interactive prompt asks for:
@@ -159,7 +161,8 @@ spec:code → spec:docs → lint → format → typecheck → test
159
161
  | Task | Command |
160
162
  | --------------------- | -------------------------------------- |
161
163
  | Install Clearstack | `npm install -D @techninja/clearstack` |
162
- | Scaffold a project | `npx clearstack init` |
164
+ | Scaffold (fullstack) | `npx clearstack init` |
165
+ | Scaffold (static) | `npx clearstack init --static` |
163
166
  | Install dependencies | `npm install` |
164
167
  | Start dev server | `npm run dev` |
165
168
  | Lint + format | `npm run lint:fix && npm run format` |