opencode-code-archaeology 2.0.0 → 2.0.2

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,63 @@
+name: Bug report
+description: Report a problem with the Code Archaeology OpenCode plugin.
+title: "bug: "
+labels:
+  - bug
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for helping improve Code Archaeology. Do not include secrets, private code, or full `.archaeology/` state.
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: What went wrong?
+    validations:
+      required: true
+  - type: dropdown
+    id: mode
+    attributes:
+      label: Mode
+      options:
+        - survey
+        - excavate
+        - restore
+        - install or CLI
+        - documentation
+        - other
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: Package version, commit SHA, or install source.
+      placeholder: v2.0.2
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      placeholder: |
+        1. Run ...
+        2. See ...
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual behavior
+      description: Include sanitized logs or error output when useful.
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: OS, Node version, OpenCode version, package manager, and target language.
+      placeholder: macOS 14, Node 20, OpenCode ..., npm ..., TypeScript

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,48 @@
+name: Feature request
+description: Suggest an improvement for the Code Archaeology OpenCode plugin.
+title: "feat: "
+labels:
+  - enhancement
+body:
+  - type: markdown
+    attributes:
+      value: Please focus on the user workflow and safety impact. Do not include private repository contents.
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: What workflow or limitation should this improve?
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: What should Code Archaeology do differently?
+    validations:
+      required: true
+  - type: dropdown
+    id: area
+    attributes:
+      label: Area
+      options:
+        - survey reporting
+        - excavate mock patches
+        - restore safety
+        - language support
+        - CLI or install
+        - documentation
+        - CI or release
+        - other
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+      description: Any workaround or simpler approach?
+  - type: textarea
+    id: safety
+    attributes:
+      label: Safety considerations
+      description: Could this modify user code, expose local state, or affect restore behavior?

package/.github/pull_request_template.md

@@ -0,0 +1,26 @@
+## Summary
+
+- 
+
+## Verification
+
+- [ ] `npm run build`
+- [ ] `npm run typecheck`
+- [ ] `npm test`
+- [ ] `npm audit --audit-level=moderate`
+- [ ] `bash -n hooks/opencode/*.sh`
+- [ ] `npm pack --json --dry-run`
+
+## Safety Checklist
+
+- [ ] I did not commit `.archaeology/`, `.superpowers/`, secrets, logs, or local editor state.
+- [ ] Restore-mode changes are backed by reviewed survey or excavate output.
+- [ ] I did not remove try/catch around I/O or external input boundaries.
+- [ ] I flagged uncertain type or behavior changes for review instead of guessing.
+
+## Docs And Release Checklist
+
+- [ ] README, INSTALL, docs, and wiki source are updated if user behavior changed.
+- [ ] CHANGELOG includes user-visible changes.
+- [ ] Package metadata and npm package contents are correct for release-impacting changes.
+- [ ] Version, tag, publish, and release steps are not included unless this PR is the release PR.

