refactor: split CLI module into focused formatters and groupers

- Created cli/groupers/ViolationGrouper.ts for severity filtering
- Created cli/formatters/OutputFormatter.ts for violation formatting
- Created cli/formatters/StatisticsFormatter.ts for metrics display
- Reduced cli/index.ts from 484 to 260 lines (46% reduction)
- All 345 tests pass, CLI output identical to before
- No breaking changes
This commit is contained in:
imfozilbek
2025-11-25 16:30:04 +05:00
parent b5f54fc3f8
commit 7fea9a8fdb
7 changed files with 361 additions and 273 deletions

View File

@@ -5,6 +5,19 @@ All notable changes to @samiyev/guardian will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.7.6] - 2025-11-25
### Changed
- ♻️ **Refactored CLI module** - improved maintainability and separation of concerns:
- Split 484-line `cli/index.ts` into focused modules
- Created `cli/groupers/ViolationGrouper.ts` for severity grouping and filtering (29 lines)
- Created `cli/formatters/OutputFormatter.ts` for violation formatting (190 lines)
- Created `cli/formatters/StatisticsFormatter.ts` for metrics and summary (58 lines)
- Reduced `cli/index.ts` from 484 to 260 lines (46% reduction)
- All 345 tests pass, CLI output identical to before
- No breaking changes
## [0.7.5] - 2025-11-25 ## [0.7.5] - 2025-11-25
### Changed ### Changed

View File

@@ -333,32 +333,34 @@ application/use-cases/
--- ---
### Version 0.7.6 - Refactor CLI Module 🔧 ### Version 0.7.6 - Refactor CLI Module 🔧 ✅ RELEASED
**Released:** 2025-11-25
**Priority:** MEDIUM **Priority:** MEDIUM
**Scope:** Single session (~128K tokens) **Scope:** Single session (~128K tokens)
Split `cli/index.ts` (470 lines) into focused formatters. Split `cli/index.ts` (484 lines) into focused formatters.
**Problem:** **Problem:**
- CLI file has 470 lines - CLI file has 484 lines
- Mixing: command setup, formatting, grouping, statistics - Mixing: command setup, formatting, grouping, statistics
**Solution:** **Solution:**
``` ```
cli/ cli/
├── index.ts # Commands only (~100 lines) ├── index.ts # Commands only (260 lines)
├── formatters/ ├── formatters/
│ ├── OutputFormatter.ts # Violation formatting │ ├── OutputFormatter.ts # Violation formatting (190 lines)
│ └── StatisticsFormatter.ts │ └── StatisticsFormatter.ts # Metrics & summary (58 lines)
├── groupers/ ├── groupers/
│ └── ViolationGrouper.ts # Sorting & grouping │ └── ViolationGrouper.ts # Sorting & grouping (29 lines)
``` ```
**Deliverables:** **Deliverables:**
- [ ] Extract formatters and groupers - Extract formatters and groupers
- [ ] Reduce `cli/index.ts` to ~100-150 lines - Reduce `cli/index.ts` from 484 to 260 lines (46% reduction)
- [ ] CLI output identical to before - CLI output identical to before
- ✅ All 345 tests pass, no breaking changes
- [ ] Publish to npm - [ ] Publish to npm
--- ---

View File

