Merge resolveEntryPaths into resolveConfig

Author: webpro

packages/docs/src/content/docs/guides/writing-a-plugin.md

@@ -139,14 +139,14 @@ Compared to the first example, this plugin has two new variables:
 ### 5. `config`
 
 The `config` array contains all possible locations of the config file for the
-tool. Knip loads matching files and passes the results (i.e. what resolves as
-the default export) into the `resolveConfig` function:
+tool. Knip loads matching files and passes the results (i.e. its default export)
+into the `resolveConfig` function:
 
 ### 6. `resolveConfig`
 
-This function receives the exported value of the `config` files, and executes
-the `resolveConfig` function with this object. The plugin should return the
-dependencies referenced in this object.
+This function receives the exported value of the `config` file, and executes the
+`resolveConfig` function with this object. The plugin should return the entry
+paths and dependencies referenced in this object.
 
 Knip supports JSON, YAML, TOML, JavaScript and TypeScript config files. Files
 without an extension are provided as plain text strings.
@@ -155,49 +155,43 @@ without an extension are provided as plain text strings.
 
 You should implement `resolveConfig` if any of these are true:
 
-- The tool supports a `config` file in JSON or YAML format
+- The `config` file contains one or more options that represent [entry
+  points][2]
 - The `config` file references dependencies by strings (not import statements)
 
 :::
 
-## Example 3: custom entry paths
+## Example 3: entry paths
 
 Some tools operate mostly on entry files, some examples:
 
 - Mocha looks for test files at `test/*.{js,cjs,mjs}`
 - Storybook looks for stories at `*.stories.@(mdx|js|jsx|tsx)`
 
 And some of those tools allow to configure those locations and patterns. If
-that's the case, than we can define `resolveEntryPaths` in our plugin to take
-this from the configuration object and return it to Knip:
+that's the case we can define `resolveConfig` in our plugin to take this from
+the configuration object and return it to Knip:
 
-### 7. resolveEntryPaths
-
-Here's an example from the Preconstruct plugin:
+Here's an example from the Mocha plugin:
 
 ```ts
-const resolveEntryPaths: ResolveConfig<PreconstructConfig> = async config => {
-  return (config.entrypoints ?? []).map(id => toEntry(id));
+const entry = ['**/test/*.{js,cjs,mjs}'];
+
+const resolveConfig: ResolveConfig<MochaConfig> = localConfig => {
+  const entryPatterns = localConfig.spec ? [localConfig.spec].flat() : entry;
+  return entryPatterns.map(id => toEntry(id));
 };
 ```
 
-With Preconstruct, you can configure `entrypoints`. If this function is
-implemented in a plugin, Knip will use its return value over the default `entry`
-patterns. The result is that you don't need to duplicate this customization in
-both the tool (e.g. Preconstruct) and Knip.
-
-:::tip[Should I implement resolveEntryPaths?]
-
-Plugins should have `resolveEntryPaths` implemented if the configuration file
-contains one or more options that represent [entry points][2].
-
-:::
+With Mocha, you can configure `spec` file patterns. The result of implementing
+`resolveConfig` is that users don't need to duplicate this configuration in both
+the tool (e.g. Mocha) and Knip.
 
 ## Example 4: Use the AST directly
 
-For the `resolveEntryPaths` and `resolveFromConfig` functions, Knip loads the
-configuration file and passes the default-exported object to this plugin
-function. However, that object might then not contain the information we need.
+If the `resolveFromConfig` function is impemented, Knip loads the configuration
+file and passes the default-exported object to this plugin function. However,
+that object might then not contain the information we need.
 
 Here's an example `astro.config.ts` configuration file with a Starlight
 integration:
@@ -226,7 +220,7 @@ In the Astro plugin, there's no way to access this object containing
 `components` to add the component files as entry files if we were to try:
 
 ```ts
-const resolveEntryPaths: ResolveEntryPaths<AstroConfig> = async config => {
+const resolveConfig: ResolveConfig<AstroConfig> = async config => {
   console.log(config); //  ¯\_(ツ)_/¯
 };
 ```

packages/knip/fixtures/plugins/eslint/package.json

