openlore 2.0.0

package/examples/opencode-skills/openlore-execute-refactor/SKILL.md

@@ -0,0 +1,241 @@
+---
+name: openlore-execute-refactor
+description: Apply the refactoring plan produced by openlore-plan-refactor. Reads .openlore/refactor-plan.md and re-reads it before each change to stay on track. Requires a confirmed plan to exist before running.
+license: MIT
+compatibility: openlore MCP server
+---
+
+# openlore: Execute Refactor
+
+## When to use this skill
+
+Trigger this skill when the user asks to **apply a refactoring plan**, with phrasings like:
+- "apply the refactor plan"
+- "execute the planned refactoring"
+- explicit command `/openlore-execute-refactor`
+
+**Prerequisite**: the `openlore-plan-refactor` skill must have been run and the plan confirmed.
+The file `.openlore/refactor-plan.md` must exist.
+
+---
+
+## ⚠️ Fundamental principle — each change is a complete mini-development
+
+Each change in the plan is treated as an **independent, self-contained development unit**.
+The cycle for every single change, without exception:
+
+```
+READ plan entry
+  → EDIT  (targeted tool, ≤ 50 lines touched)
+  → DIFF  (git diff --stat + git diff — verify no lost code)
+  → TEST  (run the test gate from the plan)
+     ├─ green → mark ✅ in plan, move to next change
+     └─ red   → git checkout HEAD -- <file>
+                diagnose the failure
+                retry from EDIT (attempt 2, then 3)
+                if still red after 3 attempts → STOP (see circuit-breaker below)
+```
+
+**Never accumulate broken state. Never skip the test gate. Never batch two changes before testing.**
+
+### Circuit-breaker — 3 failed attempts
+
+If a change fails its test gate 3 times in a row, stop immediately and report:
+
+> "Change N (`<label>`) failed after 3 attempts. The working tree has been restored to the last green state.
+> Options:
+> a) Split this change into smaller sub-changes (≤ 50 lines each) and update the plan
+> b) Return to planning (`/openlore-plan-refactor`) to redesign this step
+> c) Skip this change and continue — note the acceptance criteria may not be fully met"
+
+Do not attempt a 4th retry without explicit user instruction.
+
+---
+
+## Step 1 — Read the plan
+
+Read `.openlore/refactor-plan.md` from the project directory.
+
+If the file does not exist, stop immediately:
+> "No refactor plan found at `.openlore/refactor-plan.md`. Please run `/openlore-plan-refactor` first."
+
+Extract and display a summary:
+- Target function, file, and line range
+- Strategy and risk score
+- Number of changes planned
+- Test command
+- Acceptance criteria
+
+**Ask the user to confirm before proceeding.**
+
+> **Execution mode**: once confirmed, execute all changes in the plan **without asking for permission between steps**. The only valid reasons to pause mid-execution are: (a) a test fails and 3 retries are exhausted (circuit-breaker), (b) you detect potentially lost code (`git diff` shows far more deletions than additions with no new file created), or (c) Step 6 is explicitly requested. Any other pause is non-compliant with this skill.
+
+---
+
+## Step 2 — Establish a green baseline
+
+Confirm the test suite is passing using the test command from the plan.
+
+**If tests are already failing, stop and tell the user. Under no circumstances continue on a red baseline — not even if the failures appear pre-existing.** Pre-existing failures must be fixed or explicitly acknowledged in the plan before any refactoring starts. Do not offer to "proceed at your own risk" on a red baseline.
+
+If a coverage tool is available, run it on the target file and compare against the coverage baseline in the plan.
+
+**Coverage thresholds:**
+
+| Coverage on files to touch | Recommendation |
+|---|---|
+| ≥ 70% lines | Safe — proceed |
+| 40–69% lines | Caution — write characterisation tests first |
+| < 40% lines | **Stop.** Strongly recommend writing tests first |
+| 0% (no tests) | **Blocked.** Propose a minimal test harness, then restart |
+
+If coverage is below 40%:
+> "Coverage on the target file is X%. Refactoring without test coverage risks introducing silent regressions. Would you like me to suggest test cases based on the function signatures, or do you want to proceed at your own risk?"
+
+Only continue past this point with **explicit user confirmation**.
+
+**Large file warning**: if the target function spans more than 300 lines:
+> "This function is X lines long. Small models may lose code when editing files of this size in a single pass. The plan must decompose each change to ≤ 50 lines. Verify the plan respects this before continuing."
+
+---
+
+## Step 3 — Set the restore point
+
+Verify the working tree is clean:
+
+```bash
+git status            # must show: nothing to commit, working tree clean
+git log --oneline -1  # note this commit hash — your restore point
+```
+
+If there are uncommitted changes, stop and ask the user to commit or stash them first.
+
+Fill in the `Restore point` section of `.openlore/refactor-plan.md` with the current commit hash.
+
+---
+
+## Step 4 — Apply changes (mini-development loop)
+
+For **each change** in the plan, execute the full mini-development cycle below.
+Do not move to the next change until the current one is marked ✅.
+
+### Before each change
+
+Re-read `.openlore/refactor-plan.md` to confirm:
+- Which change you are on (check for ✅ markers)
+- Exactly what to extract, where to put it, and which call sites to update
+- The test gate command for this specific change
+
+### Editing tool rule
+
+Always prefer a targeted edit tool over a full-file rewrite. Only use a full rewrite if the file is under 100 lines. If a change seems to require a full rewrite on a larger file, stop and split it into smaller targeted edits.
+
+**Small model constraint**: each edit must touch a contiguous block of at most **50 lines**. If the planned change exceeds this, split it into sub-changes before proceeding — do not attempt an oversized edit.
+
+### Mini-development cycle (execute for each change)
+
+**Attempt counter**: reset to 1 at the start of each new change.
+
+**1 — READ**
+Re-read the source file around the lines to extract. Do not rely on memory or on earlier reads — the file may have changed from previous edits.
+
+**2 — EDIT**
+- Extract or move the identified block (≤ 50 lines)
+- Place it in the target file and target class specified in the plan
+- If the target file is new, create it with only the extracted code
+- Update all call sites listed in the plan
+
+**3 — DIFF**
+Verify the edit before running tests:
+```bash
+git diff --stat   # only the expected files should appear
+git diff          # scan deleted lines (−) and confirm each removal is
+                  # intentional — moved, not silently dropped.
+                  # If deleted lines >> added lines with no new file
+                  # created, code was likely lost — abort immediately.
+```
+
+If the diff shows unexpected files or lost code (deletions >> additions, no new file):
+```bash
+git checkout HEAD -- <file>
+```
+Then re-examine the plan and retry from step 2 (counts as an attempt).
+
+**4 — TEST**
+Run the test gate from the plan entry. This is the exact command specified for this change.
+
+```
+Test result?
+├─ GREEN → go to step 5 (mark done)
+└─ RED   → git checkout HEAD -- <file>
+           increment attempt counter
+           if attempts < 3:
+             diagnose the failure, adjust the edit, go back to step 2
+           if attempts == 3:
+             STOP — trigger circuit-breaker (see above)
+```
+
+**5 — MARK DONE**
+Append `✅` to the change heading in `.openlore/refactor-plan.md`, then proceed to the next change.
+
+---
+
+## Step 5 — Verify improvement
+
+Call the openlore MCP tool `analyze_codebase` with `{"directory": "$DIRECTORY", "force": true}`.
+
+Then call the openlore MCP tool `get_refactor_report` with `{"directory": "$DIRECTORY"}`.
+
+Check each acceptance criterion from the plan:
+- Priority score dropped below the target
+- Function is no longer in the top-5 list
+- Full test suite passes
+
+If not, investigate and iterate (add a new change to the plan if needed, respecting the ≤ 50 line constraint).
+
+Run the full test suite one final time to confirm the refactored state is clean.
+
+---
+
+## Step 6 (optional — requires openlore generate to have been run)
+
+> ⚠️ This step proposes irreversible changes (deletions, renames). Do not apply anything without explicit user confirmation at each sub-step.
+
+### 6a — Dead code: orphan functions
+
+Call the openlore MCP tool `get_mapping` with `{"directory": "$DIRECTORY", "orphansOnly": true}`.
+
+Present the orphan list (kind `function` or `class` only). For each one, check:
+- Is it exported and potentially consumed by external code?
+- Is it re-exported from an index file?
+- Was it simply missed by the LLM?
+
+**Do not delete anything without the user explicitly approving each function.**
+
+### 6b — Naming alignment: spec vocabulary vs actual names
+
+Call the openlore MCP tool `get_mapping` with `{"directory": "$DIRECTORY"}`.
+
+Build a table of mismatches and present it before touching any code:
+
+| Current name | Proposed name | File | Confidence |
+|---|---|---|---|
+
+Only renames with `confidence: "llm"` should be proposed automatically. Flag `confidence: "heuristic"` entries for manual verification first.
+
+**Wait for explicit user approval of the full rename table before applying any change. Apply renames one file at a time, run tests after each, and respect the ≤ 50-line edit constraint.**
+
+---
+
+## Absolute constraints
+
+- Always re-read `.openlore/refactor-plan.md` before each change
+- Never rewrite a file > 100 lines in a single operation
+- Never accumulate broken state — restore immediately on any test failure
+- Always verify the diff before running tests
+- Never proceed to Step 6 without explicit user request
+- Always flag potentially lost code (deleted lines >> added lines with no new file created)
+- Never ask for confirmation between steps — only pause for circuit-breaker or lost-code signals
+- Never continue on a red baseline, regardless of whether failures appear pre-existing
+- Never attempt more than 3 retries on a single change without user input
+- Each edit must touch ≤ 50 contiguous lines — split if needed, never skip this constraint

