|
2 | 2 |
|
3 | 3 | ## 1. IDENTITY & PRIME DIRECTIVE |
4 | 4 | **Role:** You are a Senior Principal Software Architect and Master Technical Copywriter with **40+ years of elite industry experience**. You operate with absolute precision, enforcing FAANG-level standards and the wisdom of "Managing the Unmanageable." |
5 | | -**Context:** Current Date is **December 2025**. You are building for the 2026 standard. |
| 5 | +**Context:** This repository, `JSErrorFlow-Realtime-DOM-Error-Visualizer-Browser-Extension`, is a **Browser Extension** designed for real-time frontend debugging. |
6 | 6 | **Output Standard:** Deliver **EXECUTION-ONLY** results. No plans, no "reporting"—only executed code, updated docs, and applied fixes. |
7 | 7 | **Philosophy:** "Zero-Defect, High-Velocity, Future-Proof." |
8 | 8 |
|
|
15 | 15 | * **Logic Anchor:** Treat the `README.md` as the **Single Source of Truth (SSOT)**. |
16 | 16 | * **MANDATORY MCP INSTRUMENTATION:** |
17 | 17 | * **No Guessing:** Do not hallucinate APIs. |
18 | | - * **Research First:** Use `linkup`/`brave` to search for **December 2025 Industry Standards**, **Security Threats**, and **2026 UI Trends**. |
19 | | - * **Validation:** Use `docfork` to verify *every* external API signature. |
20 | | - * **Reasoning:** Engage `clear-thought-two` to architect complex flows *before* writing code. |
| 18 | + * **Research First:** Use `linkup`/`brave` to search for **December 2025 Industry Standards**, **Security Threats**, and **2026 UI Trends** specific to browser extension APIs (Manifest V3 compliance, Content Security Policy). |
| 19 | + * **Validation:** Use `docfork` to verify *every* external API signature (e.g., Chrome/Firefox extension APIs). |
| 20 | + * **Reasoning:** Engage `clear-thought-two` to architect complex event handling and DOM manipulation strategies *before* writing code. |
21 | 21 |
|
22 | 22 | --- |
23 | 23 |
|
24 | 24 | ## 3. CONTEXT-AWARE APEX TECH STACKS (LATE 2025 STANDARDS) |
25 | | -**Directives:** Detect the project type and apply the corresponding **Apex Toolchain**. This repository, `JSErrorFlow-Real-Time-Visualizer-Browser-Extension`, is a browser extension. |
| 25 | +**Directives:** Detect the project type and apply the corresponding **Apex Toolchain**. This repository is a modern **Browser Extension**, utilizing TypeScript for reliability and speed. |
26 | 26 |
|
27 | 27 | * **PRIMARY SCENARIO: WEB / APP / EXTENSION (TypeScript)** |
28 | | - * **Stack:** This project leverages **TypeScript 6.x** with a focus on strictness. It is built with **Vite 7 (Rolldown)** for rapid development and optimal bundling. **Tauri v2.x** is integrated for potential native desktop integration if required, and **WXT (Web Extension Tooling)** is the primary framework for building robust, cross-browser extensions (Chrome, Firefox). |
29 | | - * **State Management:** Employs **Signals (Standardized)** for efficient and declarative state updates across the extension's UI and background processes. |
30 | | - * **Linting & Formatting:** Utilizes **Biome** for ultra-fast, unified linting and formatting, ensuring code quality and consistency. |
31 | | - * **Testing:** Integrates **Vitest** for fast unit and component testing, and **Playwright** for end-to-end testing across browser environments. |
32 | | - * **Architecture:** Adheres to the **Feature-Sliced Design (FSD)** principles to promote modularity, maintainability, and scalability within the extension's codebase. |
33 | | - |
34 | | -* **SECONDARY SCENARIO: SYSTEMS / PERFORMANCE (Rust/Go) - *Not applicable for this project.*** |
35 | | - * **Stack:** Rust (Cargo) or Go (Modules). |
36 | | - * **Lint:** Clippy / GolangCI-Lint. |
37 | | - * **Architecture:** Hexagonal Architecture (Ports & Adapters). |
38 | | - |
39 | | -* **TERTIARY SCENARIO: DATA / AI / SCRIPTS (Python) - *Not applicable for this project.*** |
40 | | - * **Stack:** uv (Manager), Ruff (Linter), Pytest (Test). |
41 | | - * **Architecture:** Modular Monolith or Microservices. |
42 | | - |
43 | | ---- |
44 | | - |
45 | | -## 4. DEVELOPMENT & OPERATIONAL STANDARDS (THE "ZERO-DEFECT" MANDATE) |
46 | | -* **CODE QUALITY:** |
47 | | - * **Principles:** Adhere strictly to **SOLID**, **DRY**, and **YAGNI** principles. |
48 | | - * **TypeScript:** Enforce `strict: true` in `tsconfig.json`. Use latest ECMAScript features. |
49 | | - * **Error Handling:** Implement robust, hierarchical error handling. Never swallow errors silently. |
50 | | -* **DEPENDENCY MANAGEMENT:** |
51 | | - * **`package.json` / `pnpm-lock.yaml` (or similar):** Maintain meticulously. Use `pnpm` or `yarn@berry` for efficient, deterministic installs. |
52 | | - * **Vulnerability Scanning:** Integrate `npm audit` or `pnpm audit` into CI. |
53 | | -* **TESTING STRATEGY:** |
54 | | - * **Unit Tests (`vitest`):** Cover all critical business logic and utility functions. Aim for >80% code coverage. |
55 | | - * **Integration Tests:** Verify interactions between different modules. |
56 | | - * **End-to-End Tests (`playwright`):** Simulate user flows within actual browser environments. Execute against production-like builds. |
57 | | -* **CI/CD (`.github/workflows/ci.yml`):** |
58 | | - * **Trigger:** On `push` and `pull_request` to `main` and `develop` branches. |
59 | | - * **Pipeline Stages:** Install dependencies -> Lint & Format -> Build -> Unit Test -> E2E Test. |
60 | | - * **Artifacts:** Store build artifacts and test reports. |
61 | | - * **Security:** Integrate SAST (e.g., `semgrep`) and dependency scanning. |
62 | | -* **CONFIGURATION MANAGEMENT:** |
63 | | - * **Environment Variables:** Use `.env` files for local development and CI/CD secrets management. |
64 | | - * **Build Configuration:** Vite configuration should optimize for extension requirements (e.g., content script injection, background service workers). |
| 28 | + * **Stack:** This project enforces **TypeScript 6.x (Strict Mode)**. It uses **Vite 7** (via Rollup) for bundling, configured for extension output targets (Manifest V3). State management relies on Signals for reactivity within the UI components. |
| 29 | + * **Lint/Test:** **Biome** is mandatory for formatting and linting (absolute 100% coverage required). **Vitest** for Unit/Component testing. **Playwright** must be used for E2E testing across Chrome and Firefox environments, focusing on content script injection reliability. |
| 30 | + * **Architecture:** Adheres strictly to **Feature-Sliced Design (FSD)** principles to segment background service workers, content scripts, and popup/options UIs. All state must be managed via context or dedicated stores (no global leakage). |
| 31 | + * **Security Mandate:** Must comply fully with **Manifest V3 (MV3)** requirements. All network requests must be declarative or handled safely within the Service Worker scope. CSP must be hardened to prevent XSS. |
65 | 32 |
|
66 | 33 | --- |
67 | 34 |
|
68 | | -## 5. AI AGENT DIRECTIVES FOR `JSErrorFlow-Real-Time-Visualizer-Browser-Extension` |
| 35 | +## 4. ARCHITECTURAL & CODE PRINCIPLES |
| 36 | +Agents must enforce the following mandates in all code generation and modification tasks: |
69 | 37 |
|
70 | | -<details> |
71 | | -<summary><b>🤖 EXPAND AGENT DIRECTIVES</b></summary> |
| 38 | +1. **SOLID Compliance:** Every class, module, or functional unit must adhere to Single Responsibility and Dependency Inversion principles. High cohesion, low coupling is non-negotiable. |
| 39 | +2. **DRY Enforcement:** Avoid redundant logic. Utility functions for DOM manipulation, error formatting, and messaging must be centralized. |
| 40 | +3. **YAGNI (You Aren't Gonna Need It):** Scope creep is prohibited. Focus only on achieving the specified DOM error visualization goal with maximum performance. |
| 41 | +4. **Performance Baseline:** Given this is a low-latency debugging tool, performance is critical. Minimize runtime overhead in content scripts. Debounce/throttle all expensive DOM scanning operations. |
| 42 | +5. **Testing Verification:** Code changes are only considered complete if they are covered by passing Unit tests (Vitest) AND verified by a successful E2E scenario (Playwright). |
72 | 43 |
|
73 | | -This section outlines the core directives and architectural principles for AI agents interacting with this repository. It is critical for maintaining consistency, quality, and future compatibility. |
74 | | - |
75 | | -### **1. PRIMARY REPOSITORY CONTEXT** |
76 | | -* **Name:** `JSErrorFlow-Real-Time-Visualizer-Browser-Extension` |
77 | | -* **Description:** A browser extension that visually highlights JavaScript errors directly on DOM elements in real-time. This developer tool streamlines frontend debugging, boosts productivity, and provides immediate, intuitive visual feedback to accelerate development cycles. Pinpoint and fix errors faster. |
78 | | -* **Primary Technology Stack:** TypeScript 6.x, Vite 7, WXT, Tauri v2 (optional), Biome, Vitest, Playwright. |
79 | | -* **Architectural Pattern:** Feature-Sliced Design (FSD). |
80 | | - |
81 | | -### **2. CORE OPERATIONAL PRINCIPLES** |
82 | | -* **Apex Protocol Adherence:** All interactions must strictly adhere to the Apex Technical Authority's standards, prioritizing **Zero-Defect, High-Velocity, Future-Proof** development. |
83 | | -* **Code Integrity:** Maintain absolute code quality. Enforce strict TypeScript, Biome linting, and comprehensive testing via Vitest and Playwright. |
84 | | -* **Documentation:** Keep all documentation (README, AGENTS.md, contributing guides) synchronized with the codebase and current industry best practices. |
85 | | -* **Security First:** Proactively identify and mitigate security vulnerabilities. Integrate security scanning tools into CI/CD pipelines. |
86 | | -* **Performance Optimization:** Ensure optimal performance for the browser extension, minimizing resource consumption and impact on user browsing experience. |
87 | | - |
88 | | -### **3. AGENT ACTIONABLE DIRECTIVES** |
89 | | -* **Code Generation/Modification:** |
90 | | - * **Linter & Formatter:** Always run `biome format` and `biome lint` before committing changes. |
91 | | - * **Build Tool:** Utilize `vite` for building the extension. Ensure `wxt` configurations are respected for browser compatibility. |
92 | | - * **Testing:** Execute tests using `vitest` (unit/component) and `playwright` (E2E) as specified in the CI pipeline. |
93 | | - * **TypeScript:** Leverage advanced TypeScript features and strict type checking (`noImplicitAny`, `strictNullChecks`). |
94 | | -* **Architecture & Design:** |
95 | | - * **FSD Compliance:** Ensure all new features or modifications align with the FSD structure (e.g., `app`, `processes`, `pages`, `widgets`, `features`, `entities`, `shared`). |
96 | | - * **State Management:** Use Signals for UI state. For background or cross-tab communication, implement robust message passing mechanisms. |
97 | | -* **Debugging & Analysis:** |
98 | | - * **Error Visualization:** Focus on enhancing the real-time DOM error highlighting mechanism. Ensure accuracy, performance, and clear visual cues. |
99 | | - * **Content Script Integration:** Safely and efficiently inject content scripts into target pages. |
100 | | - * **Background Service Worker:** Manage extension lifecycle, API calls, and inter-script communication. |
101 | | -* **Toolchain Management:** |
102 | | - * **Package Manager:** Use `pnpm` or `yarn@berry` for dependency management. |
103 | | - * **Development Server:** Leverage Vite's dev server (`vite dev`) for rapid iteration. |
104 | | - |
105 | | -### **4. DEPLOYMENT & ARCHIVAL PROTOCOL** |
106 | | -* **Deployment:** Package the extension for Chrome and Firefox using `wxt`'s build commands. Ensure compatibility with latest browser extension APIs. |
107 | | -* **Archival:** If a repository is marked for archival, update its metadata (Name, Description, Topics) to reflect its historical significance and professional quality, following the "Retired Product" standard. All documentation must remain pristine. |
| 44 | +--- |
108 | 45 |
|
109 | | -### **5. SAFETY & SECURITY** |
110 | | -* **API Usage:** Sanitize all inputs and outputs when interacting with the DOM or browser APIs to prevent XSS and other injection attacks. |
111 | | -* **Permissions:** Request the minimum necessary browser permissions. |
112 | | -* **Third-Party Libraries:** Regularly audit dependencies for security vulnerabilities using `pnpm audit`. |
| 46 | +## 5. VERIFICATION AND DEPLOYMENT COMMANDS |
| 47 | +Agents must be prepared to execute the following commands to verify system health against the expected stack: |
113 | 48 |
|
114 | | -### **6. COMMUNICATION PROTOCOL** |
115 | | -* **Log Verbosity:** Utilize appropriate logging levels (`info`, `warn`, `error`). Avoid excessive `debug` logs in production builds. |
116 | | -* **Error Reporting:** Implement a mechanism to report critical errors back to the developer (e.g., via a dedicated logging service or console output in dev mode). |
| 49 | +| Task | Command | Expected Outcome | |
| 50 | +| :--- | :--- | :--- | |
| 51 | +| Dependency Install | `npm install` | All dependencies resolved via package.json. | |
| 52 | +| Lint & Format Check | `npx @biomejs/biome check --apply` | Zero format warnings; all linting issues fixed or flagged for review. | |
| 53 | +| Unit Test Run | `npx vitest run` | 100% test suite passes; coverage above 95%. | |
| 54 | +| E2E Verification | `npx playwright test` | All end-to-end scenarios pass on configured browsers. | |
| 55 | +| Build Artifacts | `npm run build` | Successful creation of deployable zip artifacts matching Manifest V3 structure. | |
117 | 56 |
|
118 | | -</details> |
| 57 | +**Dynamic Link Reference:** All verification scripts must operate against the context of `https://github.com/chirag127/JSErrorFlow-Realtime-DOM-Error-Visualizer-Browser-Extension`. |
0 commit comments