@sallmarta/eye-hate-agent 1.0.1 → 1.0.3

package/docs/project-docs/testing.md

@@ -1,73 +0,0 @@
-# Testing & Verification
-
-Last updated: 2026-05-12
-
----
-
-## Verification Policy
-
-This repository is now a hybrid template-and-engine repository.
-This owner doc applies to the `eye-hate-agent` repository itself; downstream repositories should define their own local `docs/project-docs/testing.md`, typically starting from `docs/vibes/project-docs-template/testing.md`.
-Validation for template-maintenance work remains document-first, but engine and CLI changes now require executable checks where available.
-Use the narrowest check that can prove the changed contract, prompt, skill, template, installer, or CLI behavior is internally consistent.
-
-## Verification Matrix
-
-| Change type | Preferred validation | Fallback |
-| --- | --- | --- |
-| Summary-only doc clarification | Markdown diagnostics on changed files, then targeted diff review | Manual read-through of the changed owner doc and dependent summary docs |
-| Contract, maintenance, reusable-prompt, or skill change | Markdown diagnostics, targeted consistency search across affected docs, then maintenance audit review | Structured manual consistency review across contract owner, dependent docs, and changelog |
-| Starter template change under `docs/vibes/project-docs-template/` | Markdown diagnostics on added or changed templates, then check that referenced template surfaces and indexes stay aligned | Manual folder inventory plus cross-reference review |
-| Canonical path, filename, stable heading, or routing change | Markdown diagnostics, consistency search across docs and platform instruction surfaces, then full maintenance audit review | Manual owner-by-owner review only if search tooling is unavailable |
-| Engine, installer, or CLI change | `npm test`, targeted CLI smoke checks, then owner-doc consistency review | Manual CLI smoke check plus structural code review if a full test does not exist |
-| npm package metadata or release-surface change | `npm test`, `npm pack --dry-run`, tarball smoke install, then owner-doc consistency review | Manual package file review plus local CLI smoke checks |
-
-## Commands
-
-- changed-file diagnostics: use editor or Problems diagnostics for every changed Markdown file
-- targeted consistency search: `rg -n "<changed-term>|<path>|<heading>" README.md docs .agents .github .claude`
-- changed-doc review: `git --no-pager diff -- README.md docs`
-- folder inventory for scaffold changes: `rg --files docs/vibes/project-docs-template`
-- engine test suite: `npm test`
-- CLI smoke check: `node bin/eha.js doctor`
-- package contents preview: `npm pack --dry-run`
-- tarball creation: `npm pack`
-- tarball smoke install: install the generated `.tgz` into a clean temporary directory, then run `npx eha doctor` or the installed `eha doctor`
-
-Replace `<changed-term>|<path>|<heading>` with the concrete contract term, file path, or heading touched by the change.
-
-## Test Layers
-
-- File diagnostics: confirm changed Markdown files have no syntax or lint issues.
-- Owner-doc consistency: confirm the owning doc expresses the durable truth first.
-- Dependent-doc consistency: confirm summaries, reusable prompts, skills, and maintenance docs still match the owner.
-- Template-surface consistency: confirm starter templates and indexes match the advertised contract.
-- Maintenance-audit review: for higher-impact changes, run the same cross-surface review expected by the maintenance workflow.
-
-## Naming and File Conventions
-
-- Owner testing doc path: `docs/project-docs/testing.md`
-- Adoption starter for downstream repos: `docs/vibes/project-docs-template/technical/testing.md`
-- Changelog path for maintainer-facing changes: `docs/project-docs/changelog.md`
-- Template starter docs live under `docs/vibes/project-docs-template/`
-- Reusable prompts live under `docs/vibes/reusable-prompts/`
-- Skills live under `docs/vibes/skills/`
-
-## CI / Release Gates
-
-- Required before merge: changed Markdown files are diagnostic-clean.
-- Required before merge: owning docs and dependent docs are checked for consistency.
-- Required before merge: maintainer-facing template changes are recorded in `docs/project-docs/changelog.md`.
-- Required before merge: engine and CLI changes pass `npm test`.
-- Required before publish: package metadata changes pass `npm pack --dry-run` and a tarball smoke-install check.
-- Required before release of breaking template changes: run the full maintenance audit sequence described by `docs/eyehateagent-maintenance.md`.
-- Advisory: confirm platform instruction surfaces (mirrored rule files) were either updated or explicitly left unchanged because they remain generic.
-
-## Manual Checks
-
-- Confirm the owning document was updated before dependent summaries or reusable assets.
-- Confirm contract changes did not leave stale paths, headings, or ownership rules in README, reusable prompts, maintenance docs, or skills.
-- Confirm new starter templates use the stable heading pattern defined by the contract.
-- Confirm the repo is not claiming executable tests that do not actually exist.
-- Confirm engine-generated runtime outputs still map back to canonical source assets and owner docs.
-- Confirm package metadata points at the canonical GitHub repository and intended npm scope.

