knip 6.8.0 → 6.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -35,6 +35,7 @@ export declare class DependencyDeputy {
35
35
  optionalPeerDependencies: DependencySet;
36
36
  requiredPeerDependencies: DependencyArray;
37
37
  allDependencies: DependencySet;
38
+ engines: Record<string, string>;
38
39
  ignoreDependencies: (string | RegExp)[];
39
40
  ignoreBinaries: (string | RegExp)[];
40
41
  ignoreUnresolved: (string | RegExp)[];
@@ -57,7 +58,7 @@ export declare class DependencyDeputy {
57
58
  isPeerOptional: boolean;
58
59
  }[];
59
60
  getOptionalPeerDependencies(workspaceName: string): DependencySet;
60
- maybeAddReferencedExternalDependency(workspace: Workspace, packageName: string, isDevOnly?: boolean): boolean;
61
+ maybeAddReferencedExternalDependency(workspace: Workspace, packageName: string, isDevOnly?: boolean, isTypeOnly?: boolean): boolean;
61
62
  maybeAddReferencedBinary(workspace: Workspace, binaryName: string): Set<string> | undefined;
62
63
  private isInDependencies;
63
64
  settleDependencyIssues(): {
@@ -73,6 +73,7 @@ export class DependencyDeputy {
73
73
  optionalPeerDependencies,
74
74
  requiredPeerDependencies,
75
75
  allDependencies: new Set(allDependencies),
76
+ engines: manifest.engines ?? {},
76
77
  });
77
78
  }