@@ -1,13 +1,11 @@
 {
   "name": "@fixtures/eslint",
   "devDependencies": {
-    "@eslint/js": "*",
     "eslint": "*",
     "@nrwl/eslint-plugin-nx": "*",
     "@typescript-eslint/eslint-plugin": "*",
     "@typescript-eslint/parser": "*",
     "eslint-config-prettier": "*",
-    "eslint-plugin-no-secrets": "*",
     "eslint-plugin-prettier": "*"
   }
 }

packages/knip/fixtures/plugins/eslint/eslint.config.js renamed to packages/knip/fixtures/plugins/eslint3/eslint.config.js

@@ -1,12 +1,13 @@
+import { defineConfig } from 'eslint/config';
 import prettier from 'eslint-plugin-prettier';
 import noSecrets from 'eslint-plugin-no-secrets';
 
-export default [
+export default defineConfig([
   'eslint:recommended',
   {
     plugins: {
       prettier,
       'no-secrets': noSecrets,
     },
   },
-];
+]);

packages/knip/fixtures/plugins/eslint3/index.ts

@@ -0,0 +1 @@
+export const x = 1;

packages/knip/fixtures/plugins/eslint3/node_modules/eslint/index.js

@@ -0,0 +1,8 @@
+{
+  "name": "@fixtures/eslint3",
+  "devDependencies": {
+    "eslint": "*",
+    "eslint-plugin-no-secrets": "*",
+    "eslint-plugin-prettier": "*"
+  }
+}

packages/knip/fixtures/plugins/eslint3/package.json

@@ -0,0 +1 @@
+export const x = 1;

packages/knip/fixtures/plugins/eslint/eslint.config.ts renamed to packages/knip/fixtures/plugins/eslint4/eslint.config.ts

@@ -0,0 +1,7 @@
+{
+  "name": "@fixtures/eslint4",
+  "devDependencies": {
+    "eslint": "*",
+    "@eslint/js": "*"
+  }
+}

packages/knip/fixtures/plugins/eslint4/index.ts

@@ -52,7 +52,7 @@ type WorkspaceManagerOptions = {
   configFilesMap: Map<string, Map<PluginName, Set<string>>>;
 };
 
-type CacheItem = { resolveEntryPaths?: Input[]; resolveConfig?: Input[]; resolveFromAST?: Input[] };
+type CacheItem = { resolveConfig?: Input[]; resolveFromAST?: Input[] };
 
 const nullConfig: EnsuredPluginConfiguration = { config: null, entry: null, project: null };
 