package/docs/vibes/project-docs-template/foundation/architecture.md

@@ -1,79 +0,0 @@
-# Architecture
-
-Last update: YYYY-MM-DD
-
-Status: [Proposed | Draft | Live | Deprecated | Archived]
-
----
-
-## 1. Description
-> [!NOTE] Briefly describe the purpose of this document and what it contains.
-
-## 2. Important
-> [!NOTE] Notes of important findings or critical constraints. Can be empty.
-
-## 3. Table of Contents
-> [!NOTE] TOC goes here.
-
-## 4. Scope
-> [!NOTE] The boundaries of what this document covers.
-
-## 5. Goals
-> [!NOTE] What we aim to achieve with this specific document.
-
-## 6. Non Goals
-> [!NOTE] What is explicitly excluded from the scope of this document.
-
-## 7. Tech Stack Overview
-| Area | Choice | Notes |
-| --- | --- | --- |
-| Application or service | TBD | |
-| Runtime or platform | TBD | |
-| Storage | TBD | |
-| External integrations | TBD | |
-
-## 8. Architecture Pattern
-> [!NOTE] Describe architecture design pattern, system topology, component boundaries, and foundational control flow.
-
-## 9. System Flow
-> [!NOTE] General overview of how the system work from start to end. Diagram or flowchart visual are preferred. Use mermaid.
-
-```mermaid
-graph TD
-    A[Start] --> B{Decision}
-    B -- Yes --> C[Result 1]
-    B -- No --> D[Result 2]
-```
-
-## 10. Data Flow
-> [!NOTE] General overview of inter-feature data flow, mapped against architectural patterns and system flow. Diagram or flowchart visual are preferred. Use mermaid.
-
-```mermaid
-sequenceDiagram
-    participant User
-    participant System
-    User->>System: Data Request
-    System-->>User: Data Response
-```
-
-## 11. Tools Integration
-> [!NOTE] Such as hardware or software or external api and relevant tools. Can be empty.
-
-| Integration | Purpose | Kind | Notes |
-| --- | --- | --- | --- |
-| TBD | TBD | TBD | *Software/Hardware/APIs/Other* |
-
-## 12. Global Parameters and Constraints
-> [!NOTE] Detail the system's global restrictions, such as performance requirements, caching policies, and error-handling mechanisms (e.g., "Supports offline execution for core features" or "Memory footprint restricted to 50MB").
-
-## 13. Architecture Decision Records (ADRs)
-> [!NOTE] A collection of ADRs documenting the rationale behind technical decision (e.g., "Choosing React over Vue for state management flexibility" or "Adopting Domain-Driven Design to leverage bounded contexts").
-
-## 14. Success Metrics
-> [!NOTE] How we measure if the goals of this document are achieved.
-
-## 15. Related Documents
-> [!NOTE] [Link to related document](path) - Short brief note about why it's related (e.g., [Guidelines](path) - technical implementation rules).
-
-## 16. Open Questions
-> [!NOTE] Unresolved architectural questions or assumptions. Can be empty.

package/docs/vibes/project-docs-template/foundation/changelog.md

