depcheck

import depcheck from 'depcheck'; import path from 'path'; interface DepcheckResults { dependencies: string[]; devDependencies: string[]; missing: { [key: string]: string[] }; using: { [key: string]: string[] }; invalidDirs: { [key: string]: string }; invalidFiles: { [key: string]: string }; } async function runDepcheck(projectRoot: string): Promise<void> { const options = { ignoreBinPackage: false, // ignore the packages with bin entry skipMissing: false, // skip calculation of missing dependencies json: true, // output results in JSON format ignorePatterns: [ 'dist', // ignore build output directory 'coverage', // ignore coverage directory '*.log' // ignore log files ], // Add 'typescript' if you have TypeScript files and it's not a direct dependency // 'parsers': { '*.ts': depcheck.parser.typescript }, // 'specials': [depcheck.special.eslint, depcheck.special.webpack] // example specials }; try { const results: DepcheckResults = await depcheck(projectRoot, options) as any; // Cast to any due to programmatic type nuances if (results.dependencies.length > 0) { console.log('Unused dependencies:', results.dependencies); } if (results.devDependencies.length > 0) { console.log('Unused devDependencies:', results.devDependencies); } if (Object.keys(results.missing).length > 0) { console.log('Missing dependencies:', results.missing); } if (Object.keys(results.using).length > 0) { console.log('Dependencies in use (example):', Object.keys(results.using).slice(0, 2)); } if (results.dependencies.length === 0 && results.devDependencies.length === 0 && Object.keys(results.missing).length === 0) { console.log('No depcheck issues found for this project.'); } } catch (error) { console.error('Depcheck encountered an error:', error); } } // Example usage: Point to a dummy project root (create a package.json and some files) // In a real scenario, this would be your actual project directory. const dummyProjectRoot = path.resolve(process.cwd(), 'temp-depcheck-project'); console.log(`Running depcheck in: ${dummyProjectRoot}`); // Create a dummy package.json and an index.ts/js to simulate a project // This part would typically be part of your project setup, not quickstart code. // For demonstration, assume a basic project structure already exists. // To make this runnable, ensure a 'temp-depcheck-project' exists with a package.json // Example setup: // mkdir temp-depcheck-project // cd temp-depcheck-project // echo '{ "name": "test-project", "version": "1.0.0", "dependencies": { "lodash": "^4.17.21" }, "devDependencies": { "jest": "^29.0.0" } }' > package.json // echo 'import { get } from "lodash"; console.log(get({}, "a"));' > index.js // echo 'const sum = require("non-existent-pkg");' > another.js // npm install runDepcheck(process.cwd()); // Or specify a relative path to your project