projscan 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,110 @@
+export interface ScanResult {
+    rootPath: string;
+    totalFiles: number;
+    totalDirectories: number;
+    files: FileEntry[];
+    directoryTree: DirectoryNode;
+    scanDurationMs: number;
+}
+export interface FileEntry {
+    relativePath: string;
+    absolutePath: string;
+    extension: string;
+    sizeBytes: number;
+    directory: string;
+}
+export interface DirectoryNode {
+    name: string;
+    path: string;
+    children: DirectoryNode[];
+    fileCount: number;
+    totalFileCount: number;
+}
+export interface LanguageBreakdown {
+    primary: string;
+    languages: Record<string, LanguageStat>;
+}
+export interface LanguageStat {
+    name: string;
+    fileCount: number;
+    percentage: number;
+    extensions: string[];
+}
+export interface FrameworkResult {
+    frameworks: DetectedFramework[];
+    buildTools: string[];
+    packageManager: 'npm' | 'yarn' | 'pnpm' | 'unknown';
+}
+export interface DetectedFramework {
+    name: string;
+    version?: string;
+    category: 'frontend' | 'backend' | 'testing' | 'bundler' | 'css' | 'other';
+    confidence: 'high' | 'medium' | 'low';
+}
+export interface DependencyReport {
+    totalDependencies: number;
+    totalDevDependencies: number;
+    dependencies: Record<string, string>;
+    devDependencies: Record<string, string>;
+    risks: DependencyRisk[];
+}
+export interface DependencyRisk {
+    name: string;
+    reason: string;
+    severity: 'low' | 'medium' | 'high';
+}
+export type IssueSeverity = 'info' | 'warning' | 'error';
+export interface Issue {
+    id: string;
+    title: string;
+    description: string;
+    severity: IssueSeverity;
+    category: string;
+    fixAvailable: boolean;
+    fixId?: string;
+}
+export interface Fix {
+    id: string;
+    title: string;
+    description: string;
+    issueId: string;
+    apply: (rootPath: string) => Promise<void>;
+}
+export interface FixResult {
+    fix: Fix;
+    success: boolean;
+    error?: string;
+}
+export interface FileExplanation {
+    filePath: string;
+    purpose: string;
+    imports: ImportInfo[];
+    exports: ExportInfo[];
+    potentialIssues: string[];
+    lineCount: number;
+}
+export interface ImportInfo {
+    source: string;
+    specifiers: string[];
+    isRelative: boolean;
+}
+export interface ExportInfo {
+    name: string;
+    type: 'function' | 'class' | 'variable' | 'type' | 'interface' | 'default' | 'unknown';
+}
+export interface ArchitectureLayer {
+    name: string;
+    technologies: string[];
+    directories: string[];
+}
+export interface AnalysisReport {
+    projectName: string;
+    rootPath: string;
+    scan: ScanResult;
+    languages: LanguageBreakdown;
+    frameworks: FrameworkResult;
+    dependencies: DependencyReport | null;
+    issues: Issue[];
+    timestamp: string;
+}
+export type ReportFormat = 'console' | 'json' | 'markdown';

package/dist/types.js

@@ -0,0 +1,3 @@
+// === Scanning Results ===
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,2BAA2B"}

package/dist/utils/cache.d.ts

@@ -0,0 +1,3 @@
+export declare function cacheGet<T>(key: string): Promise<T | null>;
+export declare function cacheSet<T>(key: string, data: T, ttlMs?: number): Promise<void>;
+export declare function cacheInvalidate(key: string): Promise<void>;

package/dist/utils/cache.js

