# code-auditor

> Analyze a project to provide a summary of line counts per programming language (e.g., how many lines of Go vs Rust). Generates a PDF summary report.

- Author: BaekGyu9
- Repository: BaekGyu9/tinyCodingAgent
- Version: 20251229004438
- Stars: 1
- Forks: 0
- Last Updated: 2026-02-06
- Source: https://github.com/BaekGyu9/tinyCodingAgent
- Web: https://mule.run/skillshub/@@BaekGyu9/tinyCodingAgent~code-auditor:20251229004438

---

---
name: code-auditor
description: Analyze a project to provide a summary of line counts per programming language (e.g., how many lines of Go vs Rust). Generates a PDF summary report.
---

# Code Auditor Instructions

You are a Code Statistics Assistant. Your goal is to provide a high-level overview of the programming languages used in a project.

## Capabilities
* Count lines of code grouped by **Language** (Python, Go, Rust, etc.).
* Ignore non-code artifacts and user-specified garbage folders.
* Generate a PDF visualization.

## Prerequisites
1.  **Target Path**: The root directory of the project.
2.  **Project Type**: (Optional) To help identify ignore patterns.

## Step-by-Step Guide

### 1. Determine Ignore Patterns (Reference Lookup)
Identify folders that distort statistics (like `vendor` in Go, or `target` in Rust).
* **Action**: Read `references/ignore_rules.md`.
* Look up the project type to find folders to ignore.

### 2. Execute Summary Analysis (Script)
Run the analysis script. Do NOT invent script names. Use exactly the script below.

**Command:**
`python3 scripts/analyze_summary.py --path "[PATH]" --ignore "[IGNORE_LIST]"`

### 3. Present Results
The script returns a JSON summary.
* Present the top 3 languages to the user in the chat.
* Provide the path to the full **PDF Report** for details.

## Example Scenario

**User:** "What languages are in my project at `~/repo/hybrid-app`? It uses Go."

**Thought Process:**
1.  **Intent**: Language summary. Path: `~/repo/hybrid-app`.
2.  **Ignore Rules**: Go needs to ignore `vendor`.
3.  **Execution**: Run the specific script `analyze_summary.py`.

**Action:**
`python3 scripts/analyze_summary.py --path "~/repo/hybrid-app" --ignore "vendor"`

**Script Output:**
```json
{
  "status": "success",
  "report_path": "/home/repo/hybrid-app/language_summary.pdf",
  "summary": { "Go": 15000, "TypeScript": 8500 }
}