@mathonsunday/dead-code-toolkit 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,177 @@
+/**
+ * Core type definitions for dead code analysis toolkit
+ */
+/**
+ * Configuration options for dead code analysis
+ */
+export interface AnalysisOptions {
+    /** Absolute path to project root directory */
+    projectRoot: string;
+    /** Which checks to run. Default: all */
+    checks?: CheckType[];
+    /** Automatically fix issues where possible */
+    fix?: boolean;
+    /** Custom paths to configuration files */
+    configPaths?: Partial<Record<string, string>>;
+    /** Verbose logging output */
+    verbose?: boolean;
+}
+/**
+ * Available check types
+ */
+export type CheckType = 'knip' | 'typescript' | 'eslint' | 'type-coverage' | 'exhaustiveness' | 'all';
+/**
+ * Result of a single analysis check
+ */
+export interface CheckResult {
+    type: CheckType;
+    status: 'success' | 'failure' | 'skipped';
+    findings: Finding[];
+    executionTime: number;
+    error?: string;
+}
+/**
+ * Individual finding - a piece of dead code or issue detected
+ */
+export interface Finding {
+    /** Category of the finding */
+    category: 'unused-export' | 'unused-file' | 'unused-dependency' | 'type-error' | 'unused-var' | 'redundant-type' | 'union-issue' | 'unused-param';
+    /** Severity level */
+    severity: 'error' | 'warning' | 'info';
+    /** File path (relative to project root) */
+    file: string;
+    /** Line number (1-based, if applicable) */
+    line?: number;
+    /** Column number (1-based, if applicable) */
+    column?: number;
+    /** Human-readable message describing the issue */
+    message: string;
+    /** Whether this issue can be automatically fixed */
+    fixable: boolean;
+    /** Suggestion for how to fix the issue */
+    suggestion?: string;
+    /** Source tool that detected this */
+    source: CheckType;
+    /** Rule name or code from the tool */
+    rule?: string;
+}
+/**
+ * Summary statistics for analysis results
+ */
+export interface AnalysisSummary {
+    /** Total number of issues found */
+    totalIssues: number;
+    /** Breakdown by category */
+    byCategory: Record<string, number>;
+    /** Number of issues that can be auto-fixed */
+    fixableCount: number;
+    /** Number of errors (highest severity) */
+    errorCount: number;
+    /** Number of warnings */
+    warningCount: number;
+    /** Number of info/low severity items */
+    infoCount: number;
+}
+/**
+ * Complete analysis result
+ */
+export interface AnalysisResult {
+    /** Overall status of the analysis */
+    status: 'success' | 'partial' | 'failure';
+    /** Summary statistics */
+    summary: AnalysisSummary;
+    /** All findings from all checks */
+    findings: Finding[];
+    /** Results from individual checks */
+    checkResults: CheckResult[];
+    /** Total execution time in milliseconds */
+    executionTime: number;
+    /** Error message if status is 'failure' */
+    error?: string;
+}
+/**
+ * Result of applying fixes
+ */
+export interface FixResult {
+    /** Overall status */
+    status: 'success' | 'partial' | 'failure';
+    /** Number of issues fixed */
+    fixedCount: number;
+    /** Number of issues that could not be fixed */
+    unfixedCount: number;
+    /** Files that were modified */
+    modifiedFiles: string[];
+    /** Details of what was fixed */
+    fixes: FixDetail[];
+    /** Any errors that occurred */
+    errors?: string[];
+}
+/**
+ * Details about a single fix that was applied
+ */
+export interface FixDetail {
+    /** The finding that was fixed */
+    finding: Finding;
+    /** What was changed */
+    action: string;
+    /** Was it successful */
+    success: boolean;
+    /** Error message if unsuccessful */
+    error?: string;
+}
+/**
+ * Configuration options for setup
+ */
+export interface SetupOptions {
+    /** Absolute path to project root */
+    projectRoot: string;
+    /** Install pre-commit hooks */
+    setupHooks?: boolean;
+    /** Install npm dependencies */
+    installDependencies?: boolean;
+    /** Override default configs */
+    configOverrides?: Partial<Record<string, unknown>>;
+    /** Show detailed output */
+    verbose?: boolean;
+}
+/**
+ * Result of setup process
+ */
+export interface SetupResult {
+    /** Overall status */
+    status: 'success' | 'partial' | 'failure';
+    /** Files created during setup */
+    filesCreated: string[];
+    /** Scripts added to package.json */
+    scriptsAdded: string[];
+    /** Dependencies installed */
+    dependenciesInstalled: string[];
+    /** Next steps for user */
+    nextSteps: string[];
+    /** Any errors that occurred */
+    errors?: string[];
+}
+/**
+ * Detected project configuration
+ */
+export interface ProjectConfig {
+    /** Root directory */
+    root: string;
+    /** Whether package.json exists */
+    hasPackageJson: boolean;
+    /** Whether TypeScript is configured */
+    hasTypeScript: boolean;
+    /** TypeScript config path if present */
+    tsconfigPath?: string;
+    /** Project type */
+    type: 'react' | 'node' | 'fullstack' | 'unknown';
+    /** Existing tool configs present */
+    existingConfigs: {
+        eslint?: string;
+        prettier?: string;
+        knip?: string;
+        husky?: string;
+        [key: string]: string | undefined;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,8CAA8C;IAC9C,WAAW,EAAE,MAAM,CAAC;IAEpB,wCAAwC;IACxC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IAErB,8CAA8C;IAC9C,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,0CAA0C;IAC1C,WAAW,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAE9C,6BAA6B;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,YAAY,GAAG,QAAQ,GAAG,eAAe,GAAG,gBAAgB,GAAG,KAAK,CAAC;AAEtG;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IAC1C,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,8BAA8B;IAC9B,QAAQ,EAAE,eAAe,GAAG,aAAa,GAAG,mBAAmB,GAAG,YAAY,GAAG,YAAY,GAAG,gBAAgB,GAAG,aAAa,GAAG,cAAc,CAAC;IAElJ,qBAAqB;IACrB,QAAQ,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IAEvC,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IAEb,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAEhB,oDAAoD;IACpD,OAAO,EAAE,OAAO,CAAC;IAEjB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,MAAM,EAAE,SAAS,CAAC;IAElB,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;IAEpB,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEnC,8CAA8C;IAC9C,YAAY,EAAE,MAAM,CAAC;IAErB,0CAA0C;IAC1C,UAAU,EAAE,MAAM,CAAC;IAEnB,yBAAyB;IACzB,YAAY,EAAE,MAAM,CAAC;IAErB,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,qCAAqC;IACrC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IAE1C,yBAAyB;IACzB,OAAO,EAAE,eAAe,CAAC;IAEzB,mCAAmC;IACnC,QAAQ,EAAE,OAAO,EAAE,CAAC;IAEpB,qCAAqC;IACrC,YAAY,EAAE,WAAW,EAAE,CAAC;IAE5B,2CAA2C;IAC3C,aAAa,EAAE,MAAM,CAAC;IAEtB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,qBAAqB;IACrB,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IAE1C,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAC;IAEnB,+CAA+C;IAC/C,YAAY,EAAE,MAAM,CAAC;IAErB,+BAA+B;IAC/B,aAAa,EAAE,MAAM,EAAE,CAAC;IAExB,gCAAgC;IAChC,KAAK,EAAE,SAAS,EAAE,CAAC;IAEnB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,OAAO,EAAE,OAAO,CAAC;IAEjB,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IAEf,wBAAwB;IACxB,OAAO,EAAE,OAAO,CAAC;IAEjB,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IAEpB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,+BAA+B;IAC/B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B,+BAA+B;IAC/B,eAAe,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAEnD,2BAA2B;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,qBAAqB;IACrB,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IAE1C,iCAAiC;IACjC,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB,oCAAoC;IACpC,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB,6BAA6B;IAC7B,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAEhC,0BAA0B;IAC1B,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IAEb,kCAAkC;IAClC,cAAc,EAAE,OAAO,CAAC;IAExB,uCAAuC;IACvC,aAAa,EAAE,OAAO,CAAC;IAEvB,wCAAwC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,mBAAmB;IACnB,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;IAEjD,oCAAoC;IACpC,eAAe,EAAE;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACnC,CAAC;CACH"}

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * Core type definitions for dead code analysis toolkit
+ */
+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;;GAEG"}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@mathonsunday/dead-code-toolkit",
+  "version": "0.1.0",
+  "description": "Comprehensive dead code detection and cleanup toolkit for TypeScript projects. Detects unused exports, files, dependencies, type errors, and more via Knip, TypeScript, ESLint, and custom analysis.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "dead-code-toolkit": "./dist/cli/index.js"
+  },
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./setup": {
+      "import": "./dist/setup/installer.js",
+      "types": "./dist/setup/installer.d.ts"
+    },
+    "./analyze": {
+      "import": "./dist/analyzer.js",
+      "types": "./dist/analyzer.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "lint": "eslint src",
+    "type-check": "tsc --noEmit",
+    "dev": "tsc --watch"
+  },
+  "keywords": [
+    "dead-code",
+    "dead-code-detection",
+    "unused-exports",
+    "unused-files",
+    "typescript",
+    "linting",
+    "code-quality",
+    "cli",
+    "knip",
+    "eslint"
+  ],
+  "author": "mathonsunday",
+  "license": "MIT",
+  "dependencies": {
+    "@types/node": "^24.10.1",
+    "commander": "^12.1.0",
+    "typescript": "~5.9.3"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@types/node": "^24.10.1",
+    "eslint": "^9.39.1",
+    "typescript": "~5.9.3",
+    "typescript-eslint": "^8.46.4",
+    "vitest": "^4.0.17"
+  },
+  "peerDependencies": {
+    "knip": "^5.82.0 || ^6.0.0",
+    "eslint": "^9.0.0 || ^8.50.0"
+  },
+  "peerDependenciesOptional": {
+    "knip": "^5.82.0 || ^6.0.0",
+    "eslint": "^9.0.0 || ^8.50.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mathonsunday/dead-code-toolkit"
+  },
+  "bugs": {
+    "url": "https://github.com/mathonsunday/dead-code-toolkit/issues"
+  },
+  "homepage": "https://github.com/mathonsunday/dead-code-toolkit#readme"
+}