@archlinter/core 0.7.0-canary.5 → 0.8.0

package/index.d.ts

@@ -5,178 +5,231 @@
 
 export interface JsScanOptions {
   /** Path to config file */
-  configPath?: string;
+  configPath?: string
   /** Only run these detectors (by ID) */
-  detectors?: Array<string>;
+  detectors?: Array<string>
   /** Exclude these detectors (by ID) */
-  excludeDetectors?: Array<string>;
+  excludeDetectors?: Array<string>
   /** Minimum severity to report */
-  minSeverity?: string;
+  minSeverity?: string
   /** Minimum score to report */
-  minScore?: number;
+  minScore?: number
   /** Enable caching (default: true) */
-  cache?: boolean;
+  cache?: boolean
   /** Enable git integration (default: true) */
-  git?: boolean;
+  git?: boolean
   /** Git history analysis period (e.g. "90d", "1y", "all") */
-  gitHistoryPeriod?: string;
+  gitHistoryPeriod?: string
 }
 export interface JsScanResult {
-  smells: Array<JsSmellWithExplanation>;
-  summary: JsSummary;
-  files: Array<JsFileInfo>;
-  grade: JsArchitectureGrade;
-  projectPath: string;
+  smells: Array<JsSmellWithExplanation>
+  summary: JsSummary
+  files: Array<JsFileInfo>
+  grade: JsArchitectureGrade
+  projectPath: string
 }
 export interface JsIncrementalResult {
-  smells: Array<JsSmellWithExplanation>;
-  affectedFiles: Array<string>;
-  changedCount: number;
-  affectedCount: number;
-  analysisTimeMs: number;
+  smells: Array<JsSmellWithExplanation>
+  affectedFiles: Array<string>
+  changedCount: number
+  affectedCount: number
+  analysisTimeMs: number
 }
 export interface JsSmellWithExplanation {
-  smell: JsSmell;
-  explanation: JsExplanation;
+  smell: JsSmell
+  explanation: JsExplanation
 }
 export interface JsSmell {
-  smellType: string;
-  severity: string;
-  files: Array<string>;
-  locations: Array<JsLocationDetail>;
+  smellType: string
+  severity: string
+  files: Array<string>
+  locations: Array<JsLocationDetail>
   /** Additional metrics as JSON */
-  metrics: Record<string, unknown>;
-  cluster?: JsCycleCluster;
+  metrics: Record<string, unknown>
+  cluster?: JsCycleCluster
 }
 export interface JsLocationDetail {
-  file: string;
-  line: number;
-  column?: number;
-  range?: JsCodeRange;
-  description: string;
+  file: string
+  line: number
+  column?: number
+  range?: JsCodeRange
+  description: string
 }
 export interface JsCodeRange {
-  startLine: number;
-  startColumn: number;
-  endLine: number;
-  endColumn: number;
+  startLine: number
+  startColumn: number
+  endLine: number
+  endColumn: number
 }
 export interface JsExplanation {
-  problem: string;
-  reason: string;
-  risks: Array<string>;
-  recommendations: Array<string>;
+  problem: string
+  reason: string
+  risks: Array<string>
+  recommendations: Array<string>
 }
 export interface JsSummary {
-  filesAnalyzed: number;
-  totalSmells: number;
-  cyclicDependencies: number;
-  cycleClusters: number;
-  filesInCycles: number;
-  godModules: number;
-  deadCode: number;
-  deadSymbols: number;
-  highComplexityFunctions: number;
-  unstableInterfaces: number;
-  featureEnvy: number;
-  shotgunSurgery: number;
-  hubDependencies: number;
+  filesAnalyzed: number
+  totalSmells: number
+  cyclicDependencies: number
+  cycleClusters: number
+  filesInCycles: number
+  godModules: number
+  deadCode: number
+  deadSymbols: number
+  highComplexityFunctions: number
+  unstableInterfaces: number
+  featureEnvy: number
+  shotgunSurgery: number
+  hubDependencies: number
 }
 export interface JsArchitectureGrade {
-  score: number;
-  level: string;
-  density: number;
+  score: number
+  level: string
+  density: number
 }
 export interface JsFileInfo {
-  path: string;
-  relativePath: string;
-  imports: Array<JsImportInfo>;
-  exports: Array<JsExportInfo>;
-  metrics: JsFileMetrics;
+  path: string
+  relativePath: string
+  imports: Array<JsImportInfo>
+  exports: Array<JsExportInfo>
+  metrics: JsFileMetrics
 }
 export interface JsImportInfo {
-  source: string;
-  names: Array<string>;
-  line: number;
-  isDefault: boolean;
-  isNamespace: boolean;
+  source: string
+  names: Array<string>
+  line: number
+  isDefault: boolean
+  isNamespace: boolean
 }
 export interface JsExportInfo {
-  name: string;
-  kind: string;
-  isDefault: boolean;
-  source?: string;
+  name: string
+  kind: string
+  isDefault: boolean
+  source?: string
 }
 export interface JsFileMetrics {
-  lines: number;
-  complexity?: number;
-  fanIn: number;
-  fanOut: number;
+  lines: number
+  complexity?: number
+  fanIn: number
+  fanOut: number
 }
 export interface JsCycleCluster {
-  files: Array<string>;
-  hotspots: Array<JsCycleHotspot>;
-  criticalEdges: Array<JsCriticalEdge>;
+  files: Array<string>
+  hotspots: Array<JsCycleHotspot>
+  criticalEdges: Array<JsCriticalEdge>
 }
 export interface JsCycleHotspot {
-  file: string;
-  inDegree: number;
-  outDegree: number;
+  file: string
+  inDegree: number
+  outDegree: number
 }
 export interface JsCriticalEdge {
-  from: string;
-  to: string;
-  line: number;
-  range?: JsCodeRange;
-  impact: string;
+  from: string
+  to: string
+  line: number
+  range?: JsCodeRange
+  impact: string
 }
 export interface JsDetectorInfo {
-  id: string;
-  name: string;
-  description: string;
-  defaultEnabled: boolean;
-  isDeep: boolean;
+  id: string
+  name: string
+  description: string
+  defaultEnabled: boolean
+  isDeep: boolean
 }
 export interface JsConfig {
-  ignore: Array<string>;
-  aliases: Record<string, string>;
-  thresholds: Record<string, unknown>;
-  entryPoints: Array<string>;
-  enableGit: boolean;
+  ignore: Array<string>
+  aliases: Record<string, string>
+  thresholds: Record<string, unknown>
+  entryPoints: Array<string>
+  enableGit: boolean
 }
 export interface JsStateStats {
-  filesCount: number;
-  graphNodes: number;
-  graphEdges: number;
-}
-export declare function scan(
-  path: string,
-  options?: JsScanOptions | undefined | null
-): Promise<JsScanResult>;
-export declare function scanSync(
-  path: string,
-  options?: JsScanOptions | undefined | null
-): JsScanResult;
-export declare function loadConfig(path?: string | undefined | null): JsConfig;
-export declare function getDetectors(): Array<JsDetectorInfo>;
-export declare function clearCache(path: string): void;
+  filesCount: number
+  graphNodes: number
+  graphEdges: number
+}
+export interface JsDiffOptions {
+  baselinePath: string
+  projectPath: string
+  currentPath?: string
+}
+export interface JsDiffResult {
+  hasRegressions: boolean
+  regressions: Array<JsRegression>
+  improvements: Array<JsImprovement>
+  summary: JsDiffSummary
+  baselineCommit?: string
+  currentCommit?: string
+}
+export interface JsRegression {
+  id: string
+  regressionType: JsRegressionType
+  smell: JsSnapshotSmell
+  message: string
+  explain?: JsExplainBlock
+}
+export interface JsRegressionType {
+  type: string
+  from?: string
+  to?: string
+  metric?: string
+  fromVal?: number
+  toVal?: number
+  changePercent?: number
+}
+export interface JsImprovement {
+  id: string
+  improvementType: JsImprovementType
+  message: string
+}
+export interface JsImprovementType {
+  type: string
+  from?: string
+  to?: string
+  metric?: string
+  fromVal?: number
+  toVal?: number
+}
+export interface JsDiffSummary {
+  newSmells: number
+  fixedSmells: number
+  worsenedSmells: number
+  improvedSmells: number
+  totalRegressions: number
+  totalImprovements: number
+}
+export interface JsExplainBlock {
+  whyBad: string
+  consequences: string
+  howToFix: string
+}
+export interface JsSnapshotSmell {
+  id: string
+  smellType: string
+  severity: string
+  files: Array<string>
+  metrics: Record<string, unknown>
+  details?: unknown
+}
+export declare function runDiff(options: JsDiffOptions): JsDiffResult
+export declare function runDiffAsync(options: JsDiffOptions): Promise<JsDiffResult>
+export declare function scan(path: string, options?: JsScanOptions | undefined | null): Promise<JsScanResult>
+export declare function scanSync(path: string, options?: JsScanOptions | undefined | null): JsScanResult
+export declare function loadConfig(path?: string | undefined | null): JsConfig
+export declare function getDetectors(): Array<JsDetectorInfo>
+export declare function clearCache(path: string): void
 export declare class ArchlintAnalyzer {
-  constructor(path: string, options?: JsScanOptions | undefined | null);
-  scan(): Promise<JsScanResult>;
-  scanIncremental(changedFiles: Array<string>): Promise<JsIncrementalResult>;
-  scanSync(): JsScanResult;
-  scanIncrementalSync(changedFiles: Array<string>): JsIncrementalResult;
-  scanIncrementalWithOverlaySync(
-    changedFiles: Array<string>,
-    overlays: Record<string, string>
-  ): JsIncrementalResult;
-  scanIncrementalWithOverlay(
-    changedFiles: Array<string>,
-    overlays: Record<string, string>
-  ): Promise<JsIncrementalResult>;
-  invalidate(files: Array<string>): void;
-  rescan(): Promise<JsScanResult>;
-  rescanSync(): JsScanResult;
-  getAffectedFiles(changedFiles: Array<string>): Array<string>;
-  getStateStats(): JsStateStats;
+  constructor(path: string, options?: JsScanOptions | undefined | null)
+  scan(): Promise<JsScanResult>
+  scanIncremental(changedFiles: Array<string>): Promise<JsIncrementalResult>
+  scanSync(): JsScanResult
+  scanIncrementalSync(changedFiles: Array<string>): JsIncrementalResult
+  scanIncrementalWithOverlaySync(changedFiles: Array<string>, overlays: Record<string, string>): JsIncrementalResult
+  scanIncrementalWithOverlay(changedFiles: Array<string>, overlays: Record<string, string>): Promise<JsIncrementalResult>
+  invalidate(files: Array<string>): void
+  rescan(): Promise<JsScanResult>
+  rescanSync(): JsScanResult
+  getAffectedFiles(changedFiles: Array<string>): Array<string>
+  getStateStats(): JsStateStats
 }

