knip 1.1.0 → 1.2.0

package/README.md

@@ -87,7 +87,7 @@ Use `npm run knip` to analyze the project and output unused files, dependencies
     knip [options]
 
     Options:
-      -c/--config [file]       Configuration file path (default: knip.json, knip.jsonc or package.json#knip)
+      -c/--config [file]       Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)
       -t/--tsConfig [file]     TypeScript configuration path (default: tsconfig.json)
       --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)
       --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)

package/dist/configuration-chief.js

@@ -2,21 +2,18 @@ import path from 'node:path';
 import mapWorkspaces from '@npmcli/map-workspaces';
 import micromatch from 'micromatch';
 import { ConfigurationValidator } from './configuration-validator.js';
-import { ROOT_WORKSPACE_NAME } from './constants.js';
+import { ROOT_WORKSPACE_NAME, DEFAULT_WORKSPACE_CONFIG, KNIP_CONFIG_LOCATIONS } from './constants.js';
 import * as plugins from './plugins/index.js';
 import { arrayify } from './util/array.js';
 import parsedArgs from './util/cli-arguments.js';
 import { ConfigurationError } from './util/errors.js';
 import { findFile, loadJSON } from './util/fs.js';
 import { ensurePosixPath } from './util/glob.js';
+import { _load } from './util/loader.js';
 import { resolveIncludedIssueTypes } from './util/resolve-included-issue-types.js';
 import { byPathDepth } from './util/workspace.js';
 const { values: { config: rawConfigArg, workspace: rawWorkspaceArg, include = [], exclude = [], dependencies = false, exports = false, }, } = parsedArgs;
