lean-spec 0.1.1 → 0.1.3

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.
package/CHANGELOG.md CHANGED
@@ -7,6 +7,123 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ## [0.1.3] - 2025-11-10
11
+
12
+ ### Added
13
+
14
+ **New Commands:**
15
+ - `lean-spec migrate` - Migrate from existing tools (ADRs, RFCs, design docs) with AI assistance
16
+ - `lean-spec archive` - Archive completed specs with automatic frontmatter updates
17
+ - `lean-spec backfill` - Backfill timestamps and metadata from git history
18
+
19
+ **Documentation Enhancements:**
20
+ - Complete documentation site overhaul with improved information architecture
21
+ - AI-assisted spec writing guide with philosophy and best practices
22
+ - Migration guides for teams coming from ADRs, RFCs, and other tools
23
+ - First principles documentation (Context Economy, Signal-to-Noise, etc.)
24
+ - Comprehensive core concepts guide with practical examples
25
+
26
+ **Quality & Validation:**
27
+ - Enhanced `lean-spec validate` with complexity analysis
28
+ - Spec relationship clarity with bidirectional `related` and directional `depends_on`
29
+ - Improved frontmatter handling and metadata management
30
+
31
+ ### Changed
32
+
33
+ **User Experience:**
34
+ - Unified dashboard combining board view with project health metrics
35
+ - Pattern-aware list grouping with visual icons and better organization
36
+ - Improved init flow with pattern selection
37
+ - Enhanced stats dashboard with actionable insights
38
+ - Better MCP error handling and stability
39
+
40
+ **Documentation:**
41
+ - Restructured docs with clearer navigation and information flow
42
+ - Updated README with AI-first positioning
43
+ - Comprehensive examples and use cases
44
+ - Improved CLI command documentation
45
+
46
+ ### Fixed
47
+ - MCP server stability issues with frontmatter parsing
48
+ - TypeScript type errors in migrate command
49
+ - Documentation accuracy issues across all guides
50
+ - Frontmatter handling edge cases
51
+
52
+ ### Philosophy
53
+
54
+ This UAT release operationalizes LeanSpec's five first principles:
55
+ 1. **Context Economy** - Specs fit in working memory (<400 lines)
56
+ 2. **Signal-to-Noise** - Every word informs decisions
57
+ 3. **Intent Over Implementation** - Capture why, not just how
58
+ 4. **Bridge the Gap** - Both human and AI understand
59
+ 5. **Progressive Disclosure** - Add complexity only when needed
60
+
61
+ **Notable Completed Specs in this Release:**
62
+ - 063: Migration from existing tools
63
+ - 062: Documentation information architecture v2
64
+ - 061: AI-assisted spec writing
65
+ - 060: Core concepts coherence
66
+ - 058: Docs overview polish
67
+ - 057: Docs validation comprehensive
68
+ - 056: Docs site accuracy audit
69
+ - 055: README redesign (AI-first)
70
+ - 054: Validate output (lint-style)
71
+ - 052: Branding assets
72
+ - 051: First principles documentation
73
+ - 049: LeanSpec first principles foundation
74
+ - 048: Spec complexity analysis
75
+ - 047: Git backfill timestamps
76
+ - 046: Stats dashboard refactor
77
+ - 045: Unified dashboard
78
+ - 044: Spec relationships clarity
79
+
80
+ **Testing:**
81
+ - All 261 tests passing (100% pass rate)
82
+ - Zero critical bugs
83
+ - MCP server stable
84
+ - Documentation site builds cleanly
85
+
86
+ **Ready for:** UAT testing before official 0.2.0 launch
87
+
88
+ ## [0.1.2] - 2025-11-10
89
+
90
+ ### Changed
91
+
92
+ **BREAKING: Command and directory naming migration**
93
+ - **Command name**: `lspec` → `lean-spec` (full name for clarity and consistency)
94
+ - **Config directory**: `.lspec/` → `.lean-spec/` (matches package and command name)
95
+ - **Binary**: Only `lean-spec` command available (removed `lspec` alias)
96
+
97
+ **Benefits:**
98
+ - ✅ Consistency: Package name, command, and config directory all use `lean-spec`
99
+ - ✅ Clarity: `npx lean-spec` works immediately (matches npm package name)
100
+ - ✅ Simplicity: Single command to remember, no abbreviations
101
+
102
+ **Migration Guide for Existing Users:**
103
+
104
+ 1. **Uninstall old version:**
105
+ ```bash
106
+ npm uninstall -g lean-spec
107
+ ```
108
+
109
+ 2. **Install new version:**
110
+ ```bash
111
+ npm install -g lean-spec
112
+ ```
113
+
114
+ 3. **Update existing projects:**
115
+ ```bash
116
+ # Rename config directory
117
+ mv .lspec .lean-spec
118
+ ```
119
+
120
+ 4. **Update commands:**
121
+ - Old: `lspec init` → New: `lean-spec init`
122
+ - Old: `lspec board` → New: `lean-spec board`
123
+ - Old: `npx lspec` → New: `npx lean-spec`
124
+
125
+ **All documentation, examples, and specs updated to reflect new naming.**
126
+
10
127
  ## [0.1.1] - 2025-11-07