@@ -1,6 +1,6 @@
{ {
"name": "@samiyev/guardian", "name": "@samiyev/guardian",
"version": "0.7.5", "version": "0.7.6",
"description": "Research-backed code quality guardian for AI-assisted development. Detects hardcodes, circular deps, framework leaks, entity exposure, and 8 architecture violations. Enforces Clean Architecture/DDD principles. Works with GitHub Copilot, Cursor, Windsurf, Claude, ChatGPT, Cline, and any AI coding tool.", "description": "Research-backed code quality guardian for AI-assisted development. Detects hardcodes, circular deps, framework leaks, entity exposure, and 8 architecture violations. Enforces Clean Architecture/DDD principles. Works with GitHub Copilot, Cursor, Windsurf, Claude, ChatGPT, Cline, and any AI coding tool.",
"keywords": [ "keywords": [
"puaros", "puaros",

View File

@@ -0,0 +1,190 @@
import { SEVERITY_LEVELS, type SeverityLevel } from "../../shared/constants"
import type {
AggregateBoundaryViolation,
ArchitectureViolation,
CircularDependencyViolation,
DependencyDirectionViolation,
EntityExposureViolation,
FrameworkLeakViolation,
HardcodeViolation,
NamingConventionViolation,
RepositoryPatternViolation,
} from "../../application/use-cases/AnalyzeProject"
import { SEVERITY_DISPLAY_LABELS, SEVERITY_SECTION_HEADERS } from "../constants"
import { ViolationGrouper } from "../groupers/ViolationGrouper"
const SEVERITY_LABELS: Record<SeverityLevel, string> = {
[SEVERITY_LEVELS.CRITICAL]: SEVERITY_DISPLAY_LABELS.CRITICAL,
[SEVERITY_LEVELS.HIGH]: SEVERITY_DISPLAY_LABELS.HIGH,
[SEVERITY_LEVELS.MEDIUM]: SEVERITY_DISPLAY_LABELS.MEDIUM,
[SEVERITY_LEVELS.LOW]: SEVERITY_DISPLAY_LABELS.LOW,
}
const SEVERITY_HEADER: Record<SeverityLevel, string> = {
[SEVERITY_LEVELS.CRITICAL]: SEVERITY_SECTION_HEADERS.CRITICAL,
[SEVERITY_LEVELS.HIGH]: SEVERITY_SECTION_HEADERS.HIGH,
[SEVERITY_LEVELS.MEDIUM]: SEVERITY_SECTION_HEADERS.MEDIUM,
[SEVERITY_LEVELS.LOW]: SEVERITY_SECTION_HEADERS.LOW,
}
export class OutputFormatter {
private readonly grouper = new ViolationGrouper()
displayGroupedViolations<T extends { severity: SeverityLevel }>(
violations: T[],
displayFn: (v: T, index: number) => void,
limit?: number,
): void {
const grouped = this.grouper.groupBySeverity(violations)
const severities: SeverityLevel[] = [
SEVERITY_LEVELS.CRITICAL,
SEVERITY_LEVELS.HIGH,
SEVERITY_LEVELS.MEDIUM,
SEVERITY_LEVELS.LOW,
]
let totalDisplayed = 0
const totalAvailable = violations.length
for (const severity of severities) {
const items = grouped.get(severity)
if (items && items.length > 0) {
console.warn(SEVERITY_HEADER[severity])
console.warn(`Found ${String(items.length)} issue(s)\n`)
const itemsToDisplay =
limit !== undefined ? items.slice(0, limit - totalDisplayed) : items
itemsToDisplay.forEach((item, index) => {
displayFn(item, totalDisplayed + index)
})
totalDisplayed += itemsToDisplay.length
if (limit !== undefined && totalDisplayed >= limit) {
break
}
}
}
if (limit !== undefined && totalAvailable > limit) {
console.warn(
`\n⚠ Showing first ${String(limit)} of ${String(totalAvailable)} issues (use --limit to adjust)\n`,
)
}
}
formatArchitectureViolation(v: ArchitectureViolation, index: number): void {
console.log(`${String(index + 1)}. ${v.file}`)
console.log(` Severity: ${SEVERITY_LABELS[v.severity]}`)
console.log(` Rule: ${v.rule}`)
console.log(` ${v.message}`)
console.log("")
}
formatCircularDependency(cd: CircularDependencyViolation, index: number): void {
console.log(`${String(index + 1)}. ${cd.message}`)
console.log(` Severity: ${SEVERITY_LABELS[cd.severity]}`)
console.log(" Cycle path:")
cd.cycle.forEach((file, i) => {
console.log(` ${String(i + 1)}. ${file}`)
})
console.log(` ${String(cd.cycle.length + 1)}. ${cd.cycle[0]} (back to start)`)
console.log("")
}
formatNamingViolation(nc: NamingConventionViolation, index: number): void {
console.log(`${String(index + 1)}. ${nc.file}`)
console.log(` Severity: ${SEVERITY_LABELS[nc.severity]}`)
console.log(` File: ${nc.fileName}`)
console.log(` Layer: ${nc.layer}`)
console.log(` Type: ${nc.type}`)
console.log(` Message: ${nc.message}`)
if (nc.suggestion) {
console.log(` 💡 Suggestion: ${nc.suggestion}`)
}
console.log("")
}
formatFrameworkLeak(fl: FrameworkLeakViolation, index: number): void {
console.log(`${String(index + 1)}. ${fl.file}`)
console.log(` Severity: ${SEVERITY_LABELS[fl.severity]}`)
console.log(` Package: ${fl.packageName}`)
console.log(` Category: ${fl.categoryDescription}`)
console.log(` Layer: ${fl.layer}`)
console.log(` Rule: ${fl.rule}`)
console.log(` ${fl.message}`)
console.log(` 💡 Suggestion: ${fl.suggestion}`)
console.log("")
}
formatEntityExposure(ee: EntityExposureViolation, index: number): void {
const location = ee.line ? `${ee.file}:${String(ee.line)}` : ee.file
console.log(`${String(index + 1)}. ${location}`)
console.log(` Severity: ${SEVERITY_LABELS[ee.severity]}`)
console.log(` Entity: ${ee.entityName}`)
console.log(` Return Type: ${ee.returnType}`)
if (ee.methodName) {
console.log(` Method: ${ee.methodName}`)
}
console.log(` Layer: ${ee.layer}`)
console.log(` Rule: ${ee.rule}`)
console.log(` ${ee.message}`)
console.log(" 💡 Suggestion:")
ee.suggestion.split("\n").forEach((line) => {
if (line.trim()) {
console.log(` ${line}`)
}
})
console.log("")
}
formatDependencyDirection(dd: DependencyDirectionViolation, index: number): void {
console.log(`${String(index + 1)}. ${dd.file}`)
console.log(` Severity: ${SEVERITY_LABELS[dd.severity]}`)
console.log(` From Layer: ${dd.fromLayer}`)
console.log(` To Layer: ${dd.toLayer}`)
console.log(` Import: ${dd.importPath}`)
console.log(` ${dd.message}`)
console.log(` 💡 Suggestion: ${dd.suggestion}`)
console.log("")
}
formatRepositoryPattern(rp: RepositoryPatternViolation, index: number): void {
console.log(`${String(index + 1)}. ${rp.file}`)
console.log(` Severity: ${SEVERITY_LABELS[rp.severity]}`)
console.log(` Layer: ${rp.layer}`)
console.log(` Type: ${rp.violationType}`)
console.log(` Details: ${rp.details}`)
console.log(` ${rp.message}`)
console.log(` 💡 Suggestion: ${rp.suggestion}`)
console.log("")
}
formatAggregateBoundary(ab: AggregateBoundaryViolation, index: number): void {
const location = ab.line ? `${ab.file}:${String(ab.line)}` : ab.file
console.log(`${String(index + 1)}. ${location}`)
console.log(` Severity: ${SEVERITY_LABELS[ab.severity]}`)
console.log(` From Aggregate: ${ab.fromAggregate}`)
console.log(` To Aggregate: ${ab.toAggregate}`)
console.log(` Entity: ${ab.entityName}`)
console.log(` Import: ${ab.importPath}`)
console.log(` ${ab.message}`)
console.log(" 💡 Suggestion:")
ab.suggestion.split("\n").forEach((line) => {
if (line.trim()) {
console.log(` ${line}`)
}
})
console.log("")
}
formatHardcodeViolation(hc: HardcodeViolation, index: number): void {
console.log(`${String(index + 1)}. ${hc.file}:${String(hc.line)}:${String(hc.column)}`)
console.log(` Severity: ${SEVERITY_LABELS[hc.severity]}`)
console.log(` Type: ${hc.type}`)
console.log(` Value: ${JSON.stringify(hc.value)}`)
console.log(` Context: ${hc.context.trim()}`)
console.log(` 💡 Suggested: ${hc.suggestion.constantName}`)
console.log(` 📁 Location: ${hc.suggestion.location}`)
console.log("")
}
}

View File

@@ -0,0 +1,59 @@
import { CLI_LABELS, CLI_MESSAGES } from "../constants"
interface ProjectMetrics {
totalFiles: number
totalFunctions: number
totalImports: number
layerDistribution: Record<string, number>
}
export class StatisticsFormatter {
displayMetrics(metrics: ProjectMetrics): void {
console.log(CLI_MESSAGES.METRICS_HEADER)
console.log(` ${CLI_LABELS.FILES_ANALYZED} ${String(metrics.totalFiles)}`)
console.log(` ${CLI_LABELS.TOTAL_FUNCTIONS} ${String(metrics.totalFunctions)}`)
console.log(` ${CLI_LABELS.TOTAL_IMPORTS} ${String(metrics.totalImports)}`)
if (Object.keys(metrics.layerDistribution).length > 0) {
console.log(CLI_MESSAGES.LAYER_DISTRIBUTION_HEADER)
for (const [layer, count] of Object.entries(metrics.layerDistribution)) {
console.log(` ${layer}: ${String(count)} ${CLI_LABELS.FILES}`)
}
}
}
displaySummary(totalIssues: number, verbose: boolean): void {
if (totalIssues === 0) {
console.log(CLI_MESSAGES.NO_ISSUES)
process.exit(0)
} else {
console.log(
`${CLI_MESSAGES.ISSUES_TOTAL} ${String(totalIssues)} ${CLI_LABELS.ISSUES_TOTAL}`,
)
console.log(CLI_MESSAGES.TIP)
if (verbose) {
console.log(CLI_MESSAGES.HELP_FOOTER)
}
process.exit(1)
}
}
displaySeverityFilterMessage(onlyCritical: boolean, minSeverity?: string): void {
if (onlyCritical) {
console.log("\n🔴 Filtering: Showing only CRITICAL severity issues\n")
} else if (minSeverity) {
console.log(
`\n⚠ Filtering: Showing ${minSeverity.toUpperCase()} severity and above\n`,
)
}
}
displayError(message: string): void {
console.error(`\n❌ ${CLI_MESSAGES.ERROR_PREFIX}`)
console.error(message)
console.error("")
process.exit(1)
}
}

View File

@@ -0,0 +1,29 @@
import { SEVERITY_ORDER, type SeverityLevel } from "../../shared/constants"
export class ViolationGrouper {
groupBySeverity<T extends { severity: SeverityLevel }>(
violations: T[],
): Map<SeverityLevel, T[]> {
const grouped = new Map<SeverityLevel, T[]>()
for (const violation of violations) {
const existing = grouped.get(violation.severity) ?? []
existing.push(violation)
grouped.set(violation.severity, existing)
}
return grouped
}
filterBySeverity<T extends { severity: SeverityLevel }>(
violations: T[],
minSeverity?: SeverityLevel,
): T[] {
if (!minSeverity) {
return violations
}
const minSeverityOrder = SEVERITY_ORDER[minSeverity]
return violations.filter((v) => SEVERITY_ORDER[v.severity] <= minSeverityOrder)
}
}

View File

@@ -11,92 +11,11 @@ import {
CLI_MESSAGES, CLI_MESSAGES,
CLI_OPTIONS, CLI_OPTIONS,
DEFAULT_EXCLUDES, DEFAULT_EXCLUDES,
SEVERITY_DISPLAY_LABELS,
SEVERITY_SECTION_HEADERS,
} from "./constants" } from "./constants"
import { SEVERITY_LEVELS, SEVERITY_ORDER, type SeverityLevel } from "../shared/constants" import { SEVERITY_LEVELS, type SeverityLevel } from "../shared/constants"
import { ViolationGrouper } from "./groupers/ViolationGrouper"
const SEVERITY_LABELS: Record<SeverityLevel, string> = { import { OutputFormatter } from "./formatters/OutputFormatter"
[SEVERITY_LEVELS.CRITICAL]: SEVERITY_DISPLAY_LABELS.CRITICAL, import { StatisticsFormatter } from "./formatters/StatisticsFormatter"
[SEVERITY_LEVELS.HIGH]: SEVERITY_DISPLAY_LABELS.HIGH,
[SEVERITY_LEVELS.MEDIUM]: SEVERITY_DISPLAY_LABELS.MEDIUM,
[SEVERITY_LEVELS.LOW]: SEVERITY_DISPLAY_LABELS.LOW,
}
const SEVERITY_HEADER: Record<SeverityLevel, string> = {
[SEVERITY_LEVELS.CRITICAL]: SEVERITY_SECTION_HEADERS.CRITICAL,
[SEVERITY_LEVELS.HIGH]: SEVERITY_SECTION_HEADERS.HIGH,
[SEVERITY_LEVELS.MEDIUM]: SEVERITY_SECTION_HEADERS.MEDIUM,
[SEVERITY_LEVELS.LOW]: SEVERITY_SECTION_HEADERS.LOW,
}
function groupBySeverity<T extends { severity: SeverityLevel }>(
violations: T[],
): Map<SeverityLevel, T[]> {
const grouped = new Map<SeverityLevel, T[]>()
for (const violation of violations) {
const existing = grouped.get(violation.severity) ?? []
existing.push(violation)
grouped.set(violation.severity, existing)
}
return grouped
}
function filterBySeverity<T extends { severity: SeverityLevel }>(
violations: T[],
minSeverity?: SeverityLevel,
): T[] {
if (!minSeverity) {
return violations
}
const minSeverityOrder = SEVERITY_ORDER[minSeverity]
return violations.filter((v) => SEVERITY_ORDER[v.severity] <= minSeverityOrder)
}
function displayGroupedViolations<T extends { severity: SeverityLevel }>(
violations: T[],
displayFn: (v: T, index: number) => void,
limit?: number,
): void {
const grouped = groupBySeverity(violations)
const severities: SeverityLevel[] = [
SEVERITY_LEVELS.CRITICAL,
SEVERITY_LEVELS.HIGH,
SEVERITY_LEVELS.MEDIUM,
SEVERITY_LEVELS.LOW,
]
let totalDisplayed = 0
const totalAvailable = violations.length
for (const severity of severities) {
const items = grouped.get(severity)
if (items && items.length > 0) {
console.warn(SEVERITY_HEADER[severity])
console.warn(`Found ${String(items.length)} issue(s)\n`)
const itemsToDisplay =
limit !== undefined ? items.slice(0, limit - totalDisplayed) : items
itemsToDisplay.forEach((item, index) => {
displayFn(item, totalDisplayed + index)
})
totalDisplayed += itemsToDisplay.length
if (limit !== undefined && totalDisplayed >= limit) {
break
}
}
}
if (limit !== undefined && totalAvailable > limit) {
console.warn(
`\n⚠ Showing first ${String(limit)} of ${String(totalAvailable)} issues (use --limit to adjust)\n`,
)
}
}
const program = new Command() const program = new Command()
@@ -150,6 +69,10 @@ program
.option(CLI_OPTIONS.ONLY_CRITICAL, CLI_DESCRIPTIONS.ONLY_CRITICAL_OPTION, false) .option(CLI_OPTIONS.ONLY_CRITICAL, CLI_DESCRIPTIONS.ONLY_CRITICAL_OPTION, false)
.option(CLI_OPTIONS.LIMIT, CLI_DESCRIPTIONS.LIMIT_OPTION) .option(CLI_OPTIONS.LIMIT, CLI_DESCRIPTIONS.LIMIT_OPTION)
.action(async (path: string, options) => { .action(async (path: string, options) => {
const grouper = new ViolationGrouper()
const outputFormatter = new OutputFormatter()
const statsFormatter = new StatisticsFormatter()
try { try {
console.log(CLI_MESSAGES.ANALYZING) console.log(CLI_MESSAGES.ANALYZING)
@@ -182,270 +105,159 @@ program
: undefined : undefined
if (minSeverity) { if (minSeverity) {
violations = filterBySeverity(violations, minSeverity) violations = grouper.filterBySeverity(violations, minSeverity)
hardcodeViolations = filterBySeverity(hardcodeViolations, minSeverity) hardcodeViolations = grouper.filterBySeverity(hardcodeViolations, minSeverity)
circularDependencyViolations = filterBySeverity( circularDependencyViolations = grouper.filterBySeverity(
circularDependencyViolations, circularDependencyViolations,
minSeverity, minSeverity,
) )
namingViolations = filterBySeverity(namingViolations, minSeverity) namingViolations = grouper.filterBySeverity(namingViolations, minSeverity)
frameworkLeakViolations = filterBySeverity(frameworkLeakViolations, minSeverity) frameworkLeakViolations = grouper.filterBySeverity(
entityExposureViolations = filterBySeverity(entityExposureViolations, minSeverity) frameworkLeakViolations,
dependencyDirectionViolations = filterBySeverity( minSeverity,
)
entityExposureViolations = grouper.filterBySeverity(
entityExposureViolations,
minSeverity,
)
dependencyDirectionViolations = grouper.filterBySeverity(
dependencyDirectionViolations, dependencyDirectionViolations,
minSeverity, minSeverity,
) )
repositoryPatternViolations = filterBySeverity( repositoryPatternViolations = grouper.filterBySeverity(
repositoryPatternViolations, repositoryPatternViolations,
minSeverity, minSeverity,
) )
aggregateBoundaryViolations = filterBySeverity( aggregateBoundaryViolations = grouper.filterBySeverity(
aggregateBoundaryViolations, aggregateBoundaryViolations,
minSeverity, minSeverity,
) )
if (options.onlyCritical) { statsFormatter.displaySeverityFilterMessage(
console.log("\n🔴 Filtering: Showing only CRITICAL severity issues\n") options.onlyCritical,
} else { options.minSeverity,
console.log( )
`\n⚠ Filtering: Showing ${minSeverity.toUpperCase()} severity and above\n`,
)
}
} }
// Display metrics statsFormatter.displayMetrics(metrics)
console.log(CLI_MESSAGES.METRICS_HEADER)
console.log(` ${CLI_LABELS.FILES_ANALYZED} ${String(metrics.totalFiles)}`)
console.log(` ${CLI_LABELS.TOTAL_FUNCTIONS} ${String(metrics.totalFunctions)}`)
console.log(` ${CLI_LABELS.TOTAL_IMPORTS} ${String(metrics.totalImports)}`)
if (Object.keys(metrics.layerDistribution).length > 0) {
console.log(CLI_MESSAGES.LAYER_DISTRIBUTION_HEADER)
for (const [layer, count] of Object.entries(metrics.layerDistribution)) {
console.log(` ${layer}: ${String(count)} ${CLI_LABELS.FILES}`)
}
}
// Architecture violations
if (options.architecture && violations.length > 0) { if (options.architecture && violations.length > 0) {
console.log( console.log(
`\n${CLI_MESSAGES.VIOLATIONS_HEADER} ${String(violations.length)} ${CLI_LABELS.ARCHITECTURE_VIOLATIONS}`, `\n${CLI_MESSAGES.VIOLATIONS_HEADER} ${String(violations.length)} ${CLI_LABELS.ARCHITECTURE_VIOLATIONS}`,
) )
outputFormatter.displayGroupedViolations(
displayGroupedViolations(
violations, violations,
(v, index) => { (v, i) => {
console.log(`${String(index + 1)}. ${v.file}`) outputFormatter.formatArchitectureViolation(v, i)
console.log(` Severity: ${SEVERITY_LABELS[v.severity]}`)
console.log(` Rule: ${v.rule}`)
console.log(` ${v.message}`)
console.log("")
}, },
limit, limit,
) )
} }
// Circular dependency violations
if (options.architecture && circularDependencyViolations.length > 0) { if (options.architecture && circularDependencyViolations.length > 0) {
console.log( console.log(
`\n${CLI_MESSAGES.CIRCULAR_DEPS_HEADER} ${String(circularDependencyViolations.length)} ${CLI_LABELS.CIRCULAR_DEPENDENCIES}`, `\n${CLI_MESSAGES.CIRCULAR_DEPS_HEADER} ${String(circularDependencyViolations.length)} ${CLI_LABELS.CIRCULAR_DEPENDENCIES}`,
) )
outputFormatter.displayGroupedViolations(
displayGroupedViolations(
circularDependencyViolations, circularDependencyViolations,
(cd, index) => { (cd, i) => {
console.log(`${String(index + 1)}. ${cd.message}`) outputFormatter.formatCircularDependency(cd, i)
console.log(` Severity: ${SEVERITY_LABELS[cd.severity]}`)
console.log(" Cycle path:")
cd.cycle.forEach((file, i) => {
console.log(` ${String(i + 1)}. ${file}`)
})
console.log(
` ${String(cd.cycle.length + 1)}. ${cd.cycle[0]} (back to start)`,
)
console.log("")
}, },
limit, limit,
) )
} }
// Naming convention violations
if (options.architecture && namingViolations.length > 0) { if (options.architecture && namingViolations.length > 0) {
console.log( console.log(
`\n${CLI_MESSAGES.NAMING_VIOLATIONS_HEADER} ${String(namingViolations.length)} ${CLI_LABELS.NAMING_VIOLATIONS}`, `\n${CLI_MESSAGES.NAMING_VIOLATIONS_HEADER} ${String(namingViolations.length)} ${CLI_LABELS.NAMING_VIOLATIONS}`,
) )
outputFormatter.displayGroupedViolations(
displayGroupedViolations(
namingViolations, namingViolations,
(nc, index) => { (nc, i) => {
console.log(`${String(index + 1)}. ${nc.file}`) outputFormatter.formatNamingViolation(nc, i)
console.log(` Severity: ${SEVERITY_LABELS[nc.severity]}`)
console.log(` File: ${nc.fileName}`)
console.log(` Layer: ${nc.layer}`)
console.log(` Type: ${nc.type}`)
console.log(` Message: ${nc.message}`)
if (nc.suggestion) {
console.log(` 💡 Suggestion: ${nc.suggestion}`)
}
console.log("")
}, },
limit, limit,
) )
} }
// Framework leak violations
if (options.architecture && frameworkLeakViolations.length > 0) { if (options.architecture && frameworkLeakViolations.length > 0) {
console.log( console.log(
`\n🏗 Found ${String(frameworkLeakViolations.length)} framework leak(s)`, `\n🏗 Found ${String(frameworkLeakViolations.length)} framework leak(s)`,
) )
outputFormatter.displayGroupedViolations(
displayGroupedViolations(
frameworkLeakViolations, frameworkLeakViolations,
(fl, index) => { (fl, i) => {
console.log(`${String(index + 1)}. ${fl.file}`) outputFormatter.formatFrameworkLeak(fl, i)
console.log(` Severity: ${SEVERITY_LABELS[fl.severity]}`)
console.log(` Package: ${fl.packageName}`)
console.log(` Category: ${fl.categoryDescription}`)
console.log(` Layer: ${fl.layer}`)
console.log(` Rule: ${fl.rule}`)
console.log(` ${fl.message}`)
console.log(` 💡 Suggestion: ${fl.suggestion}`)
console.log("")
}, },
limit, limit,
) )
} }
// Entity exposure violations
if (options.architecture && entityExposureViolations.length > 0) { if (options.architecture && entityExposureViolations.length > 0) {
console.log( console.log(
`\n🎭 Found ${String(entityExposureViolations.length)} entity exposure(s)`, `\n🎭 Found ${String(entityExposureViolations.length)} entity exposure(s)`,
) )
outputFormatter.displayGroupedViolations(
displayGroupedViolations(
entityExposureViolations, entityExposureViolations,
(ee, index) => { (ee, i) => {
const location = ee.line ? `${ee.file}:${String(ee.line)}` : ee.file outputFormatter.formatEntityExposure(ee, i)
console.log(`${String(index + 1)}. ${location}`)
console.log(` Severity: ${SEVERITY_LABELS[ee.severity]}`)
console.log(` Entity: ${ee.entityName}`)
console.log(` Return Type: ${ee.returnType}`)
if (ee.methodName) {
console.log(` Method: ${ee.methodName}`)
}
console.log(` Layer: ${ee.layer}`)
console.log(` Rule: ${ee.rule}`)
console.log(` ${ee.message}`)
console.log(" 💡 Suggestion:")
ee.suggestion.split("\n").forEach((line) => {
if (line.trim()) {
console.log(` ${line}`)
}
})
console.log("")
}, },
limit, limit,
) )
} }
// Dependency direction violations
if (options.architecture && dependencyDirectionViolations.length > 0) { if (options.architecture && dependencyDirectionViolations.length > 0) {
console.log( console.log(
`\n⚠ Found ${String(dependencyDirectionViolations.length)} dependency direction violation(s)`, `\n⚠ Found ${String(dependencyDirectionViolations.length)} dependency direction violation(s)`,
) )
outputFormatter.displayGroupedViolations(
displayGroupedViolations(
dependencyDirectionViolations, dependencyDirectionViolations,
(dd, index) => { (dd, i) => {
console.log(`${String(index + 1)}. ${dd.file}`) outputFormatter.formatDependencyDirection(dd, i)
console.log(` Severity: ${SEVERITY_LABELS[dd.severity]}`)
console.log(` From Layer: ${dd.fromLayer}`)
console.log(` To Layer: ${dd.toLayer}`)
console.log(` Import: ${dd.importPath}`)
console.log(` ${dd.message}`)
console.log(` 💡 Suggestion: ${dd.suggestion}`)
console.log("")
}, },
limit, limit,
) )
} }
// Repository pattern violations
if (options.architecture && repositoryPatternViolations.length > 0) { if (options.architecture && repositoryPatternViolations.length > 0) {
console.log( console.log(
`\n📦 Found ${String(repositoryPatternViolations.length)} repository pattern violation(s)`, `\n📦 Found ${String(repositoryPatternViolations.length)} repository pattern violation(s)`,
) )
outputFormatter.displayGroupedViolations(
displayGroupedViolations(
repositoryPatternViolations, repositoryPatternViolations,
(rp, index) => { (rp, i) => {
console.log(`${String(index + 1)}. ${rp.file}`) outputFormatter.formatRepositoryPattern(rp, i)
console.log(` Severity: ${SEVERITY_LABELS[rp.severity]}`)
console.log(` Layer: ${rp.layer}`)
console.log(` Type: ${rp.violationType}`)
console.log(` Details: ${rp.details}`)
console.log(` ${rp.message}`)
console.log(` 💡 Suggestion: ${rp.suggestion}`)
console.log("")
}, },
limit, limit,
) )
} }
// Aggregate boundary violations
if (options.architecture && aggregateBoundaryViolations.length > 0) { if (options.architecture && aggregateBoundaryViolations.length > 0) {
console.log( console.log(
`\n🔒 Found ${String(aggregateBoundaryViolations.length)} aggregate boundary violation(s)`, `\n🔒 Found ${String(aggregateBoundaryViolations.length)} aggregate boundary violation(s)`,
) )
outputFormatter.displayGroupedViolations(
displayGroupedViolations(
aggregateBoundaryViolations, aggregateBoundaryViolations,
(ab, index) => { (ab, i) => {
const location = ab.line ? `${ab.file}:${String(ab.line)}` : ab.file outputFormatter.formatAggregateBoundary(ab, i)
console.log(`${String(index + 1)}. ${location}`)
console.log(` Severity: ${SEVERITY_LABELS[ab.severity]}`)
console.log(` From Aggregate: ${ab.fromAggregate}`)
console.log(` To Aggregate: ${ab.toAggregate}`)
console.log(` Entity: ${ab.entityName}`)
console.log(` Import: ${ab.importPath}`)
console.log(` ${ab.message}`)
console.log(" 💡 Suggestion:")
ab.suggestion.split("\n").forEach((line) => {
if (line.trim()) {
console.log(` ${line}`)
}
})
console.log("")
}, },
limit, limit,
) )
} }
// Hardcode violations
if (options.hardcode && hardcodeViolations.length > 0) { if (options.hardcode && hardcodeViolations.length > 0) {
console.log( console.log(
`\n${CLI_MESSAGES.HARDCODE_VIOLATIONS_HEADER} ${String(hardcodeViolations.length)} ${CLI_LABELS.HARDCODE_VIOLATIONS}`, `\n${CLI_MESSAGES.HARDCODE_VIOLATIONS_HEADER} ${String(hardcodeViolations.length)} ${CLI_LABELS.HARDCODE_VIOLATIONS}`,
) )
outputFormatter.displayGroupedViolations(
displayGroupedViolations(
hardcodeViolations, hardcodeViolations,
(hc, index) => { (hc, i) => {
console.log( outputFormatter.formatHardcodeViolation(hc, i)
`${String(index + 1)}. ${hc.file}:${String(hc.line)}:${String(hc.column)}`,
)
console.log(` Severity: ${SEVERITY_LABELS[hc.severity]}`)
console.log(` Type: ${hc.type}`)
console.log(` Value: ${JSON.stringify(hc.value)}`)
console.log(` Context: ${hc.context.trim()}`)
console.log(` 💡 Suggested: ${hc.suggestion.constantName}`)
console.log(` 📁 Location: ${hc.suggestion.location}`)
console.log("")
}, },
limit, limit,
) )
} }
// Summary
const totalIssues = const totalIssues =
violations.length + violations.length +
hardcodeViolations.length + hardcodeViolations.length +
@@ -457,26 +269,9 @@ program
repositoryPatternViolations.length + repositoryPatternViolations.length +
aggregateBoundaryViolations.length aggregateBoundaryViolations.length
if (totalIssues === 0) { statsFormatter.displaySummary(totalIssues, options.verbose)
console.log(CLI_MESSAGES.NO_ISSUES)
process.exit(0)
} else {
console.log(
`${CLI_MESSAGES.ISSUES_TOTAL} ${String(totalIssues)} ${CLI_LABELS.ISSUES_TOTAL}`,
)
console.log(CLI_MESSAGES.TIP)
if (options.verbose) {
console.log(CLI_MESSAGES.HELP_FOOTER)
}
process.exit(1)
}
} catch (error) { } catch (error) {
console.error(`\n❌ ${CLI_MESSAGES.ERROR_PREFIX}`) statsFormatter.displayError(error instanceof Error ? error.message : String(error))
console.error(error instanceof Error ? error.message : String(error))
console.error("")
process.exit(1)
} }
}) })