git-repo-analyzer-test 1.0.0

package/docs/SonarCloud_Presentation_Points.md

@@ -0,0 +1,81 @@
+# SonarCloud Analysis — Points Covered (Presentation)
+
+**Use this for slides or a one-pager.** List format, optimized for presenting.
+
+---
+
+## 1. Quality Gate
+
+- Status: **OK** | **ERROR** | **NONE**
+- Conditions: metric key, status, threshold
+- Visual: Green (OK), Red (ERROR), Grey (NONE)
+
+---
+
+## 2. Metrics
+
+**Core (free tier)**  
+- Lines of code (ncloc)  
+- Bugs  
+- Vulnerabilities  
+- Code smells  
+- Coverage %  
+- Duplication %
+
+**Extended (when available)**  
+- Security hotspots (+ reviewed %)  
+- Maintainability / Reliability / Security ratings (A–E)  
+- Complexity & cognitive complexity  
+- Duplicated blocks, total lines  
+
+---
+
+## 3. Issues
+
+- List: key, rule, severity, file, line, message  
+- Severities: BLOCKER, CRITICAL, MAJOR, MINOR, INFO  
+- Breakdown: bugs, vulnerabilities, code smells, hotspots  
+- Chart: issues by severity  
+
+---
+
+## 4. Score & Rating
+
+- **Score:** 0–10 (from bugs, vulns, smells, quality gate, ratings, coverage)  
+- **Rating:** A+ to F  
+- Shown in KPI card and overall summary  
+
+---
+
+## 5. Recommendations
+
+- Quality gate → fix failing conditions  
+- Bugs → address reported bugs  
+- Vulnerabilities → remediate  
+- Code smells → reduce for maintainability  
+- Coverage → aim for 80%+  
+- Duplication → reduce duplicated lines  
+
+---
+
+## 6. Dashboard / UI
+
+- **KPI cards:** Quality Score, Quality Gate, Lines of Code, Total Issues  
+- **Charts:** Issues breakdown, Coverage & duplication, Issues by severity  
+- **Tiles:** LOC, bugs, vulns, smells, hotspots, duplication, coverage, complexity  
+- **Tables:** Quality gate conditions, issues list  
+- **Link:** Open project on SonarCloud  
+
+---
+
+## 7. APIs (Free Plan)
+
+- Quality gate status  
+- Measures / component (metrics)  
+- Issues search  
+
+---
+
+## One-line summary
+
+**Quality gate + core & extended metrics + issues + computed score/rating + recommendations + dashboard (KPIs, charts, tables, SonarCloud link).**

package/docs/UI_IMPROVEMENTS.md

@@ -0,0 +1,117 @@
+# UI Improvement Ideas for GitHub Repo Analyzer
+
+Prioritized by impact and effort. Pick what fits your goals.
+
+---
+
+## High impact, lower effort
+
+### 1. **Sticky report toolbar**
+When viewing results, keep a thin bar at the top with:
+- Repo name (link to GitHub)
+- **Analyze another** and **Export PDF**
+- Optional: anchor links to each section (Quality, Security, etc.)
+
+**Why:** Long reports require scrolling; actions stay visible without scrolling back up.
+
+### 2. **Loading progress steps**
+Instead of a single “Analyzing repository…”, show steps:
+- Fetching repository
+- Code quality
+- Security
+- Code review
+- Performance
+
+**Why:** Reduces perceived wait and makes it clear the app is working (and which step is slow).
+
+### 3. **Empty states with CTAs**
+When an analyzer has no token:
+- Short message + “Add token for live results” (and link to README or env docs).
+
+**Why:** Users understand why they see mock data and how to enable real data.
+
+### 4. **Keyboard & accessibility**
+- **Enter** in the repo input runs analysis.
+- After analysis, focus moves to the results area (or first section).
+- `aria-expanded` / `aria-controls` on collapsible section headers.
+- Visible focus styles for all interactive elements.
+
+**Why:** Faster for power users and better for screen readers and a11y.
+
+### 5. **Success feedback**
+- After PDF export: small toast or inline message “PDF downloaded” (and optionally filename).
+- After analysis: brief “Analysis complete” (can be subtle).
+
+**Why:** Clear confirmation that actions succeeded.
+
+### 6. **Copy repo / open on GitHub**
+- Next to the repo title: “Open on GitHub” (e.g. `https://github.com/owner/repo`) and “Copy link”.
+
+**Why:** Common next step is to open the repo or share the link.
+
+---
+
+## Medium impact
+
+### 7. **Expand / collapse all**
+Buttons: “Expand all” and “Collapse all” above the sections.
+
+**Why:** One click to scan all sections or to collapse and focus on scores.
+
+### 8. **Responsive tweaks**
+- Score cards: 2 columns on tablet, 1 on small mobile.
+- Section headers: larger tap target and spacing on touch devices.
+- Action buttons: full width on small screens if needed.
+
+**Why:** Usable on phones and tablets.
+
+### 9. **Theme toggle (dark / light)**
+- Toggle in header; store preference in `localStorage`.
+- Use CSS variables so one toggle switches the whole theme.
+
+**Why:** Preference for light mode in bright environments.
+
+### 10. **Recent repos (localStorage)**
+- Store last 3–5 analyzed repos; show as chips or a dropdown under the input.
+- Click to re-analyze.
+
+**Why:** Quick re-runs for the same repos.
+
+---
+
+## Higher effort, high impact
+
+### 11. **Streaming / progressive results**
+- API returns or streams results as each analyzer finishes.
+- UI shows sections as they become available (skeleton → content).
+
+**Why:** Feels faster and more responsive.
+
+### 12. **Comparison mode**
+- “Compare” a second repo; show two columns (or tabs) with scores and key metrics side by side.
+
+**Why:** Direct comparison for decision-making.
+
+### 13. **Charts**
+- Small charts for quality/security over time (if you add history) or for score breakdown (e.g. radar or bar chart).
+
+**Why:** Easier to see balance across dimensions.
+
+### 14. **Search / filter in report**
+- Filter findings by severity (e.g. only High/Critical) or by section.
+
+**Why:** Large reports become easier to navigate.
+
+---
+
+## Quick wins already in place
+- Full-width layout
+- Collapsible sections
+- Dark theme and clear typography
+- Score cards with color-coded borders
+- AI analysis sections with badges
+
+---
+
+**Suggested order to implement:**  
+Start with **1 (sticky toolbar)**, **2 (loading steps)**, and **4 (Enter key + focus)**; then add **3 (empty states)** and **5 (success feedback)**.