11
128
 
12
129
  ### Changed
@@ -88,5 +205,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
205
  - Gray-matter for frontmatter parsing
89
206
  - Dayjs for date handling
90
207
 
208
+ [0.1.3]: https://github.com/codervisor/lean-spec/releases/tag/v0.1.3
209
+ [0.1.2]: https://github.com/codervisor/lean-spec/releases/tag/v0.1.2
91
210
  [0.1.1]: https://github.com/codervisor/lean-spec/releases/tag/v0.1.1
92
211
  [0.1.0]: https://github.com/codervisor/lean-spec/releases/tag/v0.1.0
package/README.md CHANGED
@@ -31,7 +31,7 @@ Specs under 300 lines. Intent-focused. Machine-readable. Adapts to your workflow
31
31
  <p align="center">
32
32
  <a href="#quick-start-5-minutes"><strong>Quick Start (5 Minutes) →</strong></a> •
33
33
  <a href="https://www.lean-spec.dev"><strong>Documentation</strong></a> •
34
- <a href="https://www.lean-spec.dev/docs/examples"><strong>Examples</strong></a>
34
+ <a href="https://www.lean-spec.dev/docs/guide/ai-executable-patterns"><strong>Examples</strong></a>
35
35
  </p>
36
36
 
37
37
  ---
@@ -98,7 +98,7 @@ priority: high
98
98
  # Unified Dashboard
99
99
 
100
100
  ## Overview
101
- Combine `lspec board` and `lspec stats` into a single, comprehensive
101
+ Combine `lean-spec board` and `lean-spec stats` into a single, comprehensive
102
102
  project health view. Give users instant insight into project status,
103
103
  bottlenecks, and team velocity.
104
104
 
@@ -136,9 +136,10 @@ LeanSpec isn't arbitrary rules—it's derived from fundamental constraints of wo
136
136
  ### 🧠 Context Economy
137
137
  **Specs <300 lines → Fit in working memory**
138
138
 
139
- - **Physics**: AI context windows are bounded (~20K effective tokens)
140
- - **Biology**: Human working memory is limited (7±2 items)
139
+ - **Physics**: AI performance degrades with longer context (quality drops beyond 50K tokens despite 200K limits)
140
+ - **Biology**: Human working memory is limited (7±2 items, 5-10 min attention)
141
141
  - **Economics**: Large contexts cost more time and money
142
+ - **Reality**: Attention is the scarce resource, not storage
142
143
  - **Result**: Keep specs under 300 lines, split complex features
143
144
 
144
145
  ### ✂️ Signal-to-Noise Maximization
@@ -177,7 +178,7 @@ LeanSpec isn't arbitrary rules—it's derived from fundamental constraints of wo
177
178
 
178
179
  **These aren't preferences—they're constraints.** Physics (context windows), biology (working memory), and economics (token costs) dictate what works.
179
180
 
