Refactor module resolution for non-std files + group related tests (f…

…ixes #376)

packages/knip/fixtures/module-resolution-baseurl-implicit-relative/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "@fixtures/module-resolution-baseurl-implicit-relative"
+}

packages/knip/fixtures/module-resolution-baseurl-implicit-relative/src/dir/main.ts

@@ -0,0 +1 @@
+import Image from 'assets/image.svg';

packages/knip/fixtures/tsconfig-paths-implicit/src/index.ts → packages/knip/fixtures/module-resolution-baseurl-implicit-relative/src/index.ts

@@ -1,3 +1,4 @@
+import 'dir/main';
 import { helloWorld } from 'hello/world';
 
 helloWorld;

packages/knip/fixtures/module-resolution-non-std-implicit/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "@fixtures/module-resolution-non-std-implicit"
+}

packages/knip/fixtures/module-resolution-non-std-implicit/src/dir/main.ts

@@ -0,0 +1,2 @@
+import ImageSVG from '../assets/image.svg';
+import ImagePNG from '../assets/image.png';

packages/knip/fixtures/module-resolution-non-std-implicit/src/index.ts

@@ -0,0 +1,11 @@
+import 'dir/main.ts';
+
+import SomeSVG from './common/image.svg';
+
+import Icon from './icon.svg';
+
+import './global.css';
+
+// By exception, .css files will be resolved because `.css` is not added to virtual path extensions, since `.css.ts`
+// files on disk are common (in contrast to e.g. `.svg.ts`; binaries like `.png.ts` can be safely ignored).
+import 'styles/base.css';

packages/knip/fixtures/unresolved/package.json → packages/knip/fixtures/module-resolution-non-std/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@fixtures/unresolved",
+  "name": "@fixtures/module-resolution-non-std",
   "dependencies": {
     "@svg-icons/fa-brands": "*",
     "@svg-icons/heroicons-outline": "*"

packages/knip/fixtures/unresolved/src/index.ts → packages/knip/fixtures/module-resolution-non-std/src/index.ts

@@ -13,6 +13,7 @@ import Github from '@svg-icons/fa-brands/github.svg';
 import Briefcase from '@svg-icons/heroicons-outline/briefcase.svg';
 
 import SomeSVG from 'common/image.svg';
+import SomePNG from 'common/image.png';
 
 import './globals.css';
 import 'styles/base.css';

packages/knip/fixtures/module-resolution-tsconfig-paths/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@fixtures/module-resolution-tsconfig-paths",
+  "dependencies": {
+    "internal": "*"
+  }
+}