@@ -0,0 +1,51 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import os from 'node:os';
+import crypto from 'node:crypto';
+const CACHE_DIR = path.join(os.tmpdir(), 'projscan-cache');
+const DEFAULT_TTL_MS = 60_000; // 1 minute
+async function ensureCacheDir() {
+    await fs.mkdir(CACHE_DIR, { recursive: true });
+}
+function getCacheFilePath(key) {
+    const hash = crypto.createHash('sha256').update(key).digest('hex').slice(0, 16);
+    return path.join(CACHE_DIR, `${hash}.json`);
+}
+export async function cacheGet(key) {
+    try {
+        const filePath = getCacheFilePath(key);
+        const raw = await fs.readFile(filePath, 'utf-8');
+        const entry = JSON.parse(raw);
+        if (Date.now() > entry.expiresAt) {
+            await fs.unlink(filePath).catch(() => { });
+            return null;
+        }
+        return entry.data;
+    }
+    catch {
+        return null;
+    }
+}
+export async function cacheSet(key, data, ttlMs = DEFAULT_TTL_MS) {
+    try {
+        await ensureCacheDir();
+        const filePath = getCacheFilePath(key);
+        const entry = {
+            data,
+            expiresAt: Date.now() + ttlMs,
+        };
+        await fs.writeFile(filePath, JSON.stringify(entry), 'utf-8');
+    }
+    catch {
+        // Cache write failure is non-critical
+    }
+}
+export async function cacheInvalidate(key) {
+    try {
+        await fs.unlink(getCacheFilePath(key));
+    }
+    catch {
+        // Ignore
+    }
+}
+//# sourceMappingURL=cache.js.map

package/dist/utils/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/utils/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,gBAAgB,CAAC,CAAC;AAC3D,MAAM,cAAc,GAAG,MAAM,CAAC,CAAC,WAAW;AAE1C,KAAK,UAAU,cAAc;IAC3B,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAW;IACnC,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAChF,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,OAAO,CAAC,CAAC;AAC9C,CAAC;AAOD,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAI,GAAW;IAC3C,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACjD,MAAM,KAAK,GAAkB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE7C,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;YACjC,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAC1C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC;IACpB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAI,GAAW,EAAE,IAAO,EAAE,KAAK,GAAG,cAAc;IAC5E,IAAI,CAAC;QACH,MAAM,cAAc,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,KAAK,GAAkB;YAC3B,IAAI;YACJ,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK;SAC9B,CAAC;QACF,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,sCAAsC;IACxC,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,GAAW;IAC/C,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,SAAS;IACX,CAAC;AACH,CAAC"}

package/dist/utils/fileWalker.d.ts

@@ -0,0 +1,7 @@
+import type { FileEntry } from '../types.js';
+export interface WalkOptions {
+    ignore?: string[];
+    extensions?: string[];
+}
+export declare function walkFiles(rootPath: string, options?: WalkOptions): Promise<FileEntry[]>;
+export declare function getDefaultIgnorePatterns(): string[];

package/dist/utils/fileWalker.js

@@ -0,0 +1,45 @@
+import fg from 'fast-glob';
+import path from 'node:path';
+const DEFAULT_IGNORE = [
+    '**/node_modules/**',
+    '**/.git/**',
+    '**/dist/**',
+    '**/build/**',
+    '**/coverage/**',
+    '**/.next/**',
+    '**/.nuxt/**',
+    '**/.cache/**',
+    '**/.turbo/**',
+    '**/.output/**',
+];
+export async function walkFiles(rootPath, options) {
+    const ignore = options?.ignore ?? DEFAULT_IGNORE;
+    let pattern = '**/*';
+    if (options?.extensions?.length) {
+        const exts = options.extensions.map((e) => e.replace(/^\./, ''));
+        pattern = exts.length === 1 ? `**/*.${exts[0]}` : `**/*.{${exts.join(',')}}`;
+    }
+    const entries = await fg(pattern, {
+        cwd: rootPath,
+        absolute: false,
+        dot: true,
+        ignore,
+        stats: true,
+        onlyFiles: true,
+    });
+    return entries.map((entry) => {
+        const relativePath = typeof entry === 'string' ? entry : entry.path;
+        const stats = typeof entry === 'string' ? undefined : entry.stats;
+        return {
+            relativePath,
+            absolutePath: path.resolve(rootPath, relativePath),
+            extension: path.extname(relativePath).toLowerCase(),
+            sizeBytes: stats?.size ?? 0,
+            directory: path.dirname(relativePath),
+        };
+    });
+}
+export function getDefaultIgnorePatterns() {
+    return [...DEFAULT_IGNORE];
+}
+//# sourceMappingURL=fileWalker.js.map