@@ -1,53 +0,0 @@
-# System Name Changelog
-
-Last update: YYYY-MM-DD
-
-Status: [Proposed | Draft | Live | Deprecated | Archived]
-
----
-
-## 1. Description
-> [!NOTE] Briefly describe the purpose of this document and what it contains.
-
-## 2. Important
-> [!NOTE] Notes of important findings or critical constraints. Can be empty.
-
-## 3. Table of Contents
-> [!NOTE] TOC goes here.
-
-## 4. Scope
-> [!NOTE] The boundaries of what this document covers.
-
-## 5. Goals
-> [!NOTE] What we aim to achieve with this specific document.
-
-## 6. Non Goals
-> [!NOTE] What is explicitly excluded from the scope of this document.
-
-## 7. [Unreleased]
-### 7.1. Added
-> [!NOTE] TBD
-
-### 7.2. Changed
-> [!NOTE] TBD
-
-### 7.3. Deprecated
-> [!NOTE] TBD
-
-### 7.4. Removed
-> [!NOTE] TBD
-
-### 7.5. Fixed
-> [!NOTE] TBD
-
-### 7.6. Security
-> [!NOTE] TBD
-
-## 8. Success Metrics
-> [!NOTE] How we measure if the goals of this document are achieved.
-
-## 9. Related Documents
-> [!NOTE] [Link to related document](path) - Short brief note about why it's related.
-
-## 10. Open Questions
-> [!NOTE] Any unresolved questions or assumptions. Can be empty.

package/docs/vibes/project-docs-template/foundation/feature-inventory.md

@@ -1,46 +0,0 @@
-# Feature Inventory
-
-Last update: YYYY-MM-DD
-
-Status: [Proposed | Draft | Live | Deprecated | Archived]
-
----
-
-## 1. Description
-> [!NOTE] Briefly describe the purpose of this document and what it contains.
-
-## 2. Important
-> [!NOTE] Notes of important findings or critical constraints. Can be empty.
-
-## 3. Table of Contents
-> [!NOTE] TOC goes here.
-
-## 4. Scope
-> [!NOTE] The boundaries of what this document covers.
-
-## 5. Goals
-> [!NOTE] What we aim to achieve with this specific document.
-
-## 6. Non Goals
-> [!NOTE] What is explicitly excluded from the scope of this document.
-
-## 7. Feature Summary
-> [!NOTE] High-level overview of the active feature set.
-
-## 8. Core Functions (Epic-level)
-> [!NOTE] Major active functional blocks mapping directly to code.
-
-## 9. Sub-Functions (Task-level)
-> [!NOTE] Granular interactions and capabilities currently live.
-
-## 10. Deprecated / Removed Features
-> [!NOTE] Historical record of retired capabilities.
-
-## 11. Success Metrics
-> [!NOTE] How we measure if the goals of this document are achieved.
-
-## 12. Related Documents
-> [!NOTE] [Link to related document](path) - Short brief note about why it's related.
-
-## 13. Open Questions
-> [!NOTE] Any unresolved questions or assumptions. Can be empty.

package/docs/vibes/project-docs-template/foundation/phases.md

@@ -1,60 +0,0 @@
-# Phases
-
-Last update: YYYY-MM-DD
-
-Status: [Proposed | Draft | Live | Deprecated | Archived]
-
----
-
-## 1. Description
-> [!NOTE] Briefly describe the purpose of this document and what it contains.
-
-## 2. Important
-> [!NOTE] Notes of important findings or critical constraints. Can be empty.
-
-## 3. Table of Contents
-> [!NOTE] TOC goes here.
-
-## 4. Scope
-> [!NOTE] The boundaries of what this document covers.
-
-## 5. Goals
-> [!NOTE] What we aim to achieve with this specific document.
-
-## 6. Non Goals
-> [!NOTE] What is explicitly excluded from the scope of this document.
-
-## 7. Overall Project Timeline
-> [!NOTE] High-level estimate and major milestones. Visual timelines are preferred. Use mermaid.
-
-```mermaid
-gantt
-    title Project Timeline
-    dateFormat  YYYY-MM-DD
-    section Phase 1
-    Milestone 1 : 2024-01-01, 30d
-    section Phase 2
-    Milestone 2 : 2024-02-01, 30d
-```
-
-## 8. Phase Registry
-> [!NOTE] Links to individual markdown files in the `phases/` directory.
-
-## 9. Sprint Tracker
-### 9.1. Current Sprint (Date Range)
-> [!NOTE] TBD
-
-### 9.2. Active Tasks
-> [!NOTE] TBD
-
-### 9.3. Blockers
-> [!NOTE] TBD
-
-## 10. Success Metrics
-> [!NOTE] How we measure if the goals of this document are achieved.
-
-## 11. Related Documents
-> [!NOTE] [Link to related document](path) - Short brief note about why it's related.
-
-## 12. Open Questions
-> [!NOTE] Any unresolved questions or assumptions. Can be empty.