packages/knip/fixtures/subpath-import-from-plugin/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@fixture/subpath-import-from-plugin",
+  "name": "@fixtures/subpath-import-from-plugin",
   "imports": {
     "#dep": {
       "node": "dep-node-native",

packages/knip/src/ConfigurationChief.ts

@@ -3,7 +3,12 @@ import mapWorkspaces from '@npmcli/map-workspaces';
 import { createPkgGraph } from '@pnpm/workspace.pkgs-graph';
 import micromatch from 'micromatch';
 import { ConfigurationValidator } from './ConfigurationValidator.js';
-import { ROOT_WORKSPACE_NAME, DEFAULT_EXTENSIONS, KNIP_CONFIG_LOCATIONS } from './constants.js';
+import {
+  ROOT_WORKSPACE_NAME,
+  DEFAULT_EXTENSIONS,
+  KNIP_CONFIG_LOCATIONS,
+  DUMMY_VIRTUAL_FILE_EXTENSIONS,
+} from './constants.js';
 import { defaultRules } from './issues/initializers.js';
 import * as plugins from './plugins/index.js';
 import { arrayify } from './util/array.js';
@@ -180,7 +185,9 @@ export class ConfigurationChief {
   }
 
   public getCompilers(): [SyncCompilers, AsyncCompilers] {
-    return [this.config.syncCompilers, this.config.asyncCompilers];
+    const syncCompilers = this.config.syncCompilers;
+    DUMMY_VIRTUAL_FILE_EXTENSIONS.forEach(ext => !syncCompilers.has(ext) && syncCompilers.set(ext, () => ''));
+    return [syncCompilers, this.config.asyncCompilers];
   }
 
   public getRules() {

packages/knip/src/ProjectPrincipal.ts

@@ -80,7 +80,7 @@ export class ProjectPrincipal {
       ...compilerOptions,
       ...baseCompilerOptions,
       types: compact([...(compilerOptions.types ?? []), ...baseCompilerOptions.types]),
-      allowNonTsExtensions: [...compilers].flat().length > 0,
+      allowNonTsExtensions: true,
     };
 
     const [syncCompilers, asyncCompilers] = compilers;
@@ -220,7 +220,7 @@ export class ProjectPrincipal {
           const isIgnored = this.isGitIgnored(join(dirname(filePath), sanitizedSpecifier));
           if (!isIgnored) {
             const ext = extname(sanitizedSpecifier);
-            const hasIgnoredExtension = IGNORED_FILE_EXTENSIONS.includes(ext);
+            const hasIgnoredExtension = IGNORED_FILE_EXTENSIONS.has(ext);
             if (!ext || (ext !== '.json' && !hasIgnoredExtension)) {
               unresolvedImports.add(unresolvedImport);
             }

packages/knip/src/binaries/index.ts

@@ -20,7 +20,7 @@ const getDependenciesFromScripts: GetDependenciesFromScripts = (npmScripts, opti
       if (isBinary(identifier)) return identifier;
       if (isInternal(identifier)) {
         const ext = extname(identifier);
-        if (ext && IGNORED_FILE_EXTENSIONS.includes(ext)) return;
+        if (ext && IGNORED_FILE_EXTENSIONS.has(ext)) return;
         return identifier;
       }
       return getPackageNameFromModuleSpecifier(identifier);

packages/knip/src/constants.ts

@@ -46,28 +46,26 @@ export const IGNORED_GLOBAL_BINARIES = [
 
 export const IGNORED_DEPENDENCIES = ['knip', 'typescript'];
 
-export const IGNORED_FILE_EXTENSIONS = [
+// Extensions sometimes imported directly (and compiled away by bundlers, etc.)
+export const DUMMY_VIRTUAL_FILE_EXTENSIONS = new Set(['.html', '.jpeg', '.jpg', '.png', '.svg', '.webp']);
+
+export const IGNORED_FILE_EXTENSIONS = new Set([
   '.avif',
   '.css',
   '.eot',
   '.gif',
-  '.html',
   '.ico',
-  '.jpeg',
-  '.jpg',
   '.less',
-  '.png',
   '.sass',
   '.scss',
   '.sh',
-  '.svg',
   '.ttf',
-  '.webp',
   '.woff',
   '.woff2',
   '.yaml',
   '.yml',
-];
+  ...DUMMY_VIRTUAL_FILE_EXTENSIONS,
+]);
 
 // The `@types/node` dependency does not require the `node` dependency
 export const IGNORE_DEFINITELY_TYPED = ['node'];

packages/knip/test/cli-reporter-json2.test.ts

@@ -4,7 +4,7 @@ import { resolve } from '../src/util/path.js';
 import { execFactory } from './helpers/exec.js';
 import { updatePos } from './helpers/index.js';
 
-const cwd = resolve('fixtures/unresolved');
+const cwd = resolve('fixtures/module-resolution-non-std');
 
 const exec = execFactory(cwd);
 

packages/knip/test/module-resolution-baseurl-implicit-relative.test.ts

@@ -0,0 +1,21 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+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/module-resolution-baseurl-implicit-relative');
+
+test('Resolve implicit relative module specifiers from baseUrl', async () => {
+  const { counters } = await main({
+    ...baseArguments,
+    cwd,
+  });
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    processed: 3,
+    total: 3,
+  });
+});

packages/knip/test/tsconfig-paths-implicit.test.ts → packages/knip/test/module-resolution-non-std-implicit.test.ts

@@ -5,9 +5,9 @@ import { resolve } from '../src/util/path.js';
 import baseArguments from './helpers/baseArguments.js';
 import baseCounters from './helpers/baseCounters.js';
 
-test('Resolve modules properly using tsconfig paths with baseUrl', async () => {
-  const cwd = resolve('fixtures/tsconfig-paths-implicit');
+const cwd = resolve('fixtures/module-resolution-non-std-implicit');
 
+test('Resolve non-standard relative specifiers (no tsconfig.json)', async () => {
   const { counters } = await main({
     ...baseArguments,
     cwd,

packages/knip/test/unresolved.test.ts → packages/knip/test/module-resolution-non-std.test.ts

@@ -5,9 +5,9 @@ import { resolve } from '../src/util/path.js';
 import baseArguments from './helpers/baseArguments.js';
 import baseCounters from './helpers/baseCounters.js';
 
-const cwd = resolve('fixtures/unresolved');
+const cwd = resolve('fixtures/module-resolution-non-std');
 
-test('Report unresolved imports', async () => {
+test('Resolve non-standard extensions and report unresolved imports', async () => {
   const { issues, counters } = await main({
     ...baseArguments,
     cwd,

packages/knip/test/tsconfig-paths.test.ts → packages/knip/test/module-resolution-tsconfig-paths.test.ts

@@ -5,9 +5,9 @@ import { resolve } from '../src/util/path.js';
 import baseArguments from './helpers/baseArguments.js';
 import baseCounters from './helpers/baseCounters.js';
 
-test('Resolve modules properly using tsconfig paths and globs', async () => {
-  const cwd = resolve('fixtures/tsconfig-paths');
+const cwd = resolve('fixtures/module-resolution-tsconfig-paths');
 
+test('Resolve modules properly using tsconfig paths and globs', async () => {
   const { issues, counters } = await main({
     ...baseArguments,
     cwd,