knip 0.3.0 → 0.4.0

package/README.md

@@ -79,16 +79,18 @@ Please read on if you think you have too many results: [too many false positives
 knip [options]
 
 Options:
-  -c/--config [file]   Configuration file path (default: ./knip.json or package.json#knip)
-  -t/--tsConfig [file] TypeScript configuration path (default: ./tsconfig.json)
-  --dir                Working directory (default: current working directory)
-  --include            Report only listed issue group(s) (see below)
-  --exclude            Exclude issue group(s) from report (see below)
-  --dev                Include `devDependencies` in report(s) (default: false)
-  --no-progress        Don't show dynamic progress updates
-  --max-issues         Maximum number of issues before non-zero exit code (default: 0)
-  --reporter           Select reporter: symbols, compact (default: symbols)
-  --jsdoc              Enable JSDoc parsing, with options: public (default: disabled)
+  -c/--config [file]     Configuration file path (default: ./knip.json or package.json#knip)
+  -t/--tsConfig [file]   TypeScript configuration path (default: ./tsconfig.json)
+  --dir                  Working directory (default: current working directory)
+  --include              Report only listed issue group(s) (see below)
+  --exclude              Exclude issue group(s) from report (see below)
+  --ignore               Ignore files matching this glob pattern (can be set multiple times)
+  --no-gitignore         Don't use .gitignore
+  --dev                  Include `devDependencies` in report(s)
+  --no-progress          Don't show dynamic progress updates
+  --max-issues           Maximum number of issues before non-zero exit code (default: 0)
+  --reporter             Select reporter: symbols, compact (default: symbols)
+  --jsdoc                Enable JSDoc parsing, with options: public
 
 Issue groups: files, dependencies, unlisted, exports, nsExports, types, nsTypes, duplicates
 
@@ -97,6 +99,7 @@ Examples:
 $ knip
 $ knip --dir packages/client --include files
 $ knip -c ./knip.js --reporter compact --jsdoc public
+$ knip --ignore 'lib/**/*.ts' --ignore build
 
 More info: https://github.com/webpro/knip
 ```

package/dist/cli.js

@@ -9,10 +9,11 @@ const node_util_1 = require("node:util");
 const typescript_1 = __importDefault(require("typescript"));
 const help_1 = require("./help");
 const config_1 = require("./util/config");
-const path_1 = require("./util/path");
+const fs_1 = require("./util/fs");
+const ignore_1 = require("./util/ignore");
 const reporters_1 = __importDefault(require("./reporters"));
 const _1 = require(".");
-const { values: { help, dir, config: configFilePath = 'knip.json', tsConfig: tsConfigFilePath, include = [], exclude = [], dev: isDev = false, 'no-progress': noProgress = false, reporter = 'symbols', jsdoc = [], 'max-issues': maxIssues = '0', }, } = (0, node_util_1.parseArgs)({
+const { values: { help, dir, config: configFilePath = 'knip.json', tsConfig: tsConfigFilePath, include = [], exclude = [], dev: isDev = false, 'no-progress': noProgress = false, ignore = [], 'no-gitignore': isNoGitIgnore = false, reporter = 'symbols', jsdoc = [], 'max-issues': maxIssues = '0', }, } = (0, node_util_1.parseArgs)({
     options: {
         help: { type: 'boolean' },
         config: { type: 'string', short: 'c' },
@@ -22,6 +23,8 @@ const { values: { help, dir, config: configFilePath = 'knip.json', tsConfig: tsC
         exclude: { type: 'string', multiple: true },
         dev: { type: 'boolean' },
         'max-issues': { type: 'string' },
+        ignore: { type: 'string', multiple: true },
+        'no-gitignore': { type: 'boolean' },
         'no-progress': { type: 'boolean' },
         reporter: { type: 'string' },
         jsdoc: { type: 'string', multiple: true },
@@ -36,8 +39,8 @@ const workingDir = dir ? node_path_1.default.resolve(dir) : cwd;
 const isShowProgress = noProgress === false ? process.stdout.isTTY && typeof process.stdout.cursorTo === 'function' : !noProgress;
 const printReport = reporter in reporters_1.default ? reporters_1.default[reporter] : require(node_path_1.default.join(workingDir, reporter));
 const main = async () => {
-    const localConfigurationPath = await (0, path_1.findFile)(workingDir, configFilePath);
-    const manifestPath = await (0, path_1.findFile)(workingDir, 'package.json');
+    const localConfigurationPath = await (0, fs_1.findFile)(workingDir, configFilePath);
+    const manifestPath = await (0, fs_1.findFile)(workingDir, 'package.json');
     const localConfiguration = localConfigurationPath && require(localConfigurationPath);
     const manifest = manifestPath && require(manifestPath);
     if (!localConfigurationPath && !manifest.knip) {
@@ -53,7 +56,7 @@ const main = async () => {
     }
     const report = (0, config_1.resolveIncludedIssueGroups)(include, exclude, resolvedConfig);
     let tsConfigPaths = [];
-    const tsConfigPath = await (0, path_1.findFile)(workingDir, tsConfigFilePath ?? 'tsconfig.json');
+    const tsConfigPath = await (0, fs_1.findFile)(workingDir, tsConfigFilePath ?? 'tsconfig.json');
     if (tsConfigFilePath && !tsConfigPath) {
         console.error(`Unable to find ${tsConfigFilePath}\n`);
         (0, help_1.printHelp)();
@@ -70,6 +73,11 @@ const main = async () => {
             process.exit(1);
         }
     }
+    const ignorePatterns = ignore.map(ignore_1.convertPattern);
+    if (!isNoGitIgnore) {
+        const patterns = await (0, ignore_1.readIgnorePatterns)(cwd, workingDir);
+        patterns.forEach(pattern => ignorePatterns.push(pattern));
+    }
     const config = {
         workingDir,
         report,
@@ -78,6 +86,7 @@ const main = async () => {
         isDev: typeof resolvedConfig.dev === 'boolean' ? resolvedConfig.dev : isDev,
         tsConfigFilePath,
         tsConfigPaths,
+        ignorePatterns,
         isShowProgress,
         jsDocOptions: {
             isReadPublicTag: jsdoc.includes('public'),

package/dist/help.js

@@ -5,16 +5,18 @@ const printHelp = () => {
     console.log(`knip [options]
 
 Options:
-  -c/--config [file]   Configuration file path (default: ./knip.json or package.json#knip)
-  -t/--tsConfig [file] TypeScript configuration path (default: ./tsconfig.json)
-  --dir                Working directory (default: current working directory)
-  --include            Report only listed issue group(s) (see below)
-  --exclude            Exclude issue group(s) from report (see below)
-  --dev                Include \`devDependencies\` in report(s) (default: false)
-  --no-progress        Don't show dynamic progress updates
-  --max-issues         Maximum number of issues before non-zero exit code (default: 0)
-  --reporter           Select reporter: symbols, compact (default: symbols)
-  --jsdoc              Enable JSDoc parsing, with options: public (default: disabled)
+  -c/--config [file]     Configuration file path (default: ./knip.json or package.json#knip)
+  -t/--tsConfig [file]   TypeScript configuration path (default: ./tsconfig.json)
+  --dir                  Working directory (default: current working directory)
+  --include              Report only listed issue group(s) (see below)
+  --exclude              Exclude issue group(s) from report (see below)
+  --ignore               Ignore files matching this glob pattern (can be set multiple times)
+  --no-gitignore         Don't use .gitignore
+  --dev                  Include \`devDependencies\` in report(s)
+  --no-progress          Don't show dynamic progress updates
+  --max-issues           Maximum number of issues before non-zero exit code (default: 0)
+  --reporter             Select reporter: symbols, compact (default: symbols)
+  --jsdoc                Enable JSDoc parsing, with options: public
 
 Issue groups: files, dependencies, unlisted, exports, nsExports, types, nsTypes, duplicates
 
@@ -23,6 +25,7 @@ Examples:
 $ knip
 $ knip --dir packages/client --include files
 $ knip -c ./knip.js --reporter compact --jsdoc public
+$ knip --ignore 'lib/**/*.ts' --ignore build
 
 More info: https://github.com/webpro/knip`);
 };

package/dist/types.d.ts

@@ -20,11 +20,11 @@ export declare type Issues = {
     nsTypes: UnusedExportIssues;
     duplicates: UnusedExportIssues;
 };
-export declare type IssueType = keyof Issues;
+declare type IssueType = keyof Issues;
 export declare type ProjectIssueType = Extract<IssueType, 'files' | 'dependencies' | 'devDependencies'>;
 export declare type SymbolIssueType = Exclude<IssueType, ProjectIssueType>;
 export declare type IssueGroup = 'files' | 'dependencies' | 'unlisted' | 'exports' | 'nsExports' | 'types' | 'nsTypes' | 'duplicates';
-export declare type BaseLocalConfiguration = {
+declare type BaseLocalConfiguration = {
     entryFiles: string[];
     projectFiles: string[];
 };
@@ -46,6 +46,7 @@ export declare type Configuration = LocalConfiguration & {
     isDev: boolean;
     tsConfigFilePath: undefined | string;
     tsConfigPaths: string[];
+    ignorePatterns: string[];
     isShowProgress: boolean;
     jsDocOptions: {
         isReadPublicTag: boolean;

package/dist/util/fs.d.ts

@@ -0,0 +1,2 @@
+export declare const isFile: (filePath: string) => Promise<boolean>;
+export declare const findFile: (cwd: string, fileName: string) => Promise<string | undefined>;

package/dist/util/fs.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findFile = exports.isFile = void 0;
+const promises_1 = __importDefault(require("node:fs/promises"));
+const node_path_1 = __importDefault(require("node:path"));
+const isFile = async (filePath) => {
+    try {
+        const stats = await promises_1.default.stat(filePath);
+        return stats.isFile();
+    }
+    catch {
+        return false;
+    }
+};
+exports.isFile = isFile;
+const findFile = async (cwd, fileName) => {
+    const filePath = node_path_1.default.join(cwd, fileName);
+    if (await (0, exports.isFile)(filePath)) {
+        return filePath;
+    }
+    else {
+        const parentDir = node_path_1.default.resolve(cwd, '..');
+        return parentDir === '/' ? undefined : (0, exports.findFile)(parentDir, fileName);
+    }
+};
+exports.findFile = findFile;

package/dist/util/ignore.d.ts

@@ -0,0 +1,2 @@
+export declare const convertPattern: (pattern: string) => string;
+export declare const readIgnorePatterns: (cwd: string, workingDir: string) => Promise<string[]>;

package/dist/util/ignore.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readIgnorePatterns = exports.convertPattern = void 0;
+const promises_1 = __importDefault(require("node:fs/promises"));
+const node_path_1 = __importDefault(require("node:path"));
+const fs_1 = require("./fs");
+const path_1 = require("./path");
+const convertPattern = (pattern) => (pattern.startsWith('!') ? pattern.substring(1) : `!${pattern}`);
+exports.convertPattern = convertPattern;
+const readIgnoreFile = async (filePath) => {
+    let contents = '';
+    try {
+        contents = (await promises_1.default.readFile(filePath)).toString();
+    }
+    catch (error) {
+    }
+    return contents.split(/\r?\n/).filter(line => line && !line.startsWith('#'));
+};
+const traverseDirs = async (rootDir, currentDir, patterns = []) => {
+    const gitIgnorePath = node_path_1.default.join(currentDir, '.gitignore');
+    const parentDir = node_path_1.default.resolve(currentDir, '..');
+    if (await (0, fs_1.isFile)(gitIgnorePath)) {
+        (await readIgnoreFile(gitIgnorePath))
+            .map(pattern => (0, path_1.addWorkingDirToPattern)(currentDir, pattern))
+            .forEach(pattern => patterns.push(pattern));
+    }
+    if (rootDir === currentDir || parentDir === '/')
+        return patterns;
+    return traverseDirs(rootDir, parentDir, patterns);
+};
+const readIgnorePatterns = async (cwd, workingDir) => {
+    const patterns = await traverseDirs(cwd, workingDir);
+    return patterns.map(exports.convertPattern);
+};
+exports.readIgnorePatterns = readIgnorePatterns;

package/dist/util/path.d.ts

@@ -1 +1,3 @@
-export declare const findFile: (cwd: string, fileName: string) => Promise<string | undefined>;
+import type { Configuration } from '../types';
+export declare const addWorkingDirToPattern: (workingDir: string, pattern: string) => string;
+export declare const resolvePaths: (configuration: Configuration, patterns: string[]) => string[];

package/dist/util/path.js

@@ -3,26 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findFile = void 0;
-const promises_1 = __importDefault(require("node:fs/promises"));
+exports.resolvePaths = exports.addWorkingDirToPattern = void 0;
 const node_path_1 = __importDefault(require("node:path"));
-const isFile = async (filePath) => {
-    try {
-        const stats = await promises_1.default.stat(filePath);
-        return stats.isFile();
-    }
-    catch {
-        return false;
-    }
+const addWorkingDirToPattern = (workingDir, pattern) => {
+    if (pattern.startsWith('!'))
+        return '!' + node_path_1.default.join(workingDir, pattern.slice(1));
+    return node_path_1.default.join(workingDir, pattern);
 };
-const findFile = async (cwd, fileName) => {
-    const filePath = node_path_1.default.join(cwd, fileName);
-    if (await isFile(filePath)) {
-        return filePath;
-    }
-    else {
-        const parentDir = node_path_1.default.resolve(cwd, '..');
-        return parentDir === '/' ? undefined : (0, exports.findFile)(parentDir, fileName);
-    }
+exports.addWorkingDirToPattern = addWorkingDirToPattern;
+const resolvePaths = (configuration, patterns) => {
+    const { workingDir } = configuration;
+    return patterns.map(pattern => (0, exports.addWorkingDirToPattern)(workingDir, pattern));
 };
-exports.findFile = findFile;
+exports.resolvePaths = resolvePaths;

package/dist/util/project.d.ts

@@ -1,5 +1,5 @@
 import { Project } from 'ts-morph';
 import type { SourceFile } from 'ts-morph';
 import type { Configuration } from '../types';
-export declare const createProject: (configuration: Configuration, paths?: string | string[]) => Promise<Project>;
+export declare const createProject: (configuration: Configuration, paths?: string[]) => Promise<Project>;
 export declare const partitionSourceFiles: (projectFiles: SourceFile[], productionFiles: SourceFile[]) => SourceFile[][];

package/dist/util/project.js

@@ -1,28 +1,20 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.partitionSourceFiles = exports.createProject = void 0;
-const node_path_1 = __importDefault(require("node:path"));
 const ts_morph_1 = require("ts-morph");
-const resolvePaths = (cwd, patterns) => {
-    return [patterns].flat().map(pattern => {
-        if (pattern.startsWith('!'))
-            return '!' + node_path_1.default.join(cwd, pattern.slice(1));
-        return node_path_1.default.join(cwd, pattern);
-    });
-};
+const path_1 = require("./path");
 const createProject = async (configuration, paths) => {
-    const { tsConfigFilePath, workingDir } = configuration;
+    const { tsConfigFilePath, ignorePatterns } = configuration;
     const tsConfig = tsConfigFilePath ? { tsConfigFilePath } : { compilerOptions: { allowJs: true } };
     const workspace = new ts_morph_1.Project({
         ...tsConfig,
         skipAddingFilesFromTsConfig: true,
         skipFileDependencyResolution: true,
     });
-    if (paths)
-        workspace.addSourceFilesAtPaths(resolvePaths(workingDir, paths));
+    if (paths) {
+        const resolvedPaths = (0, path_1.resolvePaths)(configuration, paths);
+        workspace.addSourceFilesAtPaths([...resolvedPaths, ...ignorePatterns]);
+    }
     return workspace;
 };
 exports.createProject = createProject;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Find unused files and exports in your TypeScript project",
   "keywords": [
     "find",