@archlinter/core 0.4.1

package/index.d.ts

@@ -0,0 +1,147 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export interface JsScanOptions {
+  /** Path to config file */
+  configPath?: string;
+  /** Only run these detectors (by ID) */
+  detectors?: Array<string>;
+  /** Exclude these detectors (by ID) */
+  excludeDetectors?: Array<string>;
+  /** Minimum severity to report */
+  minSeverity?: string;
+  /** Minimum score to report */
+  minScore?: number;
+  /** Enable caching (default: true) */
+  cache?: boolean;
+  /** Enable git integration (default: true) */
+  git?: boolean;
+}
+export interface JsScanResult {
+  smells: Array<JsSmellWithExplanation>;
+  summary: JsSummary;
+  files: Array<JsFileInfo>;
+  grade: JsArchitectureGrade;
+  projectPath: string;
+}
+export interface JsSmellWithExplanation {
+  smell: JsSmell;
+  explanation: JsExplanation;
+}
+export interface JsSmell {
+  smellType: string;
+  severity: string;
+  files: Array<string>;
+  locations: Array<JsLocationDetail>;
+  /** Additional metrics as JSON */
+  metrics: Record<string, unknown>;
+  cluster?: JsCycleCluster;
+}
+export interface JsLocationDetail {
+  file: string;
+  line: number;
+  column?: number;
+  range?: JsCodeRange;
+  description: string;
+}
+export interface JsCodeRange {
+  startLine: number;
+  startColumn: number;
+  endLine: number;
+  endColumn: number;
+}
+export interface JsExplanation {
+  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;
+}
+export interface JsArchitectureGrade {
+  score: number;
+  level: string;
+  density: number;
+}
+export interface JsFileInfo {
+  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;
+}
+export interface JsExportInfo {
+  name: string;
+  kind: string;
+  isDefault: boolean;
+  source?: string;
+}
+export interface JsFileMetrics {
+  lines: number;
+  complexity?: number;
+  fanIn: number;
+  fanOut: number;
+}
+export interface JsCycleCluster {
+  files: Array<string>;
+  hotspots: Array<JsCycleHotspot>;
+  criticalEdges: Array<JsCriticalEdge>;
+}
+export interface JsCycleHotspot {
+  file: string;
+  inDegree: number;
+  outDegree: number;
+}
+export interface JsCriticalEdge {
+  from: string;
+  to: string;
+  line: number;
+  range?: JsCodeRange;
+  impact: string;
+}
+export interface JsDetectorInfo {
+  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;
+}
+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>;

package/index.js