package/index.js

@@ -310,8 +310,10 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { scan, scanSync, loadConfig, getDetectors, clearCache, ArchlintAnalyzer } = nativeBinding
+const { runDiff, runDiffAsync, scan, scanSync, loadConfig, getDetectors, clearCache, ArchlintAnalyzer } = nativeBinding
 
+module.exports.runDiff = runDiff
+module.exports.runDiffAsync = runDiffAsync
 module.exports.scan = scan
 module.exports.scanSync = scanSync
 module.exports.loadConfig = loadConfig

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@archlinter/core",
-  "version": "0.7.0-canary.5",
+  "version": "0.8.0",
   "description": "Core library for archlint - programmatic API",
   "license": "MIT",
   "repository": {
@@ -27,12 +27,12 @@
     }
   },
   "optionalDependencies": {
-    "@archlinter/core-win32-x64-msvc": "0.7.0-canary.5",
-    "@archlinter/core-darwin-x64": "0.7.0-canary.5",
-    "@archlinter/core-linux-x64-gnu": "0.7.0-canary.5",
-    "@archlinter/core-linux-x64-musl": "0.7.0-canary.5",
-    "@archlinter/core-linux-arm64-gnu": "0.7.0-canary.5",
-    "@archlinter/core-darwin-arm64": "0.7.0-canary.5"
+    "@archlinter/core-win32-x64-msvc": "0.8.0",
+    "@archlinter/core-darwin-x64": "0.8.0",
+    "@archlinter/core-linux-x64-gnu": "0.8.0",
+    "@archlinter/core-linux-x64-musl": "0.8.0",
+    "@archlinter/core-linux-arm64-gnu": "0.8.0",
+    "@archlinter/core-darwin-arm64": "0.8.0"
   },
   "engines": {
     "node": ">=18"