180
- 📖 [Deep dive: First Principles Guide →](https://www.lean-spec.dev/docs/guide/first-principles)
181
+ 📖 [Deep dive: First Principles Guide →](https://www.lean-spec.dev/docs/guide/understanding#the-five-first-principles)
181
182
 
182
183
  ---
183
184
 
@@ -199,7 +200,7 @@ MCP-native specs. Works with any tool that supports Model Context Protocol.
199
200
  Track progress without leaving the terminal:
200
201
 
201
202
  ```bash
202
- $ lspec board
203
+ $ lean-spec board
203
204
 
204
205
  📋 Spec Kanban Board
205
206
 
@@ -219,7 +220,7 @@ $ lspec board
219
220
  ```
220
221
 
221
222
  ```bash
222
- $ lspec stats
223
+ $ lean-spec stats
223
224
 
224
225
  📊 Project Stats
225
226
 
@@ -271,7 +272,7 @@ Custom fields fully supported. Adapts to your workflow as you grow.
271
272
  ```bash
272
273
  npm install -g lean-spec
273
274
  cd your-project
274
- lspec init
275
+ lean-spec init
275
276
  ```
276
277
 
277
278
  ### 2. Work with Your AI Tool
@@ -281,7 +282,7 @@ lspec init
281
282
  ```
282
283
  👤 You: "Create a spec for user authentication with OAuth2."
283
284
 
284
- 🤖 AI: [runs lspec create user-authentication]
285
+ 🤖 AI: [runs lean-spec create user-authentication]
285
286
  "I've created specs/001-user-authentication/README.md.
286
287
  Here's the spec..."
287
288
 
@@ -295,19 +296,19 @@ lspec init
295
296
 
296
297
  ```bash
297
298
  # Check project status
298
- lspec board
299
+ lean-spec board
299
300
 
300
301
  # View spec with AI-friendly output
301
- lspec view user-authentication --json
302
+ lean-spec view user-authentication --json
302
303
 
303
304
  # Update status as you progress
304
- lspec update user-authentication --status in-progress
305
+ lean-spec update user-authentication --status in-progress
305
306
  ```
306
307
 
307
308
  **The workflow:**
308
- 1. ✅ Ask AI to create spec (it uses `lspec create`)
309
+ 1. ✅ Ask AI to create spec (it uses `lean-spec create`)
309
310
  2. ✅ AI reads spec and implements (spec fits in context)
310
- 3. ✅ Track with `lspec board` / `lspec stats`
311
+ 3. ✅ Track with `lean-spec board` / `lean-spec stats`
311
312
  4. ✅ Update status as work progresses
312
313
 
313
314
  **Why this works:**
@@ -317,9 +318,9 @@ lspec update user-authentication --status in-progress
317
318
  - You drive, AI executes
318
319
 
319
320
  **Next steps:**
320
- - 📘 [Full CLI Reference](https://www.lean-spec.dev/docs/cli-reference) - All commands
321
- - 🎨 [Choose a Template](https://www.lean-spec.dev/docs/templates) - Minimal, standard, or enterprise
322
- - 🤖 [AI Agent Setup](AGENTS.md) - Configure Cursor, Claude, Aider
321
+ - 📘 [Full CLI Reference](https://www.lean-spec.dev/docs/reference/cli) - All commands
322
+ - 🎨 [Choose a Template](https://www.lean-spec.dev/docs/guide/templates) - Minimal, standard, or enterprise
323
+ - 🤖 [AI Agent Setup](AGENTS.md) - Configure AI coding tools
323
324
 
324
325
  ---
325
326
 
@@ -387,24 +388,24 @@ We dogfood our own methodology. Specs that fit in AI context enable the velocity
387
388
  ## Learn More
388
389
 
389
390
  ### 📚 Documentation
390
- - [Getting Started Guide](https://www.lean-spec.dev/docs/getting-started) - Complete setup walkthrough
391
- - [First Principles](https://www.lean-spec.dev/docs/guide/first-principles) - The philosophy behind LeanSpec
392
- - [CLI Reference](https://www.lean-spec.dev/docs/cli-reference) - All commands with examples
391
+ - [Getting Started Guide](https://www.lean-spec.dev/docs/guide/getting-started) - Complete setup walkthrough
392
+ - [First Principles](https://www.lean-spec.dev/docs/guide/understanding#the-five-first-principles) - The philosophy behind LeanSpec
393
+ - [CLI Reference](https://www.lean-spec.dev/docs/reference/cli) - All commands with examples
393
394
 
394
395
  ### 🛠️ Integrations
395
396
  - [AI Agent Configuration](AGENTS.md) - Cursor, Copilot, Aider setup
396
397
  - [MCP Server](docs/MCP-SERVER.md) - Claude Desktop integration
397
- - [VS Code Extension](https://www.lean-spec.dev/docs/tools/vscode) - Enhanced editor support
398
+ - [VS Code Extension](https://www.lean-spec.dev/docs/roadmap#vs-code-extension) - Enhanced editor support (planned)
398
399
 
399
400
  ### 🎓 Guides
400
401
  - [Custom Fields](https://www.lean-spec.dev/docs/guide/custom-fields) - Adapt to your workflow
401
- - [Sub-Specs](https://www.lean-spec.dev/docs/guide/sub-specs) - Manage complex features
402
- - [Folder Structure](https://www.lean-spec.dev/docs/guide/folder-structure) - Organize your specs
402
+ - [Templates](https://www.lean-spec.dev/docs/guide/templates) - Choose the right structure
403
+ - [Frontmatter](https://www.lean-spec.dev/docs/guide/frontmatter) - Metadata and organization
403
404
 
404
405
  ### 🤝 Community
405
406
  - [GitHub Issues](https://github.com/codervisor/lean-spec/issues) - Report bugs or request features
406
407
  - [Contributing Guide](CONTRIBUTING.md) - Join the project
407
- - [Examples](https://www.lean-spec.dev/docs/examples) - Real-world usage patterns
408
+ - [AI-Executable Patterns](https://www.lean-spec.dev/docs/guide/ai-executable-patterns) - Real-world usage patterns
408
409
 
409
410
  ---
410
411