Skip to content

Commit

Permalink
Fix unused @types DT dependencies (resolve #942)
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Feb 12, 2025
1 parent 41a2bcc commit fc95526
Show file tree
Hide file tree
Showing 10 changed files with 104 additions and 4 deletions.
5 changes: 5 additions & 0 deletions packages/knip/fixtures/dependencies-types/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { meta } from '@eslint/js';
import { Ajv } from 'ajv';

console.log(meta);
console.log(Ajv);

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions packages/knip/fixtures/dependencies-types/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"name": "@fixtures/dependencies-types",
"dependencies": {
"@eslint/js": "^9.20.0",
"ajv": "^8.17.1"
},
"devDependencies": {
"@types/ajv": "^0.0.5",
"@types/eslint__js": "^8.42.3",
"@types/node": "^20.14.8"
}
}
9 changes: 5 additions & 4 deletions packages/knip/src/DependencyDeputy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ export class DependencyDeputy {
}

getHasTypesIncluded(workspaceName: string) {
return this.installedBinaries.get(workspaceName);
return this.hasTypesIncluded.get(workspaceName);
}

addReferencedDependency(workspaceName: string, packageName: string) {
Expand Down Expand Up @@ -214,7 +214,8 @@ export class DependencyDeputy {

if (closestWorkspaceName || closestWorkspaceNameForTypes) {
if (closestWorkspaceName) this.addReferencedDependency(closestWorkspaceName, packageName);
if (closestWorkspaceNameForTypes) this.addReferencedDependency(closestWorkspaceNameForTypes, typesPackageName);
if (closestWorkspaceNameForTypes && !this.hasTypesIncluded.get(closestWorkspaceNameForTypes)?.has(packageName))
this.addReferencedDependency(closestWorkspaceNameForTypes, typesPackageName);
return true;
}
this.addReferencedDependency(workspace.name, packageName);
Expand Down Expand Up @@ -277,7 +278,7 @@ export class DependencyDeputy {
if (IGNORE_DEFINITELY_TYPED.has(typedPackageName)) return true;

// The `pkg` dependency already has types included, i.e. this `@types/pkg` is obsolete
if (hasTypesIncluded?.has(typedDependency)) return false;
if (hasTypesIncluded?.has(typedPackageName)) return false;

// Ignore typed dependencies that have a host dependency that's referenced
// Example: `next` (host) has `react-dom` and/or `@types/react-dom` (peer), peers can be ignored if host `next` is referenced
Expand All @@ -287,7 +288,7 @@ export class DependencyDeputy {
];
if (hostDependencies.length) return !!hostDependencies.find(host => isReferencedDependency(host.name, true));

if (!referencedDependencies) return false;
if (!referencedDependencies?.has(dependency)) return false;

return referencedDependencies.has(typedPackageName);
}
Expand Down
1 change: 1 addition & 0 deletions packages/knip/test/definitely-typed.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ test('Find unused DT @types', async () => {
});

assert(issues.devDependencies['package.json']['@types/unused']);
assert(issues.devDependencies['package.json']['@types/mocha']);

assert.deepEqual(counters, {
...baseCounters,
Expand Down
25 changes: 25 additions & 0 deletions packages/knip/test/dependencies-types.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { test } from 'bun:test';
import assert from 'node:assert/strict';
import { main } from '../src/index.js';
import { resolve } from '../src/util/path.js';
import baseArguments from './helpers/baseArguments.js';
import baseCounters from './helpers/baseCounters.js';

const cwd = resolve('fixtures/dependencies-types');

test('Find unused @types dependencies', async () => {
const { issues, counters } = await main({
...baseArguments,
cwd,
});

assert(issues.devDependencies['package.json']['@types/ajv']);
assert(issues.devDependencies['package.json']['@types/eslint__js']);

assert.deepEqual(counters, {
...baseCounters,
devDependencies: 2,
processed: 1,
total: 1,
});
});

0 comments on commit fc95526

Please sign in to comment.