opencode-code-archaeology 2.0.0 → 2.2.0

package/wiki/Expedition-Workflow.md

@@ -0,0 +1,34 @@
+# Expedition Workflow
+
+[Home](Home) | [Installation](Installation) | [Security](Security-and-Safety) | [Release](Release-Process)
+
+Code Archaeology runs phases in a fixed order so later changes are based on earlier evidence. In OpenCode, `/code-archaeology` runs the full 10-phase survey chain by default without per-phase prompts.
+
+1. Site Survey & Baseline
+2. Dead Code Excavation
+3. Legacy Stratum Removal
+4. Circular Dependency Cartography
+5. Type Catalog Consolidation
+6. Type Restoration & Hardening
+7. DRY Stratification
+8. Error Handling Stratigraphy
+9. Artifact Cleaning & Documentation
+10. Site Preservation & Final Catalog
+
+## Modes
+
+| Mode | Behavior |
+| --- | --- |
+| `survey` | Reports only; no source edits. |
+| `excavate` | Reports plus mock patches in `.archaeology/patches/`. |
+| `restore` | Applies approved changes with verification gates. |
+
+Use `/code-archaeology-restore` explicitly when you are ready to apply changes. The default `/code-archaeology` command remains survey-only and writes reports under `.archaeology/`.
+
+## Local Artifacts
+
+`.archaeology/` contains `session.json`, `site_survey.md`, expedition reports, `FINAL_CATALOG.md`, `excavation_log.txt`, and optional mock patches. It is local runtime state and should not be committed.
+
+## Gates
+
+`hooks/opencode/init.sh` initializes the session. `verify-phase.sh` runs tests and type checks between restore phases. `revert-phase.sh` reverts a failed restore phase. `update-expedition.sh` records progress.

package/wiki/Home.md

@@ -0,0 +1,27 @@
+# Code Archaeology Wiki
+
+Code Archaeology is an OpenCode plugin for systematic codebase excavation, cataloging, and restoration. It runs a fixed, report-first workflow and keeps runtime artifacts local in `.archaeology/`.
+
+## Navigation
+
+- [Installation](Installation)
+- [Expedition Workflow](Expedition-Workflow)
+- [Security and Safety](Security-and-Safety)
+- [Release Process](Release-Process)
+
+## Quick Start
+
+```bash
+npm install -g opencode-code-archaeology
+opencode-code-archaeology install
+opencode-code-archaeology doctor
+opencode-code-archaeology version
+```
+
+Restart OpenCode inside a Git repository and run:
+
+```text
+/code-archaeology
+```
+
+`/code-archaeology` runs the full 10-phase survey chain without per-phase prompts, writes `.archaeology/` reports only, and makes no source-code changes. Review reports, then choose `excavate` for mock patches or `restore` for approved, test-gated changes.

package/wiki/Installation.md

@@ -0,0 +1,44 @@
+# Installation
+
+[Home](Home) | [Workflow](Expedition-Workflow) | [Security](Security-and-Safety) | [Release](Release-Process)
+
+## OpenCode Plugin Install
+
+Add the package to the top-level `plugin` array in `opencode.json`:
+
+```json
+{
+  "plugin": [
+    "opencode-code-archaeology@git+https://github.com/Maleick/Code-Archaeology.git"
+  ]
+}
+```
+
+Restart OpenCode. Commands should be available inside a Git repository:
+
+```text
+/code-archaeology
+/code-archaeology-survey
+/code-archaeology-excavate
+/code-archaeology-restore
+```
+
+`/code-archaeology` runs the full 10-phase survey chain by default without per-phase prompts. It writes reports under `.archaeology/` and makes no source-code changes. Use `/code-archaeology-restore` only after reviewing the reports and deciding to apply changes.
+
+## npm CLI Path
+
+```bash
+npm install -g opencode-code-archaeology
+opencode-code-archaeology install
+opencode-code-archaeology doctor
+opencode-code-archaeology version
+```
+
+For updates:
+
+```bash
+npm install -g opencode-code-archaeology@latest
+npm list -g opencode-code-archaeology --depth=0
+```
+
+If commands do not appear, restart OpenCode, verify `opencode.json` uses `plugin` singular, and clear any stale OpenCode plugin cache.

package/wiki/Release-Process.md

@@ -0,0 +1,31 @@
+# Release Process
+
+[Home](Home) | [Installation](Installation) | [Workflow](Expedition-Workflow) | [Security](Security-and-Safety)
+
+Use this checklist for future `opencode-code-archaeology` releases. `v2.1.0` is the current example version; replace it with the target version.
+
+## Checklist
+
+1. Review the worktree for unrelated changes and local state.
+2. Bump package files with `npm version 2.1.0 --no-git-tag-version`.
+3. Update `VERSION` to `2.1.0`.
+4. Update `CHANGELOG.md` with release notes.
+5. Run verification:
+
+```bash
+npm install
+npm run build
+npm run typecheck
+npm audit --audit-level=moderate
+npm outdated --json
+bash -n hooks/opencode/*.sh
+npm pack --json --dry-run
+```
+
+6. Confirm the package dry run includes `dist`, `assets`, `hooks`, `commands`, `skills`, `plugins`, `schema`, `prompts`, `docs`, `wiki`, `README.md`, `INSTALL.md`, `CHANGELOG.md`, `SECURITY.md`, `CONTRIBUTING.md`, `VERSION`, `AGENTS.md`, and `LICENSE`.
+7. Commit release files, tag `v2.1.0`, push the branch, and push the tag.
+8. Create the GitHub release from the tag.
+9. Publish npm with `npm publish --access public`.
+10. Confirm `npm view opencode-code-archaeology version` and `gh release view v2.1.0` show the expected release.
+
+Do not claim GitHub Pages is enabled unless repository settings confirm it.

package/wiki/Security-and-Safety.md

@@ -0,0 +1,21 @@
+# Security And Safety
+
+[Home](Home) | [Installation](Installation) | [Workflow](Expedition-Workflow) | [Release](Release-Process)
+
+## Current Audit Notes
+
+- `npm audit --audit-level=moderate` is expected to be clean.
+- `npm outdated --json` is expected to be clean.
+- No hardcoded secrets are expected in source, docs, hooks, commands, prompts, schemas, or metadata.
+- `.archaeology/` and `.superpowers/` are ignored local state.
+- Shell hooks can be syntax checked with `bash -n hooks/opencode/*.sh`.
+
+## Restore Caveat
+
+`restore` mode can edit source files. Run it only after reviewing `survey` reports, preferably after reviewing `excavate` mock patches, and only when tests or type checks are available.
+
+Failed restore phases should be reverted before continuing. The workflow must not remove try/catch blocks around I/O or external input boundaries automatically, and uncertain type replacements should be flagged for review.
+
+## Before Publishing
+
+Run build, typecheck, npm audit, npm outdated, shell syntax checks, and `npm pack --json --dry-run`. Inspect the package contents for accidental local state or secrets before publishing.

package/plugins/code-archaeology.ts

@@ -1,8 +0,0 @@
-export {
-  id,
-  repoRoot,
-  version,
-  server,
-} from "../src/index.ts";
-
-export type * from "../src/types";