arcvision 0.2.4 → 0.2.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ArcVision
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,74 +1,85 @@
-# ArcVision CLI
-
-Architecture scanner for modern codebases that generates dependency graphs and visualizes your project structure.
-
-## Installation
-
-```bash
-npm install -g arcvision
-```
-
-## Usage
-
-### Quick Start
-1. Sign up at the ArcVision dashboard
-2. Create a project and name it
-3. Generate a CLI token
-4. Run: `arcvision link <token>`
-5. Run: `arcvision scan --upload`
-6. Open dashboard to see results
-
-### Commands
-
-#### Link to Project
-```bash
-arcvision link <token>
-```
-Link this CLI to a project via upload token.
-
-#### Scan Project
-```bash
-arcvision scan [directory] [options]
-```
-Scan the current directory and generate architecture map.
-
-Options:
-- `-u, --upload`: Upload to database
-
-The scan command will also output a blast radius analysis showing the file with the highest blast radius and its potential role on your codebase.
-
-**Blast Radius Analysis**: After scanning, the CLI will display a warning identifying the most critical file in your codebase:
-```
-⚠️ [filename] at the center of the system (blast radius: X out of Y). This file represents a single point of systemic failure. Changes here may affect many parts of the system.
-```
-This feature helps identify high-structure files that are imported by many other files, allowing you to be more cautious when modifying them.
-
-## Features
-
-- **Modern Import Resolution**: Handles path aliases (`@/components/*`), barrel files (`./utils` → `./utils/index.ts`), and directory imports
-- **AST-based Parsing**: Uses Babel parser for accurate import detection
-- **Multi-framework Support**: Works with React, Next.js, and other modern JavaScript frameworks
-- **Dependency Graph Generation**: Creates comprehensive node-edge relationships
-- **Blast Radius Analysis**: Identifies high-structure files that are imported by many other files
-- **Cloud Integration**: Uploads results to ArcVision dashboard for visualization
-
-## Supported Import Patterns
-
-- Relative imports: `./utils`, `../components`
-- Path aliases: `@/components/Button`, `~/lib/utils`
-- Barrel files: `./utils` resolves to `./utils/index.ts(x)`
-- Directory imports: `@/utils` resolves to `src/utils/index.ts(x)`
-- Implicit extensions: `.ts`, `.tsx`, `.js`, `.jsx`
-
-## Architecture
-
-The ArcVision CLI runs locally on your machine and:
-1. Scans your project files using AST parsing
-2. Detects import relationships between files
-3. Resolves path aliases using tsconfig.json/jsconfig.json
-4. Generates a dependency graph in JSON format
-5. Uploads the graph to the ArcVision dashboard via API
-
-## License
-
-MIT
+# ArcVision System Context Artifact
+
+## What This Is
+
+This file is the **canonical structural context** of this codebase.
+It represents how the system actually works — not how it is described.
+
+It is generated directly from source code by ArcVision.
+
+## What This Replaces
+
+This artifact replaces:
+- Manual repository scanning
+- Tribal knowledge held by senior engineers
+- Re-explaining the system to new developers
+- Re-prompting LLMs with partial or incorrect context
+- Guessing blast radius of changes
+
+## When You Must Use This
+
+Use this artifact when:
+- Onboarding a new developer
+- Prompting an AI assistant about this codebase
+- Making architectural changes
+- Investigating unexpected behavior
+- Assessing risk before modifying core modules
+
+## What This Artifact Contains
+
+- Canonical module and dependency graph
+- Execution and data flow relationships
+- Structural roles (service, store, boundary, etc.)
+- Invariants inferred from the system
+- Impact metrics (blast radius, coupling)
+
+## Determinism & Trust
+
+- Generated from commit: b63e62db4aedf6ffb21055dd88d13c8a947a7422
+- Generation timestamp: 2026-01-13T03:50:34.571Z
+- Tool version: 0.2.5
+- Deterministic: same input → same output
+- Explicit assumptions listed inside the artifact
+
+If this artifact conflicts with human memory, **trust the artifact**.
+
+## Structural Context Hubs
+
+The following files have the highest blast radius and represent critical structural hubs in the system:
+
+- **src/lib/utils.ts**
+  - Blast Radius: 62 files (14.73% of codebase)
+  - Risk: Changes here may silently propagate across the system.
+
+- **src/components/ui/button.tsx**
+  - Blast Radius: 49 files (11.64% of codebase)
+  - Risk: Acts as a coordination layer between components.
+
+- **src/lib/supabase/client.ts**
+  - Blast Radius: 45 files (10.69% of codebase)
+  - Risk: Modifications can cause widespread inconsistencies.
+
+
+
+## How to Use With AI
+
+When prompting AI tools, include this file as system context.
+Do not ask the AI to infer architecture without it.
+
+## When to Regenerate
+
+Regenerate this artifact when:
+- Core modules change
+- New services are added
+- Dependency structure shifts
+
+Run:
+
+```
+arcvision scan --upload
+```
+
+## Source of Truth
+
+This artifact is the **source of truth** for system structure.
+All explanations, decisions, and AI reasoning should reference it.