Skip to content

Commit 0241d33

Browse files
authored
Merge pull request #2 from chirag127/feat/agents-md-compliance-transformation-12461588129689024198
✨ AGENTS.md Compliance Transformation
2 parents 919b98c + 37f3d3b commit 0241d33

23 files changed

+1247
-2867
lines changed
File renamed without changes.
File renamed without changes.

PROPOSED_README.md

Lines changed: 45 additions & 186 deletions
Original file line numberDiff line numberDiff line change
@@ -1,188 +1,47 @@
11
# JSErrorFlow-Real-Time-Visualizer-Browser-Extension
22

3-
[![Build Status](https://img.shields.io/github/actions/workflow/status/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)
4-
[![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)
5-
[![Tech Stack](https://img.shields.io/badge/built%20with-TypeScript%2C%20Vite%2C%20WXT-blue?style=flat-square&logo=typescript)](https://github.com/vitejs/vite)
6-
[![License](https://img.shields.io/github/license/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension?style=flat-square&logo=opensourceinitiative)](LICENSE)
7-
[![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)
8-
9-
**JSErrorFlow** is a cutting-edge browser extension that visually highlights JavaScript errors directly on DOM elements in real-time, transforming frontend debugging into an intuitive, immediate visual experience. This developer tool significantly streamlines debugging, boosts productivity, and accelerates development cycles by enabling developers to pinpoint and resolve errors faster than ever before.
10-
11-
## Table of Contents
12-
13-
* [About the Project](#about-the-project)
14-
* [Key Features](#key-features)
15-
* [Architecture Overview](#architecture-overview)
16-
* [Getting Started](#getting-started)
17-
* [Development Workflow](#development-workflow)
18-
* [AI Agent Directives](#ai-agent-directives)
19-
* [Contributing](#contributing)
20-
* [License](#license)
21-
22-
## About the Project
23-
24-
In the fast-paced world of frontend development, quickly identifying and resolving JavaScript errors is paramount. JSErrorFlow provides an immediate, visual layer over your application's DOM, directly indicating where errors are occurring. Instead of sifting through console logs, developers can see errors manifested directly on the problematic elements, drastically reducing the time spent on debugging and increasing overall development velocity.
25-
26-
## Key Features
27-
28-
* **Real-time DOM Error Highlighting:** Visual cues on elements that trigger JavaScript errors.
29-
* **Intuitive Debugging:** Immediate visual feedback eliminates guesswork.
30-
* **Cross-Browser Compatibility:** Supports Chrome and Firefox.
31-
* **Developer-Focused:** Designed to integrate seamlessly into existing development workflows.
32-
* **Performance Optimized:** Built with Vite for lightning-fast build times.
33-
34-
## Architecture Overview
35-
36-
mermaid
37-
graph TD
38-
A[Browser Environment] --> B(WXT Framework)
39-
B --> C(Content Script)
40-
C --> D{DOM Monitoring & Error Interception}
41-
D --> E(Visual Overlay Injection)
42-
E --> F[User Interface]
43-
B --> G(Background Script)
44-
G --> H(API Communication - e.g., Error Reporting)
45-
F -.-> G
46-
47-
48-
This extension adopts a modern architecture centered around the [WXT (WebExtension Tooling)](https://github.com/wxt-dev/wxt) framework, leveraging TypeScript for type safety and Vite for rapid development. The core logic is split between content scripts, which interact directly with the webpage's DOM, and background scripts, which manage extension-wide state and communication.
49-
50-
## Getting Started
51-
52-
### Prerequisites
53-
54-
* Node.js 18+
55-
* npm or yarn
56-
57-
### Installation
58-
59-
1. **Clone the repository:**
60-
bash
61-
git clone https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension.git
62-
cd JSErrorFlow-Real-Time-Visualizer-Browser-Extension
63-
64-
65-
2. **Install Dependencies:**
66-
bash
67-
npm install
68-
# or
69-
# yarn install
70-
71-
72-
3. **Run in Development Mode:**
73-
WXT provides commands to run the extension in development mode, allowing for hot module replacement.
74-
bash
75-
npm run dev
76-
# or
77-
# yarn dev
78-
79-
80-
Follow the instructions in your browser to load the unpacked development extension.
81-
82-
### Build for Production
83-
84-
To create a production-ready build for Chrome and Firefox:
85-
86-
bash
87-
npm run build
88-
# or
89-
# yarn build
90-
91-
92-
This will generate distributable packages in the `dist` directory.
93-
94-
## Development Workflow
95-
96-
* **Core Technologies:** TypeScript, Vite, WXT, TailwindCSS (v4.0+).
97-
* **Linting & Formatting:** Biome for ultra-fast static analysis and code formatting.
98-
* **Testing:** Vitest for unit and integration tests, Playwright for end-to-end (E2E) testing.
99-
* **Architecture:** Feature-Sliced Design (FSD) principles for modularity and maintainability.
100-
101-
**Scripts:**
102-
103-
| Script | Description |
104-
|---------------|-------------------------------------------------|
105-
| `npm run dev` | Starts the development server with hot reloading. |
106-
| `npm run build` | Builds the extension for production. |
107-
| `npm run lint` | Runs Biome linter. |
108-
| `npm run format`| Runs Biome formatter. |
109-
| `npm run test` | Runs Vitest unit and integration tests. |
110-
| `npm run test:e2e` | Runs Playwright E2E tests. |
111-
112-
**Principles:**
113-
114-
* **SOLID:** Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, Dependency Inversion.
115-
* **DRY:** Don't Repeat Yourself.
116-
* **YAGNI:** You Ain't Gonna Need It.
117-
118-
## AI Agent Directives
119-
120-
<details>
121-
<summary>Click to expand AI Agent Directives</summary>
122-
123-
## SYSTEM: APEX TECHNICAL AUTHORITY & ELITE ARCHITECT (DECEMBER 2025 EDITION)
124-
125-
### 1. IDENTITY & PRIME DIRECTIVE
126-
**Role:** Senior Principal Software Architect, Master Technical Copywriter with 40+ years of elite industry experience. Operating with absolute precision, enforcing FAANG-level standards and the wisdom of "Managing the Unmanageable."
127-
**Context:** Current Date is **December 2025**. Building for the 2026 standard.
128-
**Output Standard:** EXECUTION-ONLY results. No plans; only executed code, updated docs, and applied fixes.
129-
**Philosophy:** "Zero-Defect, High-Velocity, Future-Proof."
130-
131-
### 2. INPUT PROCESSING & COGNITION
132-
* **SPEECH-TO-TEXT INTERPRETATION PROTOCOL:**
133-
* **Context:** User inputs may contain phonetic errors (homophones, typos).
134-
* **Semantic Correction:** **STRICTLY FORBIDDEN** from executing literal typos. Must **INFER** technical intent based on project context.
135-
* **Logic Anchor:** Treat the `README.md` as the **Single Source of Truth (SSOT)**.
136-
* **MANDATORY MCP INSTRUMENTATION:**
137-
* **No Guessing:** Do not hallucinate APIs.
138-
* **Research First:** Use `linkup`/`brave` to search for **December 2025 Industry Standards**, **Security Threats**, and **2026 UI Trends**.
139-
* **Validation:** Use `docfork` to verify *every* external API signature.
140-
* **Reasoning:** Engage `clear-thought-two` to architect complex flows *before* writing code.
141-
142-
### 3. CONTEXT-AWARE APEX TECH STACKS (LATE 2025 STANDARDS)
143-
**Directives:** Detect project type (`package.json` for JS/TS) and apply **Apex Toolchain**.
144-
145-
* **PRIMARY SCENARIO: WEB / APP / EXTENSION (TypeScript) - *This Repository Context***
146-
* **Stack:** TypeScript 6.x (Strict), Vite 7 (Rolldown), WXT (WebExtension Tooling 1.x), TailwindCSS v4.0+.
147-
* **State Management:** Signals (Standardized).
148-
* **Linting & Formatting:** Biome v2.x (Ultra-fast static analysis).
149-
* **Testing:** Vitest (Unit/Integration), Playwright (E2E).
150-
* **Architecture:** Feature-Sliced Design (FSD).
151-
152-
* **SECONDARY SCENARIO B: SYSTEMS / PERFORMANCE (Rust/Go) - *Not applicable here.***
153-
154-
* **TERTIARY SCENARIO C: DATA / SCRIPTS / AI (Python) - *Not applicable here.***
155-
156-
### 4. APEX NAMING CONVENTION (STAR VELOCITY ENGINE)
157-
**Formula:** `<Product-Name>-<Primary-Function>-<Platform>-<Type>`
158-
**Format:** `Title-Case-With-Hyphens` (e.g., `JSErrorFlow-Real-Time-Visualizer-Browser-Extension`).
159-
160-
### 5. REPOSITORY INTEGRITY & PURPOSE PIVOT PROTOCOL
161-
* **Identity Preservation:** Respect existing project type if viable.
162-
* **PURPOSE PIVOT:** Re-imagine vague/weak repositories as professional tools.
163-
* **PROFESSIONAL ARCHIVAL:** Treat archived repos as "Retired Products"; elevate metadata.
164-
165-
### 6. CHAIN OF THOUGHT (CoT) PROTOCOL
166-
Before execution, perform deep analysis:
167-
1. **Audit:** Analyze repo content and purpose.
168-
2. **Pivot/Archive Decision:** Rename if necessary (`Archived-...`).
169-
3. **Naming Strategy:** Apply `<Product>-<Function>-<Platform>-<Type>` formula.
170-
4. **Replication Protocol:** Draft AI Agent Directives (`AGENTS.md` or `<details>` block).
171-
5. **File Generation:** Plan content for all required files.
172-
6. **Final Polish:** Ensure all badges (`chirag127`, `flat-square`) and "Standard 11" compliance.
173-
7. **Strict Adherence:** `PROPOSED_README.md` must strictly follow `AGENTS.md` directives.
174-
175-
### 7. DYNAMIC URL & BADGE PROTOCOL
176-
* **Base URL:** `https://github.com/chirag127/<New-Repo-Name>`
177-
* **Badge URLs:** All Shields.io badges must point to the Base URL or specific workflows.
178-
* **Consistency:** Never use old repo names in links.
179-
180-
</details>
181-
182-
## Contributing
183-
184-
Contributions are welcome! Please read our [CONTRIBUTING.md](./.github/CONTRIBUTING.md) file for details on our code of conduct, and the process for submitting pull requests.
185-
186-
## License
187-
188-
This project is licensed under the CC BY-NC 4.0 License - see the [LICENSE](./LICENSE) file for details.
3+
**JSErrorFlow** is a professional-grade browser extension for real-time JavaScript error visualization and DOM inspection. It empowers developers to instantly identify, locate, and understand frontend errors by highlighting the exact DOM elements causing exceptions.
4+
5+
[![License: CC BY-NC 4.0](https://img.shields.io/badge/License-CC%20BY--NC%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc/4.0/)
6+
[![Build Status](https://img.shields.io/github/actions/workflow/status/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/ci.yml?branch=main)](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/actions)
7+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension)](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/releases)
8+
[![GitHub issues](https://img.shields.io/github/issues/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension)](https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension/issues)
9+
10+
---
11+
12+
## Architecture
13+
14+
```
15+
JSErrorFlow-Real-Time-Visualizer-Browser-Extension
16+
├── .github/
17+
│ ├── ISSUE_TEMPLATE/
18+
│ ├── workflows/
19+
│ │ └── ci.yml
20+
│ └── PULL_REQUEST_TEMPLATE.md
21+
├── extension/
22+
│ ├── assets/
23+
│ │ ├── css/
24+
│ │ ├── icons/
25+
│ │ └── js/
26+
│ ├── html/
27+
│ └── manifest.json
28+
├── scripts/
29+
│ └── create-icons.js
30+
├── src/
31+
│ └── ...
32+
├── tests/
33+
│ └── ...
34+
├── .gitignore
35+
├── AGENTS.md
36+
├── CONTRIBUTING.md
37+
├── LICENSE
38+
├── README.md
39+
└── package.json
40+
```
41+
42+
## Quickstart
43+
44+
1. Clone the repository: `git clone https://github.com/chirag127/JSErrorFlow-Real-Time-Visualizer-Browser-Extension.git`
45+
2. Install dependencies: `npm install`
46+
3. Build the extension: `npm run build`
47+
4. Load the `extension` directory into your browser.
File renamed without changes.

create-icons.js

Lines changed: 0 additions & 60 deletions
This file was deleted.

0 commit comments

Comments
 (0)