knip 0.2.0 → 0.3.0

package/README.md

@@ -1,14 +1,16 @@
 # ✂️ Knip
 
-Knip scans your TypeScript projects for **unused files and exports**. For comparison, ESLint finds unused variables
-inside files in isolation, but this will not be flagged:
+Knip scans your JavaScript and TypeScript projects for **unused files, dependencies and exports**. Things that should be
+eliminated. Less code means better performance and less to maintain, important for both UX and DX!
+
+For comparison, ESLint finds unused variables inside files in isolation, but this will not be flagged:
 
 ```ts
 export const myVar = true;
 ```
 
-Unused files will also not be detected by ESLint. So how do you know which files and exports are no longer used? This
-requires an analysis of all the right files in the project.
+Unused files will also not be detected by ESLint. So how do you know which files, dependencies and exports are no longer
+used? This requires an analysis of all the right files in the project.
 
 This is where Knip comes in:
 
@@ -17,7 +19,7 @@ This is where Knip comes in:
 - [x] Finds dependencies not listed in `package.json`.
 - [x] Finds duplicate exports of the same symbol.
 - [x] Supports JavaScript inside TypeScript projects (`"allowJs": true`)
-- [ ] Supports JavaScript-only projects with CommonJS and ESM (no `tsconfig.json`) - TODO
+- [x] Supports JavaScript-only projects using ESM (without a `tsconfig.json`)
 
 Knip really shines in larger projects where you have non-production files (such as `/docs`, `/tools` and `/scripts`).
 The `includes` setting in `tsconfig.json` is often too broad, resulting in too many false negatives. Similar projects
@@ -78,7 +80,8 @@ knip [options]
 
 Options:
   -c/--config [file]   Configuration file path (default: ./knip.json or package.json#knip)
-  --cwd                Working directory (default: current working directory)
+  -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)
@@ -92,7 +95,7 @@ Issue groups: files, dependencies, unlisted, exports, nsExports, types, nsTypes,
 Examples:
 
 $ knip
-$ knip --cwd packages/client --include files
+$ knip --dir packages/client --include files
 $ knip -c ./knip.js --reporter compact --jsdoc public
 
 More info: https://github.com/webpro/knip
@@ -143,8 +146,10 @@ Excluding non-production files from the `projectFiles` allows Knip to understand
 
 Non-production code includes files such as end-to-end tests, tooling, scripts, Storybook stories, etc.
 
+Think of it the same way as you would split `dependencies` and `devDependencies` in `package.json`.
+
 To include both production and test files to analyze the project as a whole, include both sets of files to `entryFiles`,
-and add `dev: true`:
+and add `dev: true` to a file named such as `knip.dev.json`:
 
 ```json
 {
@@ -154,7 +159,29 @@ and add `dev: true`:
 }
 ```
 
-Knip will now report unused files and exports for the combined set of files as configured in `entryFiles`.
+Use `-c knip.dev.json` and unused files and exports for the combined set of files as configured in `entryFiles` will be
+reported.
+
+An alternative way to store `dev` configuration is in this example `package.json`:
+
+```json
+{
+  "name": "my-package",
+  "scripts": {
+    "knip": "knip"
+  },
+  "knip": {
+    "entryFiles": ["src/index.ts"],
+    "projectFiles": ["src/**/*.ts", "!**/*.spec.ts"],
+    "dev": {
+      "entryFiles": ["src/index.ts", "src/**/*.spec.ts", "src/**/*.e2e.ts"],
+      "projectFiles": ["src/**/*.ts"]
+    }
+  }
+}
+```
+
+This way, the `--dev` flag will use the `dev` options (and also add `devDependencies` to the `dependencies` report).
 
 ## More configuration examples
 
@@ -179,8 +206,8 @@ Packages can also be explicitly configured per package directory.
 To scan the packages separately, using the first match from the configuration file:
 
 ```
-knip --cwd packages/client --config knip.json
-knip --cwd packages/services --config knip.json
+knip --cwd packages/client
+knip --cwd packages/services
 ```
 
 #### Connected projects
@@ -217,10 +244,14 @@ can be tweaked further to the project structure.
 ### Default reporter
 
 ```
-$ knip --config ./knip.json
+$ knip
 --- UNUSED FILES (2)
 src/chat/helpers.ts
 src/components/SideBar.tsx
+--- UNUSED DEPENDENCIES (1)
+moment
+--- UNLISTED DEPENDENCIES (1)
+react
 --- UNUSED EXPORTS (5)
 lowercaseFirstLetter  src/common/src/string/index.ts
 RegistrationBox       src/components/Registration.tsx
@@ -240,10 +271,14 @@ ProductsList, default  src/components/Products.tsx
 ### Compact
 
 ```