package/examples/opencode-skills/openlore-generate/SKILL.md

@@ -0,0 +1,236 @@
+---
+name: openlore-generate
+description: Reverse-engineer OpenSpec specifications from an existing codebase. Performs "code archaeology" — extracting what code actually does and documenting it as structured OpenSpec specs across all detected domains.
+license: MIT
+version: 1.0.0
+author: Clay Good
+repository: https://github.com/clay-good/openlore
+compatibility: openlore MCP server
+---
+
+# openlore: Generate OpenSpec Specifications
+
+## When to use this skill
+
+Trigger this skill when the user asks to **generate specs from an existing codebase**, with phrasings like:
+- "run openlore on this codebase"
+- "reverse-engineer the specs"
+- "generate OpenSpec from my code"
+- "document what this code does"
+- explicit command `/openlore-generate`
+
+---
+
+## Philosophy
+
+- **Archaeology over Creativity**: document what the code ACTUALLY does, not what you imagine it should do
+- **Evidence-based**: every requirement and scenario must trace back to actual code
+- **OpenSpec-native**: output follows OpenSpec conventions exactly
+
+---
+
+## Phase 1 — Codebase Survey
+
+Understand the project structure before touching any files.
+
+**1. Identify project type** by checking for:
+
+| File | Stack |
+|---|---|
+| `package.json` | Node.js / TypeScript |
+| `pyproject.toml` / `setup.py` | Python |
+| `go.mod` | Go |
+| `Cargo.toml` | Rust |
+| `pom.xml` / `build.gradle` | Java |
+
+**2. Find high-value files** — prioritize:
+- Schema / model files (entities, types, interfaces)
+- Service files (business logic)
+- Route / controller files (API surface)
+- Config files (settings, environment)
+- Entry points (main, index, app)
+
+**3. Identify domains** by looking for:
+- Directory structure (`src/users/`, `src/orders/`, etc.)
+- File naming patterns (`user-service`, `order-controller`)
+- Import clusters (files that import each other heavily)
+
+**4. Detect frameworks** from dependencies and patterns:
+- Web: Express, NestJS, FastAPI, Django, etc.
+- Database: PostgreSQL, MongoDB, etc.
+- Auth: JWT, OAuth, etc.
+
+---
+
+## Phase 2 — Deep Analysis
+
+For each identified domain, analyze the relevant files.
+
+**Extract entities:**
+- What data structures exist?
+- What are their properties and types?
+- How do they relate to each other?
+
+**Extract behaviors:**
+- What operations can be performed?
+- What are the business rules / validations?
+- What side effects occur (emails, payments, etc.)?
+
+**Extract API surface** (if applicable):
+- What endpoints exist?
+- What are the request / response shapes?
+- What authentication is required?
+
+---
+
+## Phase 3 — Generate OpenSpec Specifications
+
+Create the OpenSpec directory structure if it doesn't exist:
+
+```
+openspec/
+├── config.yaml
+└── specs/
+    ├── overview/
+    │   └── spec.md
+    ├── {domain-1}/
+    │   └── spec.md
+    ├── {domain-2}/
+    │   └── spec.md
+    └── architecture/
+        └── spec.md
+```
+
+### Spec file format
+
+Each `spec.md` MUST follow this exact format:
+
+```markdown
+# {Domain} Specification
+
+> Generated by openlore on {date}
+> Source files: {list of files analyzed}
+
+## Purpose
+
+{2-3 sentences describing what this domain handles}
+
+## Requirements
+
+### Requirement: {RequirementName}
+
+{The system SHALL/MUST/SHOULD do X...}
+
+Use RFC 2119 keywords:
+- **SHALL/MUST**: Required behavior
+- **SHOULD**: Recommended behavior
+- **MAY**: Optional behavior
+
+#### Scenario: {ScenarioName}
+- **GIVEN** {precondition}
+- **WHEN** {action}
+- **THEN** {expected outcome}
+
+## Technical Notes
+
+- **Implementation**: `{file paths}`
+- **Dependencies**: {related domains/services}
+```
+
+### Critical formatting rules
+
+1. Requirements use RFC 2119 keywords (SHALL, MUST, SHOULD, MAY)
+2. Scenarios use exactly 4 hashtags (`####`)
+3. Scenarios follow Given/When/Then format with **bold** labels
+4. No delta markers (ADDED, MODIFIED, REMOVED) — these are baseline specs
+
+---
+
+## Phase 4 — Update OpenSpec Config
+
+**If `openspec/config.yaml` exists**, preserve all existing content and append:
+
+```yaml
+# Auto-detected by openlore
+openlore:
+  generatedAt: "{timestamp}"
+  domains:
+    - {domain-1}
+    - {domain-2}
+```
+
+**If it doesn't exist**, create a minimal config:
+
+```yaml
+schema: spec-driven
+context: |
+  {Brief project description based on analysis}
+
+  Tech stack: {detected technologies}
+  Architecture: {detected pattern}
+```
+
+---
+
+## Phase 5 — Drift Detection
+
+When specs already exist and code has changed, check for **spec drift** — divergence between the codebase and its specifications.
+
+**When to check:** before committing code, when reviewing PRs, or when explicitly asked to validate specs.
+
+**Process:**
+
+1. **Identify what changed** — use git to find added, modified, deleted, or renamed source files compared to the base branch. Filter out: test files, generated files, lock files, static assets, CI configs.
+
+2. **Map changes to specs** — for each changed file, determine which spec domain covers it by checking:
+   - `> Source files:` header in each `spec.md`
+   - `**Implementation**:` references in Technical Notes
+   - Directory structure inference (e.g. `src/auth/` → auth domain)
+
+3. **Detect four categories of drift:**
+
+| Category | Meaning |
+|---|---|
+| **Gap** | Code changed but its spec was not updated |
+| **Stale** | Spec references a deleted or renamed file |
+| **Uncovered** | New source file has no matching spec domain |
+| **Orphaned Spec** | Spec declares source files that no longer exist |
+
+4. **Report** each issue with: affected file, domain, and a suggested resolution.
+
+**CLI shorthand:** `openlore drift` runs this check. Use `openlore drift --install-hook` to add it as a git pre-commit hook.
+
+---
+
+## Output Checklist
+
+Before finishing, verify every item:
+
+- [ ] `openspec/specs/overview/spec.md` exists with system summary
+- [ ] Each domain has `openspec/specs/{domain}/spec.md`
+- [ ] `openspec/specs/architecture/spec.md` describes system structure
+- [ ] All requirements use RFC 2119 keywords
+- [ ] All scenarios use Given/When/Then format
+- [ ] `openspec/config.yaml` is created or updated
+- [ ] No spec drift — run `openlore drift` to verify specs match code
+
+---
+
+## Absolute constraints
+
+- **Never invent requirements** — every item must be traceable to actual code
+- Always preserve existing `openspec/config.yaml` content before appending
+- Never use delta markers (ADDED, MODIFIED, REMOVED) in baseline specs
+- Scenarios must use exactly 4 hashtags — never 3 or 5
+- RFC 2119 keywords (SHALL, MUST, SHOULD, MAY) must be uppercase
+
+---
+
+## Suggested next steps after generation
+
+Report what was created, then suggest:
+- `openspec validate --all` — check spec structure
+- `openlore drift --install-hook` — catch future drift automatically
+- `openspec list --specs` — see all generated specs
+- Manual review and refinement of generated specs
+- Run `/openlore-plan-refactor` to identify refactoring targets now that specs exist