package/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  verify:
+    name: Verify
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Typecheck
+        run: npm run typecheck
+
+      - name: Test
+        run: npm test
+
+      - name: Audit dependencies
+        run: npm audit --audit-level=moderate
+
+      - name: Check shell hook syntax
+        run: bash -n hooks/opencode/*.sh
+
+      - name: Validate npm package contents
+        run: npm pack --json --dry-run

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## v2.0.2
+
+- Added release-ready repository parity files: CI workflow, issue templates, PR template, security policy, contribution guide, and changelog.
+- Added npm CLI and install documentation so users can install from npm, GitHub, or OpenCode plugin configuration paths.
+- Added security audit and safety documentation covering local state, restore-mode review, dependency audit expectations, and secret-free examples.
+- Prepared package metadata and package contents for npm release readiness, including docs, wiki source, assets, prompts, and release support files.
+
+## v2.0.1
+
+- Committed built `dist/` artifacts so GitHub-based installs can load the plugin without requiring a local build step.
+- Updated installation and auto-update documentation.
+- Bumped package version to `2.0.1`.
+
+## v2.0.0
+
+- Converted Code Archaeology into an OpenCode plugin.
+- Added commands, hooks, policies, prompts, schema, and plugin packaging for survey, excavate, and restore workflows.
+- Established the archaeology workflow for dead code, legacy cleanup, dependency mapping, type work, DRY review, error handling, and final catalog verification.

package/CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing
+
+Thanks for improving Code Archaeology, an OpenCode plugin for systematic codebase excavation, cataloging, and restoration.
+
+## Local Setup
+
+```bash
+npm install
+npm run build
+npm test
+```
+
+Use Node 20 for CI parity. Node 18 or newer is supported by the package metadata.
+
+## Branch Policy
+
+- Do not commit directly to `main` or `master`.
+- Use a focused branch or worktree for each change.
+- Keep `.archaeology/`, `.superpowers/`, `node_modules/`, logs, secrets, and editor state out of commits.
+- Do not commit, tag, push, or publish release artifacts unless you are intentionally performing a reviewed release step.
+
+## Testing Commands
+
+Run the most focused checks for your change, and run the release checks before release-impacting changes are merged:
+
+```bash
+npm run build
+npm run typecheck
+npm test
+npm audit --audit-level=moderate
+bash -n hooks/opencode/*.sh
+npm pack --json --dry-run
+```
+
+If a restore-mode change modifies behavior, verify it against a disposable repository or fixture and document the result.
+
+## Documentation Expectations
+
+- Update `README.md`, `INSTALL.md`, `docs/`, or `wiki/` when installation, commands, workflow, safety, or release behavior changes.
+- Keep documentation factual, concise, and ASCII.
+- Do not include secrets, credentials, private repository contents, or full local runtime state.
+- Preserve the safety model: survey first, excavate for mock patches, restore only after review.
+
+## Release Notes Expectations
+
+- Add user-visible changes to `CHANGELOG.md`.
+- Mention install or CLI changes, safety changes, package metadata changes, and migration steps when relevant.
+- Do not claim a GitHub release, npm publish, tag, or Pages update happened until it has been verified.

package/INSTALL.md

@@ -0,0 +1,141 @@
+# Install Code Archaeology
+
+Code Archaeology is an OpenCode plugin for systematic codebase excavation. It is non-destructive by default: `survey` mode writes reports only, while `restore` mode modifies code after review and verification.
+
+## OpenCode Handoff
+
+Paste this into OpenCode if you want the agent to install and verify the plugin for you:
+
+```text
+Fetch and follow instructions from https://raw.githubusercontent.com/Maleick/Code-Archaeology/refs/heads/main/INSTALL.md
+```
+
+## Prerequisites
+
+- OpenCode installed and available in your shell.
+- Node.js with npm, or Bun if your OpenCode setup uses Bun package resolution.
+- Git installed and available in your shell.
+- A target repository with tests or type checks available before you run `restore` mode.
+
+## Recommended OpenCode Plugin Install
+
+Add Code Archaeology to your `opencode.json` plugin array:
+
+```json
+{
+  "plugin": [
+    "opencode-code-archaeology@git+https://github.com/Maleick/Code-Archaeology.git"
+  ]
+}
+```
+
+Restart OpenCode after editing the configuration. The command family should then be available inside your target repository:
+
+```text
+/code-archaeology
+/code-archaeology-survey
+/code-archaeology-excavate
+/code-archaeology-restore
+```
+
+## npm Global Install
+
+If you prefer a global package install:
+
+```bash
+npm install -g opencode-code-archaeology
+opencode-code-archaeology install
+opencode-code-archaeology doctor
+opencode-code-archaeology version
+```
+
+Then restart OpenCode and run:
+
+```text
+/code-archaeology-survey
+```
+
+## One-Time Bun Path
+
+If your environment supports one-time package execution through Bun:
+
+```bash
+bunx opencode-code-archaeology install
+bunx opencode-code-archaeology doctor
+```
+
+Use the plugin-array install for normal OpenCode usage.
+
+## Verification
+
+These checks do not require secrets:
+
+```bash
+npm view opencode-code-archaeology version
+npm view opencode-code-archaeology dist-tags
+opencode-code-archaeology doctor
+```
+
+For a local clone:
+
+```bash
+npm install
+npm run build
+npm run typecheck
+bash -n hooks/opencode/*.sh
+```
+
+To verify command availability, restart OpenCode in a Git repository and run:
+
+```text
+/code-archaeology-survey
+```
+
+The survey should create `.archaeology/` reports without modifying source files.
+
+## Updating
+
+For plugin-array installs, update through your OpenCode package manager flow, then restart OpenCode. If your setup caches git plugins, clear the cached plugin package and let OpenCode reinstall it.
+
+For npm global installs:
+
+```bash
+npm install -g opencode-code-archaeology@latest
+npm list -g opencode-code-archaeology --depth=0
+```
+
+## Troubleshooting
+
+### Plugin Not Loading
+
+- Confirm `opencode.json` is valid JSON.
+- Confirm the plugin entry is in the top-level `plugin` array.
+- Restart OpenCode after changing the config.
+- Check that Git can reach `https://github.com/Maleick/Code-Archaeology.git`.
+
+### Commands Not Found
+
+- Restart OpenCode so it reloads plugin commands.
+- Confirm the package installed successfully with `npm list -g opencode-code-archaeology --depth=0` if using the global path.
+- Run `/code-archaeology-survey` from inside a Git repository, not from an empty directory.
+
+### Stale Cache
+
+- Remove the cached OpenCode package for `opencode-code-archaeology` if your runtime keeps one.
+- Reinstall or rerun the OpenCode plugin resolution step.
+- Restart OpenCode before testing again.
+
+### Restore Safety
+
+- Start with `/code-archaeology-survey`; it writes reports only.
+- Review `.archaeology/site_survey.md` and expedition reports before restore.
+- Use `/code-archaeology-excavate` for mock patches if you want another review gate.
+- Run `/code-archaeology-restore` only when the target repository has tests or type checks available.
+- Do not commit `.archaeology/`; it is local runtime state.
+
+## Links
+
+- Documentation: https://github.com/Maleick/Code-Archaeology/tree/main/docs
+- Wiki: https://github.com/Maleick/Code-Archaeology/wiki
+- Releases: https://github.com/Maleick/Code-Archaeology/releases
+- Issues: https://github.com/Maleick/Code-Archaeology/issues