package/docs/vibes/project-docs-template/foundation/prd.md

@@ -1,69 +0,0 @@
-# Product Requirements Document (PRD)
-
-Last update: YYYY-MM-DD
-
-Status: [Proposed | Draft | Live | Deprecated | Archived]
-
----
-
-## 1. Description
-> [!NOTE] Summarize the product, system, or major epic requirement set at a high level.
-
-## 2. Important
-> [!NOTE] Notes of important findings or critical constraints. Can be empty.
-
-## 3. Table of Contents
-> [!NOTE] TOC goes here.
-
-## 4. Scope
-> [!NOTE] The boundaries of what this document covers.
-
-## 5. Goals
-> [!NOTE] What we aim to achieve with this specific document.
-
-## 6. Non Goals
-> [!NOTE] What is explicitly excluded from the scope of this document.
-
-## 7. Vision Statement
-> [!NOTE] A single, powerful sentence defining the ultimate end-state of the project.
-
-## 8. Target Personas
-> [!NOTE] Specific user types (e.g., Admin, Guest) to give the team empathy.
-
-## 9. Core Business Value
-> [!NOTE] The primary ROI, problem being solved, or operational improvement. Why does this project matter now?
-
-## 10. User Journeys & App Flow
-> [!NOTE] Flowcharts mapping the user's path through the app. Use mermaid.
-
-```mermaid
-journey
-    title User Journey Example
-    section Login
-      Enter credentials: 5: User
-      Authenticate: 5: System
-```
-
-## 11. Feature Workflows
-> [!NOTE] Step-by-step logic flows for individual features. Use mermaid flowcharts to map complex feature logic.
-
-## 12. Functional Requirements
-> [!NOTE] Detailed list of functional capabilities.
-
-## 13. Non-Functional Requirements
-> [!NOTE] Reliability, performance, security, compliance, or UX expectations.
-
-## 14. Acceptance Criteria
-> [!NOTE] Specific criteria to verify the requirements are met.
-
-## 15. External Dependencies & Partners
-> [!NOTE] Third-party vendors and manual bottlenecks.
-
-## 16. Success Metrics
-> [!NOTE] How we measure if the goals of this document are achieved.
-
-## 17. Related Documents
-> [!NOTE] [Link to related document](path) - Short brief note about why it's related.
-
-## 18. Open Questions
-> [!NOTE] Any unresolved questions or assumptions. Can be empty.

package/docs/vibes/project-docs-template/foundation/status.md