@@ -0,0 +1,292 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path');
+
+const { platform, arch } = process;
+
+let nativeBinding = null;
+let localFileExisted = false;
+let loadError = null;
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim();
+      return readFileSync(lddPath, 'utf8').includes('musl');
+    } catch (e) {
+      return true;
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header;
+    return !glibcVersionRuntime;
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'archlint.android-arm64.node'));
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./archlint.android-arm64.node');
+          } else {
+            nativeBinding = require('@archlinter/core-android-arm64');
+          }
+        } catch (e) {
+          loadError = e;
+        }
+        break;
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'archlint.android-arm-eabi.node'));
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./archlint.android-arm-eabi.node');
+          } else {
+            nativeBinding = require('@archlinter/core-android-arm-eabi');
+          }
+        } catch (e) {
+          loadError = e;
+        }
+        break;
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`);
+    }
+    break;
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'archlint.win32-x64-msvc.node'));
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./archlint.win32-x64-msvc.node');
+          } else {
+            nativeBinding = require('@archlinter/core-win32-x64-msvc');
+          }
+        } catch (e) {
+          loadError = e;
+        }
+        break;
+      case 'ia32':
+        localFileExisted = existsSync(join(__dirname, 'archlint.win32-ia32-msvc.node'));
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./archlint.win32-ia32-msvc.node');
+          } else {
+            nativeBinding = require('@archlinter/core-win32-ia32-msvc');
+          }
+        } catch (e) {
+          loadError = e;
+        }
+        break;
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'archlint.win32-arm64-msvc.node'));
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./archlint.win32-arm64-msvc.node');
+          } else {
+            nativeBinding = require('@archlinter/core-win32-arm64-msvc');
+          }
+        } catch (e) {
+          loadError = e;
+        }
+        break;
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`);
+    }
+    break;
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'archlint.darwin-universal.node'));
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./archlint.darwin-universal.node');
+      } else {
+        nativeBinding = require('@archlinter/core-darwin-universal');
+      }
+      break;
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'archlint.darwin-x64.node'));
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./archlint.darwin-x64.node');
+          } else {
+            nativeBinding = require('@archlinter/core-darwin-x64');
+          }
+        } catch (e) {
+          loadError = e;
+        }
+        break;
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'archlint.darwin-arm64.node'));
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./archlint.darwin-arm64.node');
+          } else {
+            nativeBinding = require('@archlinter/core-darwin-arm64');
+          }
+        } catch (e) {
+          loadError = e;
+        }
+        break;
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`);
+    }
+    break;
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`);
+    }
+    localFileExisted = existsSync(join(__dirname, 'archlint.freebsd-x64.node'));
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./archlint.freebsd-x64.node');
+      } else {
+        nativeBinding = require('@archlinter/core-freebsd-x64');
+      }
+    } catch (e) {
+      loadError = e;
+    }
+    break;
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(join(__dirname, 'archlint.linux-x64-musl.node'));
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./archlint.linux-x64-musl.node');
+            } else {
+              nativeBinding = require('@archlinter/core-linux-x64-musl');
+            }
+          } catch (e) {
+            loadError = e;
+          }
+        } else {
+          localFileExisted = existsSync(join(__dirname, 'archlint.linux-x64-gnu.node'));
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./archlint.linux-x64-gnu.node');
+            } else {
+              nativeBinding = require('@archlinter/core-linux-x64-gnu');
+            }
+          } catch (e) {
+            loadError = e;
+          }
+        }
+        break;
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(join(__dirname, 'archlint.linux-arm64-musl.node'));
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./archlint.linux-arm64-musl.node');
+            } else {
+              nativeBinding = require('@archlinter/core-linux-arm64-musl');
+            }
+          } catch (e) {
+            loadError = e;
+          }
+        } else {
+          localFileExisted = existsSync(join(__dirname, 'archlint.linux-arm64-gnu.node'));
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./archlint.linux-arm64-gnu.node');
+            } else {
+              nativeBinding = require('@archlinter/core-linux-arm64-gnu');
+            }
+          } catch (e) {
+            loadError = e;
+          }
+        }
+        break;
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(join(__dirname, 'archlint.linux-arm-musleabihf.node'));
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./archlint.linux-arm-musleabihf.node');
+            } else {
+              nativeBinding = require('@archlinter/core-linux-arm-musleabihf');
+            }
+          } catch (e) {
+            loadError = e;
+          }
+        } else {
+          localFileExisted = existsSync(join(__dirname, 'archlint.linux-arm-gnueabihf.node'));
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./archlint.linux-arm-gnueabihf.node');
+            } else {
+              nativeBinding = require('@archlinter/core-linux-arm-gnueabihf');
+            }
+          } catch (e) {
+            loadError = e;
+          }
+        }
+        break;
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(join(__dirname, 'archlint.linux-riscv64-musl.node'));
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./archlint.linux-riscv64-musl.node');
+            } else {
+              nativeBinding = require('@archlinter/core-linux-riscv64-musl');
+            }
+          } catch (e) {
+            loadError = e;
+          }
+        } else {
+          localFileExisted = existsSync(join(__dirname, 'archlint.linux-riscv64-gnu.node'));
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./archlint.linux-riscv64-gnu.node');
+            } else {
+              nativeBinding = require('@archlinter/core-linux-riscv64-gnu');
+            }
+          } catch (e) {
+            loadError = e;
+          }
+        }
+        break;
+      case 's390x':
+        localFileExisted = existsSync(join(__dirname, 'archlint.linux-s390x-gnu.node'));
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./archlint.linux-s390x-gnu.node');
+          } else {
+            nativeBinding = require('@archlinter/core-linux-s390x-gnu');
+          }
+        } catch (e) {
+          loadError = e;
+        }
+        break;
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`);
+    }
+    break;
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`);
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError;
+  }
+  throw new Error(`Failed to load native binding`);
+}
+
+const { scan, scanSync, loadConfig, getDetectors } = nativeBinding;
+
+module.exports.scan = scan;
+module.exports.scanSync = scanSync;
+module.exports.loadConfig = loadConfig;
+module.exports.getDetectors = getDetectors;

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@archlinter/core",
+  "version": "0.4.1",
+  "description": "Core library for archlint - programmatic API",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/archlinter/archlint.git",
+    "directory": "packages/core"
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "*.node"
+  ],
+  "napi": {
+    "name": "archlint",
+    "triples": {
+      "defaults": true,
+      "additional": [
+        "x86_64-unknown-linux-musl",
+        "aarch64-unknown-linux-gnu",
+        "aarch64-apple-darwin"
+      ]
+    }
+  },
+  "optionalDependencies": {
+    "@archlinter/core-win32-x64-msvc": "0.4.1",
+    "@archlinter/core-darwin-x64": "0.4.1",
+    "@archlinter/core-linux-x64-gnu": "0.4.1",
+    "@archlinter/core-linux-x64-musl": "0.4.1",
+    "@archlinter/core-linux-arm64-gnu": "0.4.1",
+    "@archlinter/core-darwin-arm64": "0.4.1"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "napi build --release --platform --cargo-cwd ../../crates/archlint-napi .",
+    "build:debug": "napi build --platform --cargo-cwd ../../crates/archlint-napi .",
+    "test": "vitest run",
+    "prepublishOnly": "napi prepublish -t npm"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.0"
+  }
+}