78
79
  getWorkspaceManifest(workspaceName) {
@@ -128,7 +129,7 @@ export class DependencyDeputy {
128
129
  getOptionalPeerDependencies(workspaceName) {
129
130
  return this._manifests.get(workspaceName)?.optionalPeerDependencies ?? new Set();
130
131
  }
131
- maybeAddReferencedExternalDependency(workspace, packageName, isDevOnly) {
132
+ maybeAddReferencedExternalDependency(workspace, packageName, isDevOnly, isTypeOnly) {
132
133
  if (!this.isReportDependencies)
133
134
  return true;
134
135
  if (isBuiltin(packageName))
@@ -141,13 +142,16 @@ export class DependencyDeputy {
141
142
  const closestWorkspaceName = workspaceNames.find(name => this.isInDependencies(name, packageName, isDevOnly));
142
143
  const typesPackageName = !isDefinitelyTyped(packageName) && getDefinitelyTypedFor(packageName);
143
144
  const closestWorkspaceNameForTypes = typesPackageName && workspaceNames.find(name => this.isInDependencies(name, typesPackageName, isDevOnly));
144
- if (closestWorkspaceName || closestWorkspaceNameForTypes) {
145
- if (closestWorkspaceName)
146
- this.addReferencedDependency(closestWorkspaceName, packageName);
147
- if (closestWorkspaceNameForTypes && !this.hasTypesIncluded.get(closestWorkspaceNameForTypes)?.has(packageName))
148
- this.addReferencedDependency(closestWorkspaceNameForTypes, typesPackageName);
145
+ if (closestWorkspaceNameForTypes && !this.hasTypesIncluded.get(closestWorkspaceNameForTypes)?.has(packageName))
146
+ this.addReferencedDependency(closestWorkspaceNameForTypes, typesPackageName);
147
+ if (closestWorkspaceName) {
148
+ this.addReferencedDependency(closestWorkspaceName, packageName);
149
149
  return true;
150
150
  }
151
+ if (closestWorkspaceNameForTypes && isTypeOnly)
152
+ return true;
153
+ if (this._manifests.get(workspace.name)?.engines[packageName])
154
+ return true;
151
155
  this.addReferencedDependency(workspace.name, packageName);
152
156
  return false;
153
157
  }
@@ -171,7 +171,7 @@ export const analyze = async ({ analyzedFiles, counselor, chief, collector, depu
171
171
  if (file.imports?.external) {
172
172
  for (const extImport of file.imports.external) {
173
173
  const packageName = getPackageNameFromModuleSpecifier(extImport.specifier);
174
- const isHandled = packageName && deputy.maybeAddReferencedExternalDependency(ws, packageName);
174
+ const isHandled = packageName && deputy.maybeAddReferencedExternalDependency(ws, packageName, undefined, extImport.isTypeOnly);
175
175
  if (!isHandled)
176
176
  collector.addIssue({
177
177
  type: 'unlisted',
@@ -1,17 +1,48 @@
1
- import { join } from '../util/path.js';
1
+ import { existsSync, readFileSync } from 'node:fs';
2
+ import { dirname, join } from '../util/path.js';
2
3
  import { _require } from '../util/require.js';
4
+ const monorepoRootCache = new Map();
5
+ const findMonorepoRootAbove = (startDir) => {
6
+ if (monorepoRootCache.has(startDir))
7
+ return monorepoRootCache.get(startDir);
8
+ let current = dirname(startDir);
9
+ let result;
10
+ while (current !== dirname(current)) {
11
+ if (existsSync(join(current, 'pnpm-workspace.yaml'))) {
12
+ result = current;
13
+ break;
14
+ }
15
+ try {
16
+ const pkg = JSON.parse(readFileSync(join(current, 'package.json'), 'utf8'));
17
+ if (pkg.workspaces) {
18
+ result = current;
19
+ break;
20
+ }
21
+ }
22
+ catch { }
23
+ current = dirname(current);
24
+ }
25
+ monorepoRootCache.set(startDir, result);
26
+ return result;
27
+ };
3
28
  export const loadPackageManifest = ({ dir, packageName, cwd }) => {
4
29
  try {
5
30
  return _require(join(dir, 'node_modules', packageName, 'package.json'));
6
31
  }
7
- catch (_error) {
8
- if (dir !== cwd) {
9
- try {
10
- return _require(join(cwd, 'node_modules', packageName, 'package.json'));
11
- }
12
- catch (_error) {
13
- }
32
+ catch { }
33
+ if (dir !== cwd) {
34
+ try {
35
+ return _require(join(cwd, 'node_modules', packageName, 'package.json'));
36
+ }
37
+ catch { }
38
+ return;
39
+ }
40
+ const root = findMonorepoRootAbove(cwd);
41
+ if (root) {
42
+ try {
43
+ return _require(join(root, 'node_modules', packageName, 'package.json'));
14
44
  }
45
+ catch { }
15
46
  }
16
47
  };
17
48
  export const getFilteredScripts = (scripts) => {
@@ -32,7 +32,8 @@ const resolveConfig = async (localConfig, options) => {
32
32
  return compact([
33
33
  ...extend,
34
34
  ...references,
35
- ...[...types, ...plugins, ...importHelpers].map(id => toDeferResolve(id)),
35
+ ...types.map(id => toDeferResolve(id, { isTypeOnly: true })),
36
+ ...[...plugins, ...importHelpers].map(id => toDeferResolve(id)),
36
37
  ...jsx,
37
38
  ...aliases,
38
39
  ]);
@@ -1,3 +1,34 @@
1
1
  import type { ReporterOptions } from '../types/issues.ts';
2
+ export interface JSONReportNamedItem {
3
+ name: string;
4
+ }
5
+ export interface JSONReportItem extends JSONReportNamedItem {
6
+ namespace?: string;
7
+ pos?: number;
8
+ line?: number;
9
+ col?: number;
10
+ }
11
+ export type JSONReportEntry = {
12
+ file: string;
13
+ owners?: Array<JSONReportNamedItem>;
14
+ binaries?: Array<JSONReportNamedItem>;
15
+ catalog?: Array<JSONReportItem>;
16
+ dependencies?: Array<JSONReportItem>;
17
+ devDependencies?: Array<JSONReportItem>;
18
+ duplicates?: Array<Array<JSONReportItem>>;
19
+ enumMembers?: Array<JSONReportItem>;
20
+ exports?: Array<JSONReportItem>;
21
+ files?: Array<JSONReportItem>;
22
+ namespaceMembers?: Array<JSONReportItem>;
23
+ nsExports?: Array<JSONReportItem>;
24
+ nsTypes?: Array<JSONReportItem>;
25
+ optionalPeerDependencies?: Array<JSONReportItem>;
26
+ types?: Array<JSONReportItem>;
27
+ unlisted?: Array<JSONReportNamedItem>;
28
+ unresolved?: Array<JSONReportItem>;
29
+ };
30
+ export type JSONReport = {
31
+ issues: Array<JSONReportEntry>;
32
+ };
2
33
  declare const _default: ({ report, issues, options, cwd }: ReporterOptions) => Promise<void>;
3
34
  export default _default;
@@ -53,9 +53,8 @@ export default async ({ report, issues, options, cwd }) => {
53
53
  }
54
54
  }
55
55
  }
56
- const output = JSON.stringify({
57
- issues: Object.values(json),
58
- });
56
+ const jsonReport = { issues: Object.values(json) };
57
+ const output = JSON.stringify(jsonReport);
59
58
  process.stdout._handle?.setBlocking?.(true);
60
59
  process.stdout.write(`${output}\n`);
61
60
  };
@@ -53,6 +53,7 @@ export type PackageJson = {
53
53
  catalog?: Catalog;
54
54
  catalogs?: Catalogs;
55
55
  packageManager?: string;
56
+ engines?: Record<string, string>;
56
57
  pnpm?: {
57
58
  overrides?: Dependencies;
58
59
  };
@@ -10,6 +10,7 @@ type WorkspaceManifest = {
10
10
  optionalPeerDependencies: DependencySet;
11
11
  requiredPeerDependencies: DependencyArray;
12
12
  allDependencies: DependencySet;
13
+ engines: Record<string, string>;
13
14
  ignoreDependencies: (string | RegExp)[];
14
15
  ignoreBinaries: (string | RegExp)[];
15
16
  ignoreUnresolved: (string | RegExp)[];
package/dist/types.d.ts CHANGED
@@ -1,2 +1,3 @@
1
1
  export type { RawConfigurationOrFn as KnipConfig, RawConfiguration as KnipConfiguration, WorkspaceProjectConfig, } from './types/config.ts';
2
2
  export type { Preprocessor, Reporter, ReporterOptions } from './types/issues.ts';
3
+ export type { JSONReport, JSONReportEntry, JSONReportItem, JSONReportNamedItem } from './reporters/json.ts';
@@ -11,6 +11,7 @@ import { buildJSDocTagLookup } from './visitors/jsdoc.js';
11
11
  import { walkAST } from './visitors/walk.js';
12
12
  const getImportsAndExports = (filePath, sourceText, resolveModule, options, ignoreExportsUsedInFile, skipExportsForFile, visitor, pluginCtx, cachedParseResult) => {
13
13
  const skipExports = skipExportsForFile || !options.isReportExports;
14
+ const isDts = filePath.endsWith('.d.ts') || filePath.endsWith('.d.cts') || filePath.endsWith('.d.mts');
14
15
  const internal = new Map();
15
16
  const external = new Set();
16
17
  const unresolved = new Set();
@@ -53,7 +54,7 @@ const getImportsAndExports = (filePath, sourceText, resolveModule, options, igno
53
54
  pos: opts.pos,
54
55
  line: opts.line,
55
56
  col: opts.col,
56
- isTypeOnly: !!(modifiers & IMPORT_FLAGS.TYPE_ONLY),
57
+ isTypeOnly: isDts || !!(modifiers & IMPORT_FLAGS.TYPE_ONLY),
57
58
  });
58
59
  const file = internal.get(importFilePath);
59
60
  const importMaps = file ?? createImports();
@@ -129,7 +130,7 @@ const getImportsAndExports = (filePath, sourceText, resolveModule, options, igno
129
130
  pos: ePos,
130
131
  line,
131
132
  col,
132
- isTypeOnly: !!(modifiers & IMPORT_FLAGS.TYPE_ONLY),
133
+ isTypeOnly: isDts || !!(modifiers & IMPORT_FLAGS.TYPE_ONLY),
133
134
  });
134
135
  }
135
136
  }
@@ -153,7 +154,7 @@ const getImportsAndExports = (filePath, sourceText, resolveModule, options, igno
153
154
  pos: uPos,
154
155
  line,
155
156
  col,
156
- isTypeOnly: !!(modifiers & IMPORT_FLAGS.TYPE_ONLY),
157
+ isTypeOnly: isDts || !!(modifiers & IMPORT_FLAGS.TYPE_ONLY),
157
158
  });
158
159
  }
159
160
  }
@@ -53,7 +53,7 @@ export const createInputHandler = (deputy, chief, isGitIgnored, addIssue, extern
53
53
  const isWorkspace = chief.workspacesByPkgName.has(packageName);
54
54
  const inputWorkspace = getWorkspaceFor(input, chief, workspace);
55
55
  if (inputWorkspace) {
56
- const isHandled = deputy.maybeAddReferencedExternalDependency(inputWorkspace, packageName, isConfig(input));
56
+ const isHandled = deputy.maybeAddReferencedExternalDependency(inputWorkspace, packageName, isConfig(input), input.isTypeOnly);
57
57
  if (externalRefs && !isWorkspace) {
58
58
  addExternalRef(externalRefs, containingFilePath, { specifier: packageName, identifier: undefined });
59
59
  }
@@ -6,6 +6,7 @@ export interface Input {
6
6
  specifier: string;
7
7
  production?: boolean;
8
8
  optional?: boolean;
9
+ isTypeOnly?: boolean;
9
10
  dir?: string;
10
11
  containingFilePath?: string;
11
12
  allowIncludeExports?: boolean;
@@ -27,6 +28,7 @@ interface IgnoreInput extends Input {
27
28
  }
28
29
  type Options = {
29
30
  optional?: boolean;
31
+ isTypeOnly?: boolean;
30
32
  dir?: string;
31
33
  containingFilePath?: string;
32
34
  allowIncludeExports?: boolean;
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const version = "6.8.0";
1
+ export declare const version = "6.10.0";
package/dist/version.js CHANGED
@@ -1 +1 @@
1
- export const version = '6.8.0';
1
+ export const version = '6.10.0';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "knip",
3
- "version": "6.8.0",
3
+ "version": "6.10.0",
4
4
  "description": "Find and fix unused dependencies, exports and files in your TypeScript and JavaScript projects",
5
5
  "keywords": [
6
6
  "analysis",