Skip to content

Commit e7e29ee

Browse files
committed
docs: update README.md via Apex Optimizer
1 parent 74861d6 commit e7e29ee

File tree

1 file changed

+70
-189
lines changed

1 file changed

+70
-189
lines changed

README.md

Lines changed: 70 additions & 189 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,82 @@
1-
# JSErrorFlow: Real-Time DOM Visualizer for JavaScript Debugging
1+
<!-- Hero Banner/Logo Here -->
22

3-
4-
[![Build Status](https://img.shields.io/github/actions/workflow/user/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/ci.yml?style=flat-square&logo=githubactions)](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/actions/workflows/ci.yml)
5-
[![Code Coverage](https://img.shields.io/codecov/c/github/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension?style=flat-square&logo=codecov)](https://codecov.io/gh/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension)
6-
[![JavaScript](https://img.shields.io/badge/language-javascript-brightgreen?style=flat-square&logo=javascript)](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
7-
[![TypeScript](https://img.shields.io/badge/language-typescript-blue?style=flat-square&logo=typescript)](https://www.typescriptlang.org/)
8-
[![Vite](https://img.shields.io/badge/framework-vite-purple?style=flat-square&logo=vite)](https://vitejs.dev/)
9-
[![WXT](https://img.shields.io/badge/framework-wxt-orange?style=flat-square&logo=wxt)](https://wxt.dev/)
3+
[![Build Status](https://img.shields.io/github/actions/workflow/status/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/ci.yml?branch=main&style=flat-square)](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/actions/workflows/ci.yml)
104
[![License](https://img.shields.io/github/license/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension?style=flat-square)](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/blob/main/LICENSE)
11-
[![GitHub Stars](https://img.shields.io/github/stars/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension?style=flat-square&logo=github)](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension)
5+
[![JavaScript](https://img.shields.io/badge/language-JavaScript-yellow?style=flat-square)]()
6+
[![TypeScript](https://img.shields.io/badge/language-TypeScript-blue?style=flat-square)]()
7+
[![Vite](https://img.shields.io/badge/built%20with-Vite-blueviolet?style=flat-square)]()
8+
[![GitHub Stars](https://img.shields.io/github/stars/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension?style=flat-square)](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/stargazers)
9+
10+
11+
12+
13+
14+
<p align="center"><b>Star ⭐ this Repo</b></p>
15+
16+
<br>
17+
18+
A browser extension that visually highlights JavaScript errors directly on DOM elements, providing immediate feedback.
19+
Streamline frontend debugging and boost productivity with real-time error visualization.
1220

13-
**JSErrorFlow** is a cutting-edge 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.
21+
## Table of Contents
1422

15-
## 🚀 Features
23+
- [Features](#features)
24+
- [Installation](#installation)
25+
- [Usage](#usage)
26+
- [Contributing](#contributing)
27+
- [License](#license)
28+
- [AI Agent Directives](#ai-agent-directives)
1629

17-
* **Real-Time Error Highlighting:** Errors are visualized directly on the affected DOM elements as they occur.
18-
* **Intuitive Visual Feedback:** Understand error context at a glance without deep console diving.
19-
* **Cross-Browser Compatibility:** Designed for Chrome and Firefox.
20-
* **Developer Productivity Boost:** Accelerate debugging and development cycles significantly.
30+
## Features
2131

22-
---
32+
- **Real-time Error Highlighting:** Visually identify JavaScript errors on DOM elements as they occur.
33+
- **Streamlined Debugging:** Pinpoint and fix errors faster with immediate visual feedback.
34+
- **Enhanced Productivity:** Reduce debugging time and improve overall development efficiency.
35+
- **Cross-Browser Compatibility:** Supports Chrome and Firefox.
36+
- **Vite & TypeScript:** Built with modern tools for optimal performance and maintainability.
2337

24-
## 🏛️ Architecture
38+
## Installation
2539

26-
mermaid
27-
graph TD
28-
A[Browser Environment] --> B{JSErrorFlow Extension}
29-
B --> C[Content Script: DOM Monitoring & Error Detection]
30-
C --> D[Content Script: Error Visualization Logic]
31-
D --> E[Content Script: Direct DOM Manipulation]
32-
B --> F[Background Script: Event Handling & Messaging]
33-
F <--> G[Browser APIs]
34-
B --> H[Popup/Devtools Panel (Optional): Configuration & Summaries]
35-
H <--> G
40+
### Chrome
3641

42+
1. Clone this repository: `git clone https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension.git`
43+
2. Navigate to `chrome://extensions/` in your Chrome browser.
44+
3. Enable "Developer mode" in the top right corner.
45+
4. Click "Load unpacked" and select the `dist` directory from the cloned repository.
3746

38-
## 📄 Table of Contents
47+
### Firefox
3948

40-
* [🚀 Features](#-features)
41-
* [🏛️ Architecture](#️-architecture)
42-
* [📄 Table of Contents](#-table-of-contents)
43-
* [🤖 AI Agent Directives](#-ai-agent-directives)
44-
* [🔧 Development Setup](#-development-setup)
45-
* [📦 Build & Development Scripts](#-build--development-scripts)
46-
* [🛡️ Principles](#️-principles)
47-
* [📜 License](#license)
48-
* [⭐ Support](#⭐-support)
49+
1. Clone this repository: `git clone https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension.git`
50+
2. Navigate to `about:debugging#/runtime/this-firefox` in your Firefox browser.
51+
3. Click "Load Temporary Add-on..." and select the `manifest.json` file from the cloned repository.
4952

50-
---
53+
## Usage
5154

52-
## 🤖 AI Agent Directives
55+
1. Open a web page with JavaScript enabled.
56+
2. The extension will automatically highlight any DOM elements with JavaScript errors.
57+
3. Inspect the highlighted elements to identify and fix the errors.
58+
59+
## Contributing
60+
61+
See [CONTRIBUTING.md](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/blob/main/.github/CONTRIBUTING.md) for details on how to contribute.
62+
63+
## License
64+
65+
This project is licensed under the [CC BY-NC 4.0 License](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/blob/main/LICENSE) - see the [LICENSE](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/blob/main/LICENSE) file for details.
5366

5467
<details>
55-
<summary><code>Expand for Agent Directives</code></summary>
68+
<summary><b>🤖 AI Agent Directives</b></summary>
5669

57-
# SYSTEM: APEX TECHNICAL AUTHORITY & ELITE ARCHITECT (DECEMBER 2025 EDITION)
70+
text
71+
## SYSTEM: APEX TECHNICAL AUTHORITY & ELITE ARCHITECT (DECEMBER 2025 EDITION)
5872

59-
## 1. IDENTITY & PRIME DIRECTIVE
73+
### 1. IDENTITY & PRIME DIRECTIVE
6074
**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."
6175
**Context:** Current Date is **December 2025**. You are building for the 2026 standard.
6276
**Output Standard:** Deliver **EXECUTION-ONLY** results. No plans, no "reporting"—only executed code, updated docs, and applied fixes.
6377
**Philosophy:** "Zero-Defect, High-Velocity, Future-Proof."
6478

65-
---
66-
67-
## 2. INPUT PROCESSING & COGNITION
79+
### 2. INPUT PROCESSING & COGNITION
6880
* **SPEECH-TO-TEXT INTERPRETATION PROTOCOL:**
6981
* **Context:** User inputs may contain phonetic errors (homophones, typos).
7082
* **Semantic Correction:** **STRICTLY FORBIDDEN** from executing literal typos. You must **INFER** technical intent based on the project context.
@@ -75,148 +87,17 @@ graph TD
7587
* **Validation:** Use `docfork` to verify *every* external API signature.
7688
* **Reasoning:** Engage `clear-thought-two` to architect complex flows *before* writing code.
7789

78-
---
79-
80-
## 3. CONTEXT-AWARE APEX TECH STACKS (LATE 2025 STANDARDS)
81-
**Directives:** Detect the project type and apply the corresponding **Apex Toolchain**. This repository, `JSErrorFlow-Real-Time-Visualizer-Browser-Extension`, is a browser extension project.
82-
83-
* **PRIMARY SCENARIO A: WEB / APP / EXTENSION (TypeScript/JavaScript)**
84-
* **Stack:** This project leverages **TypeScript 6.x** and **JavaScript**. Key tools include **Vite 7 (Rolldown)** for fast builds, **WXT (Web Extension Tooling)** for streamlined extension development, and **Biome** for lightning-fast linting and formatting.
85-
* **Architecture:** Employs a **Modular Architecture** suitable for browser extensions, with clear separation between content scripts, background scripts, and potential UI panels (like popups or devtools). Adheres to **Feature-Sliced Design (FSD)** principles where applicable for maintainable code organization.
86-
* **Linting & Formatting:** **Biome** is mandated for code quality and consistency across the project. Its speed ensures minimal disruption to development velocity.
87-
* **Testing:** **Vitest** is the standard for unit and component testing, integrated seamlessly with Vite. **Playwright** is mandated for end-to-end (E2E) testing to simulate real user interactions across different browser environments.
88-
* **Styling:** **Tailwind CSS v4** is the preferred utility-first CSS framework for rapid UI development.
89-
90-
* **SECONDARY SCENARIO B: SYSTEMS / PERFORMANCE (Rust/Go) - *Not applicable.***
91-
* **TERTIARY SCENARIO C: DATA / AI / SCRIPTS (Python) - *Not applicable.***
92-
93-
---
94-
95-
## 4. OPERATIONAL PROTOCOLS
96-
* **CODE QUALITY & VERIFICATION:**
97-
* **Strict Linting:** All code must pass Biome checks without errors or warnings.
98-
* **Testing Coverage:** Maintain a minimum of **85% code coverage** via Vitest.
99-
* **E2E Validation:** All critical user flows must pass Playwright E2E tests.
100-
* **Type Safety:** **MANDATORY** TypeScript strict mode (`"strict": true`). Utilize `any` sparingly and only when absolutely necessary and justified.
101-
* **Immutable State:** Prefer immutable data structures and state management patterns.
102-
* **DEVELOPMENT VELOCITY:**
103-
* **Fast Feedback Loops:** Leverage Vite's HMR (Hot Module Replacement) for instantaneous UI updates.
104-
* **Automated CI/CD:** Robust GitHub Actions workflows must execute on every push and pull request.
105-
* **Dependency Management:** Utilize `npm` or `yarn` (with lockfiles) for predictable and reproducible builds.
106-
* **SECURITY:**
107-
* **Dependency Auditing:** Regularly run `npm audit` or equivalent to identify and mitigate vulnerabilities.
108-
* **Least Privilege:** Background and content scripts should only request the minimum necessary permissions.
109-
* **Sanitization:** Implement robust input sanitization, especially for messages passed between scripts and from external sources.
110-
* **Secrets Management:** **NEVER** hardcode secrets. Utilize environment variables or secure storage mechanisms provided by the browser extension framework.
111-
* **ARCHITECTURE & DESIGN:**
112-
* **SOLID Principles:** Adhere to SOLID principles in all code design.
113-
* **DRY (Don't Repeat Yourself):** Avoid code duplication.
114-
* **YAGNI (You Ain't Gonna Need It):** Implement only what is currently required.
115-
* **COMMUNICATION:**
116-
* **Clear Commit Messages:** Follow Conventional Commits standard (`feat:`, `fix:`, `chore:`, etc.).
117-
* **Meaningful PR Descriptions:** Detail changes, rationale, and testing performed.
118-
119-
---
120-
121-
## 5. STANDARD 11 MANDATE
122-
All repositories **MUST** adhere to the following professional standards:
123-
1. **README.md:** Comprehensive project overview, setup, and usage.
124-
2. **PROPOSED_README.md:** Draft for review based on AGENTS.md.
125-
3. **badges.yml:** Configuration for dynamic badges.
126-
4. **LICENSE:** Specify the license (CC BY-NC 4.0).
127-
5. **.gitignore:** Standard ignore file for the tech stack.
128-
6. **.github/workflows/ci.yml:** CI/CD pipeline configuration.
129-
7. **.github/CONTRIBUTING.md:** Guidelines for contributors.
130-
8. **.github/ISSUE_TEMPLATE/*:** Issue templates for bug reports, features, etc.
131-
9. **.github/PULL_REQUEST_TEMPLATE.md:** PR template.
132-
10. **.github/SECURITY.md:** Security policy and reporting.
133-
11. **AGENTS.md:** This document, detailing the AI Agent's directives.
134-
135-
---
136-
137-
## 6. PRODUCTIVITY ENHANCEMENTS
138-
* **Live Reloading:** Vite's HMR ensures instant feedback.
139-
* **Automated Testing:** Vitest and Playwright catch regressions early.
140-
* **Linters & Formatters:** Biome enforces consistent code style.
141-
142-
</details>
143-
144-
---
145-
146-
## 🔧 Development Setup
147-
148-
1. **Clone the Repository:**
149-
bash
150-
git clone https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension.git
151-
cd JSErrorFlow-Real-Time-Visualizer-Browser-Extension
152-
153-
154-
2. **Install Dependencies:**
155-
bash
156-
npm install
157-
# or
158-
yarn install
159-
160-
161-
3. **Run in Development Mode:**
162-
This command starts the Vite development server and builds the extension in watch mode. You can then load the extension in your browser (e.g., Chrome, Firefox) from the `dist` folder.
163-
bash
164-
npm run dev
165-
# or
166-
yarn dev
167-
168-
169-
4. **Run Linters & Formatters:**
170-
Ensure your code adheres to the project's coding standards.
171-
bash
172-
npm run lint
173-
# or
174-
yarn lint
175-
176-
177-
5. **Run Tests:**
178-
Execute unit and E2E tests.
179-
bash
180-
npm test
181-
# or
182-
yarn test
183-
184-
185-
---
186-
187-
## 📦 Build & Development Scripts
188-
189-
| Script | Description |
190-
| :---------- | :---------------------------------------------------- |
191-
| `dev` | Start development server with hot module replacement. |
192-
| `build` | Build the extension for production. |
193-
| `preview` | Locally preview production build. |
194-
| `lint` | Run Biome linter and formatter. |
195-
| `test` | Run Vitest unit tests. |
196-
| `test:e2e` | Run Playwright end-to-end tests. |
197-
| `coverage` | Generate code coverage report.
198-
199-
---
200-
201-
## 🛡️ Principles
202-
203-
This project is built upon the following core software engineering principles:
204-
205-
* **SOLID:** Designing for maintainability and extensibility.
206-
* **DRY (Don't Repeat Yourself):** Avoiding redundant code.
207-
* **YAGNI (You Ain't Gonna Need It):** Focusing on current requirements.
208-
* **KISS (Keep It Simple, Stupid):** Favoring straightforward solutions.
209-
210-
---
211-
212-
## 📜 License
213-
214-
This project is licensed under the **Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0)**. See the [LICENSE](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/blob/main/LICENSE) file for more details.
215-
216-
---
90+
### 3. CONTEXT-AWARE APEX TECH STACKS (LATE 2025 STANDARDS)
91+
**Directives:** Detect the project type (`pyproject.toml` for Python) and apply the corresponding **Apex Toolchain**. This repository, `PRFusion-AI-Powered-GitHub-Automation-CLI-Toolkit`, is a Python-based AI automation tool.
92+
93+
* **PRIMARY SCENARIO: DATA / SCRIPTS / AI (Python)**
94+
* **Stack:** This project leverages **Python 3.10+**. Key tools include **uv** (for package management and dependency resolution), **Ruff** (for ultra-fast linting and formatting), and **Pytest** (for robust unit and integration testing).
95+
* **Architecture:** Adheres to a **Modular Monolith** pattern, ensuring clear separation of concerns for features like GitHub API interaction, AI processing, and CLI interface, while maintaining a unified deployment.
96+
* **AI Integration:** Deeply integrated with **Google Gemini API** (`gemini-3-pro` by default) for intelligent batch-processing and decision-making on GitHub resources. Prioritize modular design, clear API contracts, and robust error handling for all AI model interactions.
97+
* **CLI Framework:** Uses `Click` or similar for a powerful and intuitive command-line interface.
98+
99+
* **SECONDARY SCENARIO A: WEB / APP / EXTENSION (TypeScript) - *Not applicable for this project's primary function. Reference only for potential future web-based extensions.***
100+
* **Stack:** TypeScript 6.x (Strict), Vite 7 (Rolldown), Tauri v2.x (Native), WXT (Extensions).
101+
* **State:** Signals (Standardized).
217102

218-
## ⭐ Support
219-
220-
If you find this project valuable, please consider starring the repository on GitHub! Your support fuels future development.
221-
222-
[<img src="https://img.shields.io/github/stars/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension?color=blue&label=Star%20on%20GitHub&logo=github" alt="Star on GitHub" />](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/stargazers)
103+
</details>

0 commit comments

Comments
 (0)