@leanspec/ui 0.2.6 → 0.2.7-dev.20251126090057

package/.next/standalone/packages/ui/dist/standalone/specs/018-spec-validation/CONFIGURATION-EXAMPLES.md

@@ -1,230 +0,0 @@
-# Configuration Examples
-
-> Part of spec: [018-spec-validation](README.md)
-
-Configuration examples for different use cases of `lean-spec validate`.
-
-## Strict Mode (CI/CD)
-
-Use for production/CI environments where you want maximum validation:
-
-```json
-{
-  "validate": {
-    "mode": "comprehensive",
-    "autoValidate": false,
-    "rules": {
-      "frontmatter": {
-        "required": ["status", "created", "priority"],
-        "allowedStatus": ["planned", "in-progress", "complete", "archived"],
-        "allowedPriority": ["low", "medium", "high", "critical"]
-      },
-      "structure": {
-        "requireReadme": true,
-        "requiredSections": ["Overview", "Design", "Plan", "Test"],
-        "forbidEmptySections": true
-      },
-      "content": {
-        "minLength": 200,
-        "forbidTodoInComplete": true,
-        "validateLinks": true
-      },
-      "corruption": {
-        "detectDuplicateSections": true,
-        "validateCodeBlocks": true,
-        "validateJsonYaml": true,
-        "detectFragments": true
-      },
-      "staleness": {
-        "inProgressMaxDays": 30,
-        "noUpdateMaxDays": 90,
-        "plannedMaxDays": 60
-      }
-    }
-  },
-  "ignorePaths": [
-    "archived/**",
-    "drafts/**"
-  ]
-}
-```
-
-## Relaxed Mode (Early Development)
-
-Use for early-stage projects or rapid prototyping:
-
-```json
-{
-  "validate": {
-    "mode": "quick",
-    "autoValidate": false,
-    "rules": {
-      "frontmatter": {
-        "required": ["status"],
-        "allowedStatus": ["planned", "in-progress", "complete", "archived"]
-      },
-      "structure": {
-        "requireReadme": true,
-        "requiredSections": [],
-        "forbidEmptySections": false
-      },
-      "content": {
-        "minLength": 50,
-        "forbidTodoInComplete": false,
-        "validateLinks": false
-      },
-      "corruption": {
-        "detectDuplicateSections": true,
-        "validateCodeBlocks": false,
-        "validateJsonYaml": false,
-        "detectFragments": false
-      },
-      "staleness": {
-        "inProgressMaxDays": 90,
-        "noUpdateMaxDays": 180,
-        "plannedMaxDays": 120
-      }
-    }
-  }
-}
-```
-
-## Custom Workflow (Sprint-Based)
-
-Example for teams using sprint-based workflow:
-
-```json
-{
-  "validate": {
-    "mode": "comprehensive",
-    "rules": {
-      "frontmatter": {
-        "required": ["status", "created", "team", "sprint"],
-        "allowedStatus": ["backlog", "sprint", "review", "done"],
-        "allowedPriority": ["p0", "p1", "p2", "p3"]
-      },
-      "structure": {
-        "requiredSections": ["Problem", "Solution", "Acceptance Criteria"],
-        "forbidEmptySections": true
-      },
-      "content": {
-        "minLength": 150,
-        "forbidTodoInComplete": true,
-        "validateLinks": true
-      }
-    }
-  },
-  "ignorePaths": [
-    "archived/**",
-    "experiments/**"
-  ]
-}
-```
-
-## Minimal Configuration
-
-Bare minimum for validation (uses most defaults):
-
-```json
-{
-  "validate": {
-    "mode": "quick"
-  }
-}
-```
-
-## Feature-Specific Examples
-
-### Enforce Custom Fields
-
-```json
-{
-  "validate": {
-    "rules": {
-      "frontmatter": {
-        "required": ["status", "created", "owner", "cost_estimate"],
-        "customFields": {
-          "owner": { "type": "string", "pattern": "^[a-z]+$" },
-          "cost_estimate": { "type": "number", "min": 0 }
-        }
-      }
-    }
-  }
-}
-```
-
-### Template-Specific Validation
-
-```json
-{
-  "validate": {
-    "templateRules": {
-      "feature": {
-        "requiredSections": ["Use Cases", "Technical Design", "Rollout Plan"]
-      },
-      "bug": {
-        "requiredSections": ["Root Cause", "Fix", "Prevention"]
-      },
-      "spike": {
-        "requiredSections": ["Questions", "Findings", "Recommendation"]
-      }
-    }
-  }
-}
-```
-
-### Ignore Patterns
-
-```json
-{
-  "validate": {
-    "mode": "comprehensive"
-  },
-  "ignorePaths": [
-    "archived/**",
-    "drafts/**",
-    "experiments/**",
-    "**/*.backup.md",
-    "temp-*/**"
-  ]
-}
-```
-
-## Usage with Examples
-
-### Apply Strict Mode
-
-```bash
-# Add to .lean-spec/config.json, then run:
-lean-spec validate
-
-# Or override via CLI:
-lean-spec validate --mode comprehensive
-```
-
-### Apply Relaxed Mode
-
-```bash
-# Use during early development:
-lean-spec validate --mode quick
-
-# Or with specific rules disabled:
-lean-spec validate --no-links --no-staleness
-```
-
-### Custom Workflow
-
-```bash
-# Configure custom status values:
-# .lean-spec/config.json with custom allowedStatus
-# Then validate normally:
-lean-spec validate
-```
-
-## Tips
-
-1. **Start relaxed, tighten gradually** - Begin with `quick` mode, add rules as project matures
-2. **Use strict mode in CI** - Catch issues before merge
-3. **Customize for your workflow** - Adapt `allowedStatus` and `requiredSections` to match your process
-4. **Use ignore paths wisely** - Don't validate archived or experimental specs
-5. **Test configuration** - Run `lean-spec validate --dry-run` to preview changes