-const defaultWorkspaceConfig = {
-    entry: ['index.{js,ts,tsx}!', 'src/index.{js,ts,tsx}!'],
-    project: ['**/*.{js,ts,tsx}!'],
-    ignore: [],
-};
+const defaultWorkspaceConfig = DEFAULT_WORKSPACE_CONFIG;
 const defaultConfig = {
     include: [],
     exclude: [],
@@ -49,12 +46,16 @@ export default class ConfigurationChief {
         }
         this.manifestPath = manifestPath;
         this.manifest = manifest;
-        const configFilePath = rawConfigArg ?? 'knip.json';
-        const resolvedConfigFilePath = (await findFile(this.cwd, configFilePath)) ?? (!rawConfigArg && (await findFile(this.cwd, configFilePath + 'c')));
+        let resolvedConfigFilePath;
+        for (const configPath of rawConfigArg ? [rawConfigArg] : KNIP_CONFIG_LOCATIONS) {
+            resolvedConfigFilePath = await findFile(this.cwd, configPath);
+            if (resolvedConfigFilePath)
+                break;
+        }
         if (rawConfigArg && !resolvedConfigFilePath && !manifest.knip) {
             throw new ConfigurationError(`Unable to find ${rawConfigArg} or package.json#knip`);
         }
-        const rawLocalConfig = resolvedConfigFilePath ? await loadJSON(resolvedConfigFilePath) : manifest.knip;
+        const rawLocalConfig = resolvedConfigFilePath ? await _load(resolvedConfigFilePath) : manifest.knip;
         if (rawLocalConfig) {
             this.config = this.normalize(ConfigurationValidator.parse(rawLocalConfig));
         }

package/dist/constants.d.ts

@@ -1,5 +1,11 @@
 import type { IssueType } from './types/issues.js';
 export declare const ROOT_WORKSPACE_NAME = ".";
+export declare const KNIP_CONFIG_LOCATIONS: string[];
+export declare const DEFAULT_WORKSPACE_CONFIG: {
+    entry: string[];
+    project: string[];
+    ignore: never[];
+};
 export declare const TEST_FILE_PATTERNS: string[];
 export declare const IGNORED_GLOBAL_BINARIES: string[];
 export declare const IGNORE_DEFINITELY_TYPED: string[];

package/dist/constants.js

@@ -1,4 +1,10 @@
 export const ROOT_WORKSPACE_NAME = '.';
+export const KNIP_CONFIG_LOCATIONS = ['knip.json', 'knip.jsonc', '.knip.json', '.knip.jsonc', 'knip.ts', 'knip.js'];
+export const DEFAULT_WORKSPACE_CONFIG = {
+    entry: ['index.{js,ts,tsx}!', 'src/index.{js,ts,tsx}!'],
+    project: ['**/*.{js,ts,tsx}!'],
+    ignore: [],
+};
 export const TEST_FILE_PATTERNS = ['**/*.{test,spec}.{js,jsx,ts,tsx}', '**/__tests__/**/*.{js,jsx,ts,tsx}'];
 export const IGNORED_GLOBAL_BINARIES = ['npm', 'npx', 'node', 'yarn', 'pnpm', 'deno', 'git'];
 export const IGNORE_DEFINITELY_TYPED = ['node'];

package/dist/util/cli-arguments.d.ts

@@ -1,4 +1,4 @@
-export declare const helpText = "knip [options]\n\nOptions:\n  -c/--config [file]       Configuration file path (default: knip.json, knip.jsonc or package.json#knip)\n  -t/--tsConfig [file]     TypeScript configuration path (default: tsconfig.json)\n  --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)\n  --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)\n  --workspace              Analyze a single workspace (default: analyze all configured workspaces)\n  --include-entry-exports  Include unused exports in entry files (without `@public`)\n  --ignore                 Ignore files matching this glob pattern, can be repeated\n  --no-gitignore           Don't use .gitignore\n  --include                Report only provided issue type(s), can be comma-separated or repeated (1)\n  --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)\n  --dependencies           Shortcut for --include dependencies,unlisted\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\n  --no-progress            Don't show dynamic progress updates\n  --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)\n  --reporter-options       Pass extra options to the reporter (as JSON string, see example)\n  --no-exit-code           Always exit with code zero (0)\n  --max-issues             Maximum number of issues before non-zero exit code (default: 0)\n  --debug                  Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure running time of expensive functions and display stats table\n\n(1) Issue types: files, dependencies, unlisted, exports, nsExports, classMembers, types, nsTypes, enumMembers, duplicates\n\nExamples:\n\n$ knip\n$ knip --production\n$ knip --workspace packages/client --include files,dependencies\n$ knip -c ./config/knip.json --reporter compact\n$ knip --reporter codeowners --reporter-options '{\"path\":\".github/CODEOWNERS\"}'\n$ knip --debug --debug-file-filter '(specific|particular)-module'\n\nMore info: https://github.com/webpro/knip";
+export declare const helpText = "knip [options]\n\nOptions:\n  -c/--config [file]       Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)\n  -t/--tsConfig [file]     TypeScript configuration path (default: tsconfig.json)\n  --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)\n  --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)\n  --workspace              Analyze a single workspace (default: analyze all configured workspaces)\n  --include-entry-exports  Include unused exports in entry files (without `@public`)\n  --ignore                 Ignore files matching this glob pattern, can be repeated\n  --no-gitignore           Don't use .gitignore\n  --include                Report only provided issue type(s), can be comma-separated or repeated (1)\n  --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)\n  --dependencies           Shortcut for --include dependencies,unlisted\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\n  --no-progress            Don't show dynamic progress updates\n  --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)\n  --reporter-options       Pass extra options to the reporter (as JSON string, see example)\n  --no-exit-code           Always exit with code zero (0)\n  --max-issues             Maximum number of issues before non-zero exit code (default: 0)\n  --debug                  Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure running time of expensive functions and display stats table\n\n(1) Issue types: files, dependencies, unlisted, exports, nsExports, classMembers, types, nsTypes, enumMembers, duplicates\n\nExamples:\n\n$ knip\n$ knip --production\n$ knip --workspace packages/client --include files,dependencies\n$ knip -c ./config/knip.json --reporter compact\n$ knip --reporter codeowners --reporter-options '{\"path\":\".github/CODEOWNERS\"}'\n$ knip --debug --debug-file-filter '(specific|particular)-module'\n\nMore info: https://github.com/webpro/knip";
 declare const _default: {
     values: {
         config: string | undefined;

package/dist/util/cli-arguments.js

@@ -2,7 +2,7 @@ import { parseArgs } from 'node:util';
 export const helpText = `knip [options]
 
 Options:
-  -c/--config [file]       Configuration file path (default: knip.json, knip.jsonc or package.json#knip)
+  -c/--config [file]       Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)
   -t/--tsConfig [file]     TypeScript configuration path (default: tsconfig.json)
   --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)
   --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)

package/dist/util/loader.js

@@ -8,7 +8,7 @@ import { logIfDebug } from './log.js';
 import { timerify } from './performance.js';
 const load = async (filePath) => {
     try {
-        if (path.extname(filePath) === '.json' || /rc$/.test(filePath)) {
+        if (/\.jsonc?$/.test(filePath) || /rc$/.test(filePath)) {
             return loadJSON(filePath);
         }
         if (path.extname(filePath) === '.yaml' || path.extname(filePath) === '.yml') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",