-$ knip --config ./knip.json --reporter compact
+$ knip --reporter compact
 --- UNUSED FILES (2)
 src/chat/helpers.ts
 src/components/SideBar.tsx
+--- UNUSED DEPENDENCIES (1)
+moment
+--- UNLISTED DEPENDENCIES (1)
+react
 --- UNUSED EXPORTS (4)
 src/common/src/string/index.ts: lowercaseFirstLetter
 src/components/Registration.tsx: RegistrationBox

package/dist/cli.js

@@ -12,11 +12,12 @@ const config_1 = require("./util/config");
 const path_1 = require("./util/path");
 const reporters_1 = __importDefault(require("./reporters"));
 const _1 = require(".");
-const { values: { help, cwd: cwdArg, config: configFilePath = 'knip.json', 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, reporter = 'symbols', jsdoc = [], 'max-issues': maxIssues = '0', }, } = (0, node_util_1.parseArgs)({
     options: {
         help: { type: 'boolean' },
         config: { type: 'string', short: 'c' },
-        cwd: { type: 'string' },
+        tsConfig: { type: 'string', short: 't' },
+        dir: { type: 'string' },
         include: { type: 'string', multiple: true },
         exclude: { type: 'string', multiple: true },
         dev: { type: 'boolean' },
@@ -31,48 +32,51 @@ if (help) {
     process.exit(0);
 }
 const cwd = process.cwd();
-const workingDir = cwdArg ? node_path_1.default.resolve(cwdArg) : cwd;
+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');
-    if (!manifestPath || !localConfigurationPath) {
+    const localConfiguration = localConfigurationPath && require(localConfigurationPath);
+    const manifest = manifestPath && require(manifestPath);
+    if (!localConfigurationPath && !manifest.knip) {
         const location = workingDir === cwd ? 'current directory' : `${node_path_1.default.relative(cwd, workingDir)} or up.`;
-        console.error(`Unable to find ${configFilePath} (or package.json#knip) in ${location}\n`);
+        console.error(`Unable to find ${configFilePath} or package.json#knip in ${location}\n`);
         (0, help_1.printHelp)();
         process.exit(1);
     }
-    const localConfiguration = require(localConfigurationPath);
-    const manifest = require(manifestPath);
-    const resolvedConfig = (0, config_1.resolveConfig)(manifest.knip ?? localConfiguration, cwdArg);
+    const resolvedConfig = (0, config_1.resolveConfig)(manifest.knip ?? localConfiguration, { workingDir: dir, isDev });
     if (!resolvedConfig) {
         (0, help_1.printHelp)();
         process.exit(1);
     }
     const report = (0, config_1.resolveIncludedIssueGroups)(include, exclude, resolvedConfig);
-    const tsConfigFile = await (0, path_1.findFile)(workingDir, 'tsconfig.json');
-    if (!tsConfigFile) {
-        const location = workingDir === cwd ? 'current directory' : `${node_path_1.default.relative(cwd, workingDir)} or up.`;
-        console.error(`Unable to find ${tsConfigFile} or package.json in ${location}\n`);
+    let tsConfigPaths = [];
+    const tsConfigPath = await (0, path_1.findFile)(workingDir, tsConfigFilePath ?? 'tsconfig.json');
+    if (tsConfigFilePath && !tsConfigPath) {
+        console.error(`Unable to find ${tsConfigFilePath}\n`);
         (0, help_1.printHelp)();
         process.exit(1);
     }
-    const tsConfig = typescript_1.default.readConfigFile(tsConfigFile, typescript_1.default.sys.readFile);
-    const tsConfigPaths = tsConfig.config.compilerOptions?.paths
-        ? Object.keys(tsConfig.config.compilerOptions.paths).map(p => p.replace(/\*/g, '**'))
-        : [];
-    if (tsConfig.error) {
-        console.error(`An error occured when reading ${node_path_1.default.relative(cwd, tsConfigFile)}.\n`);
-        (0, help_1.printHelp)();
-        process.exit(1);
+    if (tsConfigPath) {
+        const tsConfig = typescript_1.default.readConfigFile(tsConfigPath, typescript_1.default.sys.readFile);
+        tsConfigPaths = tsConfig.config.compilerOptions?.paths
+            ? Object.keys(tsConfig.config.compilerOptions.paths).map(p => p.replace(/\*/g, '**'))
+            : [];
+        if (tsConfig.error) {
+            console.error(`An error occured when reading ${node_path_1.default.relative(cwd, tsConfigPath)}.\n`);
+            (0, help_1.printHelp)();
+            process.exit(1);
+        }
     }
     const config = {
         workingDir,
         report,
         dependencies: Object.keys(manifest.dependencies ?? {}),
         devDependencies: Object.keys(manifest.devDependencies ?? {}),
-        isDev: resolvedConfig.dev ?? isDev,
+        isDev: typeof resolvedConfig.dev === 'boolean' ? resolvedConfig.dev : isDev,
+        tsConfigFilePath,
         tsConfigPaths,
         isShowProgress,
         jsDocOptions: {

package/dist/help.js

@@ -6,7 +6,8 @@ const printHelp = () => {
 
 Options:
   -c/--config [file]   Configuration file path (default: ./knip.json or package.json#knip)
-  --cwd                Working directory (default: current working directory)
+  -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)
@@ -20,7 +21,7 @@ Issue groups: files, dependencies, unlisted, exports, nsExports, types, nsTypes,
 Examples:
 
 $ knip
-$ knip --cwd packages/client --include files
+$ knip --dir packages/client --include files
 $ knip -c ./knip.js --reporter compact --jsdoc public
 
 More info: https://github.com/webpro/knip`);

package/dist/index.js

@@ -15,11 +15,11 @@ const lineRewriter = new log_1.LineRewriter();
 async function run(configuration) {
     const { workingDir, isShowProgress, report, isDev, jsDocOptions } = configuration;
     const { getUnresolvedDependencies, getUnusedDependencies, getUnusedDevDependencies } = (0, dependencies_1.getDependencyAnalyzer)(configuration);
-    const production = await (0, project_1.createProject)(workingDir, configuration.entryFiles);
+    const production = await (0, project_1.createProject)(configuration, configuration.entryFiles);
     const entryFiles = production.getSourceFiles();
     production.resolveSourceFileDependencies();
     const productionFiles = production.getSourceFiles();
-    const project = await (0, project_1.createProject)(workingDir, configuration.projectFiles);
+    const project = await (0, project_1.createProject)(configuration, configuration.projectFiles);
     const projectFiles = project.getSourceFiles();
     const [usedProductionFiles, unreferencedProductionFiles] = (0, project_1.partitionSourceFiles)(projectFiles, productionFiles);
     const [usedEntryFiles, usedNonEntryFiles] = (0, project_1.partitionSourceFiles)(usedProductionFiles, entryFiles);
@@ -127,6 +127,8 @@ async function run(configuration) {
                         if (declaration.isKind(ts_morph_1.ts.SyntaxKind.Identifier)) {
                             identifier = declaration;
                         }
+                        else if (declaration.isKind(ts_morph_1.ts.SyntaxKind.ArrowFunction)) {
+                        }
                         else if (declaration.isKind(ts_morph_1.ts.SyntaxKind.FunctionDeclaration) ||
                             declaration.isKind(ts_morph_1.ts.SyntaxKind.ClassDeclaration) ||
                             declaration.isKind(ts_morph_1.ts.SyntaxKind.TypeAliasDeclaration) ||
@@ -156,7 +158,7 @@ async function run(configuration) {
                             }
                             else {
                                 const refFiles = new Set(refs.map(r => r.compilerObject.references.map(r => r.fileName)).flat());
-                                const isReferencedOnlyBySelf = refFiles.size === 1 && [...refFiles][0] === sourceFile.getFilePath();
+                                const isReferencedOnlyBySelf = refFiles.size === 1 && [...refFiles][0] === filePath;
                                 if (!isReferencedOnlyBySelf)
                                     return;
                                 if ((0, ts_morph_helpers_1.findReferencingNamespaceNodes)(sourceFile).length > 0) {

package/dist/reporters/compact.js

@@ -39,7 +39,7 @@ exports.default = ({ issues, config, workingDir }) => {
     }
     if (report.dependencies && isDev) {
         const unreferencedDevDependencies = Array.from(issues.devDependencies);
-        logIssueGroupResult(unreferencedDevDependencies, workingDir, reportMultipleGroups && 'UNUSED DEV DEPENDENCIES');
+        logIssueGroupResult(unreferencedDevDependencies, workingDir, 'UNUSED DEV DEPENDENCIES');
     }
     if (report.unlisted) {
         const unreferencedDependencies = Object.values(issues.unresolved).map(issues => {

package/dist/reporters/symbols.js

@@ -41,7 +41,7 @@ exports.default = ({ issues, config, workingDir }) => {
     }
     if (report.dependencies && isDev) {
         const unreferencedDevDependencies = Array.from(issues.devDependencies);
-        logIssueGroupResult(unreferencedDevDependencies, workingDir, reportMultipleGroups && 'UNUSED DEV DEPENDENCIES');
+        logIssueGroupResult(unreferencedDevDependencies, workingDir, 'UNUSED DEV DEPENDENCIES');
     }
     if (report.unlisted) {
         const unresolvedDependencies = Object.values(issues.unresolved).map(Object.values).flat();

package/dist/types.d.ts

@@ -24,8 +24,12 @@ export 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 LocalConfiguration = {
-    dev?: boolean;
+export declare type BaseLocalConfiguration = {
+    entryFiles: string[];
+    projectFiles: string[];
+};
+export declare type LocalConfiguration = BaseLocalConfiguration & {
+    dev?: boolean | BaseLocalConfiguration;
     entryFiles: string[];
     projectFiles: string[];
     include?: string[];
@@ -40,6 +44,7 @@ export declare type Configuration = LocalConfiguration & {
     dependencies: string[];
     devDependencies: string[];
     isDev: boolean;
+    tsConfigFilePath: undefined | string;
     tsConfigPaths: string[];
     isShowProgress: boolean;
     jsDocOptions: {

package/dist/util/config.d.ts

@@ -1,5 +1,8 @@
 import type { ImportedConfiguration, LocalConfiguration } from '../types';
-export declare const resolveConfig: (importedConfiguration: ImportedConfiguration, cwdArg?: string) => LocalConfiguration | undefined;
+export declare const resolveConfig: (importedConfiguration: ImportedConfiguration, options?: {
+    workingDir?: string;
+    isDev?: boolean;
+}) => LocalConfiguration | undefined;
 export declare const resolveIncludedIssueGroups: (includeArg: string[], excludeArg: string[], resolvedConfig?: LocalConfiguration) => {
     files: boolean;
     dependencies: boolean;

package/dist/util/config.js

@@ -5,20 +5,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveIncludedIssueGroups = exports.resolveConfig = void 0;
 const micromatch_1 = __importDefault(require("micromatch"));
-const resolveConfig = (importedConfiguration, cwdArg) => {
+const resolveConfig = (importedConfiguration, options) => {
+    let resolvedConfig = importedConfiguration;
+    const { workingDir, isDev } = options ?? {};
     const configKeys = Object.keys(importedConfiguration);
-    if (cwdArg && !('projectFiles' in importedConfiguration)) {
-        const importedConfigKey = configKeys.find(pattern => micromatch_1.default.isMatch(cwdArg.replace(/\/$/, ''), pattern));
+    if (workingDir && !('projectFiles' in importedConfiguration)) {
+        const importedConfigKey = configKeys.find(pattern => micromatch_1.default.isMatch(workingDir.replace(/\/$/, ''), pattern));
         if (importedConfigKey) {
-            return importedConfiguration[importedConfigKey];
+            resolvedConfig = importedConfiguration[importedConfigKey];
         }
     }
-    if (!cwdArg && (!importedConfiguration.entryFiles || !importedConfiguration.projectFiles)) {
+    if (isDev && typeof resolvedConfig.dev === 'object' && 'projectFiles' in resolvedConfig.dev) {
+        resolvedConfig = resolvedConfig.dev;
+    }
+    if (!resolvedConfig.entryFiles || !resolvedConfig.projectFiles) {
         console.error('Unable to find `entryFiles` and/or `projectFiles` in configuration.');
-        console.info(`Add it at root level, or use --cwd and match one of: ${configKeys.join(', ')}\n`);
+        console.info(`Add these properties at root level, or use --cwd and match one of: ${configKeys.join(', ')}\n`);
         return;
     }
-    return importedConfiguration;
+    return resolvedConfig;
 };
 exports.resolveConfig = resolveConfig;
 const resolveIncludedIssueGroups = (includeArg, excludeArg, resolvedConfig) => {

package/dist/util/project.d.ts

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

package/dist/util/project.js

@@ -6,7 +6,6 @@ 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 path_1 = require("./path");
 const resolvePaths = (cwd, patterns) => {
     return [patterns].flat().map(pattern => {
         if (pattern.startsWith('!'))
@@ -14,15 +13,16 @@ const resolvePaths = (cwd, patterns) => {
         return node_path_1.default.join(cwd, pattern);
     });
 };
-const createProject = async (cwd, paths) => {
-    const tsConfigFilePath = await (0, path_1.findFile)(cwd, 'tsconfig.json');
+const createProject = async (configuration, paths) => {
+    const { tsConfigFilePath, workingDir } = configuration;
+    const tsConfig = tsConfigFilePath ? { tsConfigFilePath } : { compilerOptions: { allowJs: true } };
     const workspace = new ts_morph_1.Project({
-        tsConfigFilePath,
+        ...tsConfig,
         skipAddingFilesFromTsConfig: true,
         skipFileDependencyResolution: true,
     });
     if (paths)
-        workspace.addSourceFilesAtPaths(resolvePaths(cwd, paths));
+        workspace.addSourceFilesAtPaths(resolvePaths(workingDir, paths));
     return workspace;
 };
 exports.createProject = createProject;

package/package.json

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