package/.next/standalone/packages/ui/dist/standalone/specs/018-spec-validation/CONFIGURATION.md

@@ -1,285 +0,0 @@
-# Configuration
-
-Configuration options for the `lean-spec validate` command.
-
-> See [CONFIGURATION-EXAMPLES.md](./CONFIGURATION-EXAMPLES.md) for practical examples
-
-## Configuration File
-
-Configuration is stored in `.lean-spec/config.json`:
-
-```json
-{
-  "validate": {
-    "mode": "comprehensive",
-    "rules": { /* rule configuration */ }
-  },
-  "ignorePaths": ["archived/**"]
-}
-```
-
-## Complete Schema
-
-```json
-{
-  "validate": {
-    "mode": "comprehensive",
-    "autoValidate": false,
-    "rules": {
-      "frontmatter": {
-        "required": ["status", "created"],
-        "allowedStatus": ["planned", "in-progress", "complete", "archived"],
-        "allowedPriority": ["low", "medium", "high", "critical"]
-      },
-      "structure": {
-        "requireReadme": true,
-        "requiredSections": ["Overview", "Design", "Plan"],
-        "forbidEmptySections": true
-      },
-      "content": {
-        "minLength": 100,
-        "forbidTodoInComplete": true,
-        "validateLinks": true
-      },
-      "corruption": {
-        "detectDuplicateSections": true,
-        "validateCodeBlocks": true,
-        "validateJsonYaml": true,
-        "detectFragments": true
-      },
-      "staleness": {
-        "inProgressMaxDays": 30,
-        "noUpdateMaxDays": 90,
-        "plannedMaxDays": 60
-      }
-    }
-  },
-  "ignorePaths": ["archived/**"]
-}
-```
-
-## Configuration Options
-
-### Validation Mode
-
-```json
-{
-  "validate": {
-    "mode": "comprehensive"  // or "quick"
-  }
-}
-```
-
-**Modes:**
-- `"comprehensive"` - All validations (default)
-- `"quick"` - Basic checks only (faster)
-
-### Frontmatter Rules
-
-```json
-{
-  "validate": {
-    "rules": {
-      "frontmatter": {
-        "required": ["status", "created"],
-        "allowedStatus": ["planned", "in-progress", "complete", "archived"],
-        "allowedPriority": ["low", "medium", "high", "critical"]
-      }
-    }
-  }
-}
-```
-
-**Options:**
-- `required` - Required frontmatter fields (array of strings)
-- `allowedStatus` - Valid status values (array of strings)
-- `allowedPriority` - Valid priority values (array of strings)
-
-### Structure Rules
-
-```json
-{
-  "validate": {
-    "rules": {
-      "structure": {
-        "requireReadme": true,
-        "requiredSections": ["Overview", "Design", "Plan"],
-        "forbidEmptySections": true
-      }
-    }
-  }
-}
-```
-
-**Options:**
-- `requireReadme` - Spec must have README.md (boolean)
-- `requiredSections` - Section headers that must exist (array of strings)
-- `forbidEmptySections` - Empty sections are invalid (boolean)
-
-### Content Rules
-
-```json
-{
-  "validate": {
-    "rules": {
-      "content": {
-        "minLength": 100,
-        "forbidTodoInComplete": true,
-        "validateLinks": true
-      }
-    }
-  }
-}
-```
-
-**Options:**
-- `minLength` - Minimum character count (number)
-- `forbidTodoInComplete` - No TODO/FIXME in complete specs (boolean)
-- `validateLinks` - Check internal links are valid (boolean)
-
-### Corruption Detection
-
-```json
-{
-  "validate": {
-    "rules": {
-      "corruption": {
-        "detectDuplicateSections": true,
-        "validateCodeBlocks": true,
-        "validateJsonYaml": true,
-        "detectFragments": true
-      }
-    }
-  }
-}
-```
-
-**Options:**
-- `detectDuplicateSections` - Find duplicate section headers (boolean)
-- `validateCodeBlocks` - Check code blocks are properly closed (boolean)
-- `validateJsonYaml` - Validate JSON/YAML syntax (boolean)
-- `detectFragments` - Find duplicated content fragments (boolean)
-
-### Staleness Rules
-
-```json
-{
-  "validate": {
-    "rules": {
-      "staleness": {
-        "inProgressMaxDays": 30,
-        "noUpdateMaxDays": 90,
-        "plannedMaxDays": 60
-      }
-    }
-  }
-}
-```
-
-**Options:**
-- `inProgressMaxDays` - Days before warning on in-progress specs (number)
-- `noUpdateMaxDays` - Days before warning on stale specs (number)
-- `plannedMaxDays` - Days before warning on old planned specs (number)
-
-## Ignore Paths
-
-```json
-{
-  "ignorePaths": [
-    "archived/**",
-    "experiments/**",
-    "drafts/**"
-  ]
-}
-```
-
-Glob patterns to exclude from validation:
-- `archived/**` - Ignore all archived specs
-- `**/OLD_*.md` - Ignore files starting with OLD_
-- `experiments/` - Ignore entire directory
-
-## Configuration Precedence
-
-1. **Command-line flags** (highest priority)
-2. **Project config** (`.lean-spec/config.json`)
-3. **Built-in defaults** (lowest priority)
-
-Example:
-```bash
-# CLI flag overrides config
-lean-spec validate --mode quick
-```
-
-## Default Configuration
-
-If no configuration file exists:
-
-```json
-{
-  "validate": {
-    "mode": "comprehensive",
-    "autoValidate": false,
-    "rules": {
-      "frontmatter": {
-        "required": ["status", "created"],
-        "allowedStatus": ["planned", "in-progress", "complete", "archived"]
-      },
-      "structure": {
-        "requireReadme": true,
-        "requiredSections": [],
-        "forbidEmptySections": false
-      },
-      "content": {
-        "minLength": 0,
-        "forbidTodoInComplete": false,
-        "validateLinks": false
-      },
-      "corruption": {
-        "detectDuplicateSections": true,
-        "validateCodeBlocks": true,
-        "validateJsonYaml": false,
-        "detectFragments": false
-      },
-      "staleness": {
-        "inProgressMaxDays": 90,
-        "noUpdateMaxDays": 180,
-        "plannedMaxDays": 120
-      }
-    }
-  },
-  "ignorePaths": []
-}
-```
-
-## Quick Reference
-
-### Common Configurations
-
-**Strict (CI/CD):**
-```json
-{
-  "validate": {
-    "mode": "comprehensive",
-    "rules": {
-      "content": { "minLength": 200, "forbidTodoInComplete": true },
-      "structure": { "forbidEmptySections": true },
-      "staleness": { "inProgressMaxDays": 14 }
-    }
-  }
-}
-```
-
-**Relaxed (Development):**
-```json
-{
-  "validate": {
-    "mode": "quick",
-    "rules": {
-      "content": { "minLength": 50 },
-      "staleness": { "inProgressMaxDays": 90 }
-    }
-  }
-}
-```
-
-See [CONFIGURATION-EXAMPLES.md](./CONFIGURATION-EXAMPLES.md) for more examples.