@@ -341,7 +341,7 @@ export class WorkspaceWorker {
         const toInput = isProduction && plugin.production && plugin.production.length > 0 ? toProductionEntry : toEntry;
         for (const id of config.entry) addInput(toInput(id));
       } else if (
-        (!plugin.resolveEntryPaths && !plugin.resolveFromAST) ||
+        (!plugin.resolveConfig && !plugin.resolveFromAST) ||
         (configFilePaths.filter(path => basename(path) !== 'package.json').length === 0 &&
           (!this.configFilesMap.get(wsName)?.get(pluginName) ||
             this.configFilesMap.get(wsName)?.get(pluginName)?.size === 0))
@@ -356,7 +356,6 @@ export class WorkspaceWorker {
 
         if (fd?.meta?.data && !fd.changed) {
           const data = fd.meta.data;
-          if (data.resolveEntryPaths) for (const id of data.resolveEntryPaths) addInput(id, configFilePath);
           if (data.resolveConfig) for (const id of data.resolveConfig) addInput(id, configFilePath);
           if (data.resolveFromAST) for (const id of data.resolveFromAST) addInput(id, configFilePath);
           continue;
@@ -371,21 +370,11 @@ export class WorkspaceWorker {
         };
 
         const cache: CacheItem = {};
-        let loadedConfig: unknown;
-
-        if (plugin.resolveEntryPaths && !seen.get(wsName)?.has(configFilePath)) {
-          if (!loadedConfig) loadedConfig = await loadConfigForPlugin(configFilePath, plugin, resolveOpts, pluginName);
-          if (loadedConfig) {
-            const inputs = await plugin.resolveEntryPaths(loadedConfig, resolveOpts);
-            for (const input of inputs) addInput(input, configFilePath);
-            cache.resolveEntryPaths = inputs;
-          }
-        }
 
         if (plugin.resolveConfig && !seen.get(wsName)?.has(configFilePath)) {
-          if (!loadedConfig) loadedConfig = await loadConfigForPlugin(configFilePath, plugin, resolveOpts, pluginName);
-          if (loadedConfig) {
-            const inputs = await plugin.resolveConfig(loadedConfig, resolveOpts);
+          const localConfig = await loadConfigForPlugin(configFilePath, plugin, resolveOpts, pluginName);
+          if (localConfig) {
+            const inputs = await plugin.resolveConfig(localConfig, resolveOpts);
             for (const input of inputs) addInput(input, configFilePath);
             cache.resolveConfig = inputs;
           }

packages/knip/fixtures/plugins/eslint4/package.json

@@ -9,7 +9,7 @@ const PMap: PluginMap = Plugins;
 
 const { performance: isEnabled = false } = parsedArgValues;
 
-const timerifyMethods = ['resolve', 'resolveConfig', 'resolveEntryPaths'] as const;
+const timerifyMethods = ['resolve', 'resolveConfig', 'resolveAST'] as const;
 
 const PluginEntries = Object.entries(PMap) as Entries;
 

packages/knip/src/WorkspaceWorker.ts

@@ -1,4 +1,4 @@
-import type { IsPluginEnabled, Plugin, ResolveConfig, ResolveEntryPaths } from '../../types/config.js';
+import type { IsPluginEnabled, Plugin, ResolveConfig } from '../../types/config.js';
 import { toEntry } from '../../util/input.js';
 import { hasDependency } from '../../util/plugin.js';
 import type { AvaConfig } from './types.js';
@@ -26,19 +26,15 @@ const entry = [
   '!**/test?(s)/**/{helper,fixture}?(s)/**/*',
 ];
 
-const resolveEntryPaths: ResolveEntryPaths<AvaConfig> = localConfig => {
-  if (typeof localConfig === 'function') localConfig = localConfig();
-  return (localConfig?.files ?? entry).map(id => toEntry(id));
-};
-
 const resolveConfig: ResolveConfig<AvaConfig> = async (localConfig, options) => {
   if (typeof localConfig === 'function') localConfig = localConfig();
 
+  const files = (localConfig?.files ?? entry).map(id => toEntry(id));
   const nodeArgs = localConfig.nodeArguments ?? [];
   const requireArgs = (localConfig.require ?? []).map(require => `--require ${require}`);
   const fakeCommand = `node ${nodeArgs.join(' ')} ${requireArgs.join(' ')}`;
 
-  return options.getInputsFromScripts(fakeCommand, { knownBinsOnly: true });
+  return files.concat(options.getInputsFromScripts(fakeCommand, { knownBinsOnly: true }));
 };
 
 export default {
@@ -47,6 +43,5 @@ export default {
   isEnabled,
   config,
   entry,
-  resolveEntryPaths,
   resolveConfig,
 } satisfies Plugin;

packages/knip/src/plugins.ts

@@ -1,5 +1,5 @@
 import parseArgs from 'minimist';
-import type { Plugin, ResolveEntryPaths } from '../../types/config.js';
+import type { Plugin, ResolveConfig } from '../../types/config.js';
 import type { PackageJson } from '../../types/package-json.js';
 import { toEntry } from '../../util/input.js';
 
@@ -15,7 +15,7 @@ const config = ['package.json'];
 
 const packageJsonPath = (id: PackageJson) => id;
 
-const resolveEntryPaths: ResolveEntryPaths<PackageJson> = localConfig => {
+const resolveConfig: ResolveConfig<PackageJson> = localConfig => {
   const scripts = localConfig.scripts;
 
   if (scripts) {
@@ -37,5 +37,5 @@ export default {
   isEnabled,
   config,
   packageJsonPath,
-  resolveEntryPaths,
+  resolveConfig,
 } satisfies Plugin;

packages/knip/src/plugins/ava/index.ts

@@ -1,4 +1,4 @@
-import type { IsPluginEnabled, Plugin, ResolveConfig, ResolveEntryPaths } from '../../types/config.js';
+import type { IsPluginEnabled, Plugin, ResolveConfig } from '../../types/config.js';
 import { toDeferResolve, toEntry } from '../../util/input.js';
 import { hasDependency } from '../../util/plugin.js';
 import type { CucumberConfig } from './types.js';
@@ -15,14 +15,11 @@ const config = ['cucumber.{json,yaml,yml,js,cjs,mjs}'];
 
 const entry = ['features/**/*.@(js|cjs|mjs)'];
 
-const resolveEntryPaths: ResolveEntryPaths<CucumberConfig> = config => {
-  return (config?.import ? config.import : []).map(id => toEntry(id));
-};
-
 const resolveConfig: ResolveConfig<CucumberConfig> = config => {
+  const imports = (config?.import ? config.import : entry).map(id => toEntry(id));
   const formatters = config?.format ? config.format : [];
   const requires = config?.require ? config.require : [];
-  return [...formatters, ...requires].map(toDeferResolve);
+  return imports.concat([...formatters, ...requires].map(toDeferResolve));
 };
 
 export default {
@@ -31,6 +28,5 @@ export default {
   isEnabled,
   config,
   entry,
-  resolveEntryPaths,
   resolveConfig,
 } satisfies Plugin;

packages/knip/src/plugins/bun/index.ts

@@ -1,4 +1,4 @@
-import type { IsPluginEnabled, Plugin, ResolveConfig, ResolveEntryPaths } from '../../types/config.js';
+import type { IsPluginEnabled, Plugin, ResolveConfig } from '../../types/config.js';
 import { toDeferResolve, toEntry } from '../../util/input.js';
 import { hasDependency } from '../../util/plugin.js';
 import { resolveDependencies } from './helpers.js';
@@ -25,18 +25,15 @@ const SUPPORT_FILE_PATTERNS = [
 
 const entry = [...TEST_FILE_PATTERNS, ...SUPPORT_FILE_PATTERNS];
 
-const resolveEntryPaths: ResolveEntryPaths = async localConfig => {
+const resolveConfig: ResolveConfig<CypressConfig> = async (localConfig, options) => {
   const specPatterns = [localConfig.e2e?.specPattern ?? [], localConfig.component?.specPattern ?? []].flat();
   const supportFiles = [localConfig.e2e?.supportFile || [], localConfig.component?.supportFile || []].flat();
+  const inputs = await resolveDependencies(localConfig, options);
   return [
-    ...(specPatterns.length > 0 ? specPatterns : TEST_FILE_PATTERNS),
-    ...(supportFiles.length > 0 ? supportFiles : SUPPORT_FILE_PATTERNS),
-  ].map(id => toEntry(id));
-};
-
-const resolveConfig: ResolveConfig<CypressConfig> = async (config, options) => {
-  const inputs = await resolveDependencies(config, options);
-  return inputs.map(toDeferResolve);
+    ...inputs.map(toDeferResolve),
+    ...(specPatterns.length > 0 ? specPatterns : TEST_FILE_PATTERNS).map(id => toEntry(id)),
+    ...(supportFiles.length > 0 ? supportFiles : SUPPORT_FILE_PATTERNS).map(id => toEntry(id)),
+  ];
 };
 
 export default {
@@ -45,6 +42,5 @@ export default {
   isEnabled,
   config,
   entry,
-  resolveEntryPaths,
   resolveConfig,
 } satisfies Plugin;

packages/knip/src/plugins/cucumber/index.ts

@@ -1,4 +1,12 @@
 export interface CypressConfig {
   reporter: string;
   reporterOptions?: { configFile?: string };
+  component?: {
+    specPattern?: string[];
+    supportFile?: string;
+  };
+  e2e?: {
+    specPattern?: string[];
+    supportFile?: string;
+  };
 }

packages/knip/src/plugins/cypress/index.ts

@@ -1,5 +1,3 @@
-import type { EleventyConfig } from './types.js';
-
 // https://github.com/11ty/eleventy/blob/main/src/UserConfig.js
 
 /** @public */
@@ -150,7 +148,7 @@ export class DummyEleventyConfig {
 }
 
 // https://www.11ty.dev/docs/config/#configuration-options
-export const defaultEleventyConfig: EleventyConfig = {
+export const defaultEleventyConfig = {
   dir: {
     input: '.',
     output: '_site',