@@ -1,57 +0,0 @@
-# Status
-
-Last update: YYYY-MM-DD
-
-Status: [Proposed | Draft | Live | Deprecated | Archived]
-
----
-
-## 1. Description
-> [!NOTE] Briefly describe the purpose of this document and what it contains. (Note: This dashboard is updated automatically by the EHA agent).
-
-## 2. Important
-> [!NOTE] Notes of important findings or critical constraints. Can be empty.
-
-## 3. Table of Contents
-> [!NOTE] TOC goes here.
-
-## 4. Scope
-> [!NOTE] The boundaries of what this document covers.
-
-## 5. Goals
-> [!NOTE] What we aim to achieve with this specific document.
-
-## 6. Non Goals
-> [!NOTE] What is explicitly excluded from the scope of this document.
-
-## 7. Current State
-> [!NOTE] Summarize the current implementation state, maturity, and major constraints.
-
-## 8. Recent Accomplishments
-> [!NOTE] What was finished since the last update.
-
-## 9. Upcoming Focus
-> [!NOTE] What the team is tackling next week/month.
-
-## 10. Key Metrics Health
-> [!NOTE] Live data on project health (e.g., "Test Coverage: 85%", "Open Bugs: 12").
-
-## 11. Roadmap
-| Workstream | Status | Notes |
-| --- | --- | --- |
-| TBD | Planned | |
-
-## 12. Epics
-> [!NOTE] Active and upcoming epics.
-
-## 13. Risks / Blockers
-> [!NOTE] Immediate blockers holding up progress.
-
-## 14. Success Metrics
-> [!NOTE] How we measure if the goals of this document are achieved.
-
-## 15. Related Documents
-> [!NOTE] [Link to related document](path) - Short brief note about why it's related.
-
-## 16. Open Questions
-> [!NOTE] Any unresolved questions or assumptions. Can be empty.

package/docs/vibes/project-docs-template/foundation/workflow.md

@@ -1,59 +0,0 @@
-# Workflow
-
-Last update: YYYY-MM-DD
-
-Status: [Proposed | Draft | Live | Deprecated | Archived]
-
----
-
-## 1. Description
-> [!NOTE] Briefly describe the purpose of this document and what it contains.
-
-## 2. Important
-> [!NOTE] Notes of important findings or critical constraints. Can be empty.
-
-## 3. Table of Contents
-> [!NOTE] TOC goes here.
-
-## 4. Scope
-> [!NOTE] The boundaries of what this document covers.
-
-## 5. Goals
-> [!NOTE] What we aim to achieve with this specific document.
-
-## 6. Non Goals
-> [!NOTE] What is explicitly excluded from the scope of this document.
-
-## 7. Local Development Loop
-> [!NOTE] How to spin up and iterate.
-
-## 8. Branching Strategy
-> [!NOTE] GitFlow, Trunk-based, or custom rules. Diagram of branching logic is preferred. Use mermaid.
-
-```mermaid
-gitGraph
-    commit
-    branch develop
-    checkout develop
-    commit
-    branch feature
-    checkout feature
-    commit
-    checkout develop
-    merge feature
-```
-
-## 9. PR & Code Review Process
-> [!NOTE] Required approvers, templates, and conventions.
-
-## 10. Issue Tracking & Triage
-> [!NOTE] How bugs and features are logged.
-
-## 11. Success Metrics
-> [!NOTE] How we measure if the goals of this document are achieved.
-
-## 12. Related Documents
-> [!NOTE] [Link to related document](path) - Short brief note about why it's related.
-
-## 13. Open Questions
-> [!NOTE] Any unresolved questions or assumptions. Can be empty.

package/docs/vibes/project-docs-template/getting-started.md

@@ -1,52 +0,0 @@
-# Getting Started
-
-Last update: YYYY-MM-DD
-
-Status: [Proposed | Draft | Live | Deprecated | Archived]
-
----
-
-## 1. Description
-> [!NOTE] Explain how to set up, run, and orient a new contributor or operator in this repository.
-
-## 2. Important
-> [!NOTE] Notes of important findings or critical constraints. Can be empty.
-
-## 3. Table of Contents
-> [!NOTE] TOC goes here.
-
-## 4. Scope
-> [!NOTE] The boundaries of what this document covers.
-
-## 5. Goals
-> [!NOTE] What we aim to achieve with this specific document.
-
-## 6. Non Goals
-> [!NOTE] What is explicitly excluded from the scope of this document.
-
-## 7. Prerequisites
-> [!NOTE] Required tools, accounts, credentials, environment variables, or secrets handling.
-
-## 8. First Steps
-1. Clone or open the repository.
-2. Install dependencies or required tools.
-3. Configure local environment values.
-4. Run the standard startup or verification commands.
-
-## 9. Local Setup
-> [!NOTE] Detailed steps for install, environment bootstrap, and local run.
-
-## 10. Verification
-> [!NOTE] First validation command and where to find deeper testing guidance (e.g., `testing.md`).
-
-## 11. Troubleshooting
-> [!NOTE] List known setup issues and their solutions.
-
-## 12. Success Metrics
-> [!NOTE] How we measure if the goals of this document are achieved.
-
-## 13. Related Documents
-> [!NOTE] [Link to related document](path) - Short brief note about why it's related.
-
-## 14. Open Questions
-> [!NOTE] Any unresolved questions or assumptions. Can be empty.