package/dist/utils/fileWalker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileWalker.js","sourceRoot":"","sources":["../../src/utils/fileWalker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,WAAW,CAAC;AAC3B,OAAO,IAAI,MAAM,WAAW,CAAC;AAQ7B,MAAM,cAAc,GAAG;IACrB,oBAAoB;IACpB,YAAY;IACZ,YAAY;IACZ,aAAa;IACb,gBAAgB;IAChB,aAAa;IACb,aAAa;IACb,cAAc;IACd,cAAc;IACd,eAAe;CAChB,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,QAAgB,EAAE,OAAqB;IACrE,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,cAAc,CAAC;IAEjD,IAAI,OAAO,GAAG,MAAM,CAAC;IACrB,IAAI,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;QACjE,OAAO,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAC/E,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,EAAE;QAChC,GAAG,EAAE,QAAQ;QACb,QAAQ,EAAE,KAAK;QACf,GAAG,EAAE,IAAI;QACT,MAAM;QACN,KAAK,EAAE,IAAI;QACX,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3B,MAAM,YAAY,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;QACpE,MAAM,KAAK,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;QAElE,OAAO;YACL,YAAY;YACZ,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC;YAClD,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE;YACnD,SAAS,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC;YAC3B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;SACtC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,wBAAwB;IACtC,OAAO,CAAC,GAAG,cAAc,CAAC,CAAC;AAC7B,CAAC"}

package/dist/utils/logger.d.ts

@@ -0,0 +1,9 @@
+export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'quiet';
+export declare function setLogLevel(level: LogLevel): void;
+export declare function getLogLevel(): LogLevel;
+export declare const logger: {
+    debug(message: string, ...args: unknown[]): void;
+    info(message: string, ...args: unknown[]): void;
+    warn(message: string, ...args: unknown[]): void;
+    error(message: string, ...args: unknown[]): void;
+};

package/dist/utils/logger.js

@@ -0,0 +1,41 @@
+import chalk from 'chalk';
+const LOG_LEVELS = {
+    debug: 0,
+    info: 1,
+    warn: 2,
+    error: 3,
+    quiet: 4,
+};
+let currentLevel = 'info';
+export function setLogLevel(level) {
+    currentLevel = level;
+}
+export function getLogLevel() {
+    return currentLevel;
+}
+function shouldLog(level) {
+    return LOG_LEVELS[level] >= LOG_LEVELS[currentLevel];
+}
+export const logger = {
+    debug(message, ...args) {
+        if (shouldLog('debug')) {
+            console.log(chalk.gray(`[debug] ${message}`), ...args);
+        }
+    },
+    info(message, ...args) {
+        if (shouldLog('info')) {
+            console.log(message, ...args);
+        }
+    },
+    warn(message, ...args) {
+        if (shouldLog('warn')) {
+            console.warn(chalk.yellow(`⚠ ${message}`), ...args);
+        }
+    },
+    error(message, ...args) {
+        if (shouldLog('error')) {
+            console.error(chalk.red(`✗ ${message}`), ...args);
+        }
+    },
+};
+//# sourceMappingURL=logger.js.map

package/dist/utils/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,MAAM,UAAU,GAA6B;IAC3C,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,CAAC;CACT,CAAC;AAEF,IAAI,YAAY,GAAa,MAAM,CAAC;AAEpC,MAAM,UAAU,WAAW,CAAC,KAAe;IACzC,YAAY,GAAG,KAAK,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,WAAW;IACzB,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,SAAS,CAAC,KAAe;IAChC,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,KAAK,CAAC,OAAe,EAAE,GAAG,IAAe;QACvC,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,GAAG,IAAe;QACtC,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,GAAG,IAAe;QACtC,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,IAAe;QACvC,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;YACvB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;CACF,CAAC"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "projscan",
+  "version": "0.1.0",
+  "description": "Instant codebase insights — doctor, x-ray, and architecture map for any repository",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "projscan": "./dist/cli/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src/",
+    "format": "prettier --write .",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "cli",
+    "developer-tools",
+    "codebase-analysis",
+    "project-health",
+    "architecture",
+    "linting",
+    "devtools"
+  ],
+  "author": "",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^12.1.0",
+    "fast-glob": "^3.3.2",
+    "ora": "^8.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0"
+  }
+}