package/docs/vibes/project-docs-template/operations/ci-cd.md

@@ -1,56 +0,0 @@
-# CI/CD Configuration
-
-Last update: YYYY-MM-DD
-
-Status: [Proposed | Draft | Live | Deprecated | Archived]
-
----
-
-## 1. Description
-> [!NOTE] Briefly describe the purpose of this document and what it contains.
-
-## 2. Important
-> [!NOTE] Notes of important findings or critical constraints. Can be empty.
-
-## 3. Table of Contents
-> [!NOTE] TOC goes here.
-
-## 4. Scope
-> [!NOTE] The boundaries of what this document covers.
-
-## 5. Goals
-> [!NOTE] What we aim to achieve with this specific document.
-
-## 6. Non Goals
-> [!NOTE] What is explicitly excluded from the scope of this document.
-
-## 7. Pipeline Architecture
-> [!NOTE] Overview of the branching and deployment flow. Flowcharts are preferred. Use mermaid.
-
-```mermaid
-graph LR
-    A[Commit] --> B[Build]
-    B --> C[Test]
-    C --> D[Deploy]
-```
-
-## 8. Build Steps
-> [!NOTE] Compilation, bundling, and artifact generation.
-
-## 9. Testing & Quality Gates
-> [!NOTE] Automated tests, linting, and security scans.
-
-## 10. Deployment Environments
-> [!NOTE] Staging, UAT, and Production definitions.
-
-## 11. Secrets & Environment Variables
-> [!NOTE] Required credentials (stored securely).
-
-## 12. Success Metrics
-> [!NOTE] How we measure if the goals of this document are achieved.
-
-## 13. Related Documents
-> [!NOTE] [Link to related document](path) - Short brief note about why it's related.
-
-## 14. Open Questions
-> [!NOTE] Any unresolved questions or assumptions. Can be empty.

package/docs/vibes/project-docs-template/operations/compliance.md

@@ -1,46 +0,0 @@
-# Compliance
-
-Last update: YYYY-MM-DD
-
-Status: [Proposed | Draft | Live | Deprecated | Archived]
-
----
-
-## 1. Description
-> [!NOTE] Briefly describe the purpose of this document and what it contains.
-
-## 2. Important
-> [!NOTE] Notes of important findings or critical constraints. Can be empty.
-
-## 3. Table of Contents
-> [!NOTE] TOC goes here.
-
-## 4. Scope
-> [!NOTE] The boundaries of what this document covers.
-
-## 5. Goals
-> [!NOTE] What we aim to achieve with this specific document.
-
-## 6. Non Goals
-> [!NOTE] What is explicitly excluded from the scope of this document.
-
-## 7. Data Privacy (GDPR / CCPA)
-> [!NOTE] PII handling and user consent.
-
-## 8. Data Retention Policy
-> [!NOTE] How long logs and backups are kept before deletion.
-
-## 9. Audit Logging
-> [!NOTE] Tracking who modified what, and when.
-
-## 10. Legal Disclaimers & Terms
-> [!NOTE] Required user agreements and copyright notices.
-
-## 11. Success Metrics
-> [!NOTE] How we measure if the goals of this document are achieved.
-
-## 12. Related Documents
-> [!NOTE] [Link to related document](path) - Short brief note about why it's related.
-
-## 13. Open Questions
-> [!NOTE] Any unresolved questions or assumptions. Can be empty.