Add test suite for all current config loading systems (#301)

beaussan · webpro · web-flow · commit a18f2a670f45 · 2023-10-17T20:25:07.000+02:00
* Add test suite for all current config loading systems

* Introduce async and function config factories

* Rename all fixtures config names to match folder

* Apply suggestions from code review

Co-authored-by: Lars Kappert &lt;lars@webpro.nl&gt;

* Refactor using a exec wrapper for tests

* Add dist cli auto path detection

* Use `path.resolve` to get absolute path to `dist/cli.js`

---------

Co-authored-by: Lars Kappert &lt;lars@webpro.nl&gt;
diff --git a/README.md b/README.md
@@ -125,6 +125,19 @@ const config: KnipConfig = {
 export default config;
 ```
 
+And if you need, you can also expose an (async) function if you need, like so:
+
+```ts
+import type { KnipConfig } from 'knip';
+
+const config = async (): Promise<KnipConfig> => ({
+  entry: ['src/index.ts'],
+  project: ['src/**/*.ts'],
+});
+
+export default config;
+```
+
 Use `--config path/to/knip.config.json` for a different path.
 
 ### Let's Go!
diff --git a/fixtures/config/js-async/dangling.js b/fixtures/config/js-async/dangling.js
@@ -0,0 +1 @@
+export const unusedFile = true;
diff --git a/fixtures/config/js-async/index.js b/fixtures/config/js-async/index.js
@@ -0,0 +1,3 @@
+import * as MyNamespace from './my-namespace';
+
+export const b = MyNamespace.y;
diff --git a/fixtures/config/js-async/knip.js b/fixtures/config/js-async/knip.js
@@ -0,0 +1,3 @@
+module.exports = async () => ({
+  ignore: ['dangling.js']
+});
diff --git a/fixtures/config/js-async/my-namespace.js b/fixtures/config/js-async/my-namespace.js
@@ -0,0 +1,2 @@
+const x = 1;
+export const y = () => x;
diff --git a/fixtures/config/js-async/package.json b/fixtures/config/js-async/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "@fixtures/config-js-async"
+}
diff --git a/fixtures/config/js-flat/dangling.js b/fixtures/config/js-flat/dangling.js
@@ -0,0 +1 @@
+export const unusedFile = true;
diff --git a/fixtures/config/js-flat/index.js b/fixtures/config/js-flat/index.js
@@ -0,0 +1,3 @@
+import * as MyNamespace from './my-namespace';
+
+export const b = MyNamespace.y;
diff --git a/fixtures/config/js-flat/knip.js b/fixtures/config/js-flat/knip.js
@@ -0,0 +1,3 @@
+module.exports = {
+  ignore: ['dangling.js']
+}
diff --git a/fixtures/config/js-flat/my-namespace.js b/fixtures/config/js-flat/my-namespace.js
@@ -0,0 +1,2 @@
+const x = 1;
+export const y = () => x;
diff --git a/fixtures/config/js-flat/package.json b/fixtures/config/js-flat/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "@fixtures/config-js-flat"
+}
diff --git a/fixtures/config/json/dangling.js b/fixtures/config/json/dangling.js
@@ -0,0 +1 @@
+export const unusedFile = true;
diff --git a/fixtures/config/json/index.js b/fixtures/config/json/index.js
@@ -0,0 +1,3 @@
+import * as MyNamespace from './my-namespace';
+
+export const b = MyNamespace.y;
diff --git a/fixtures/config/json/knip.json b/fixtures/config/json/knip.json
@@ -0,0 +1,3 @@
+{
+  "ignore": ["dangling.js"]
+}
diff --git a/fixtures/config/json/my-namespace.js b/fixtures/config/json/my-namespace.js
@@ -0,0 +1,2 @@
+const x = 1;
+export const y = () => x;
diff --git a/fixtures/config/json/package.json b/fixtures/config/json/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "@fixtures/config-json"
+}
diff --git a/fixtures/config/mjs-async/dangling.js b/fixtures/config/mjs-async/dangling.js
@@ -0,0 +1 @@
+export const unusedFile = true;
diff --git a/fixtures/config/mjs-async/index.js b/fixtures/config/mjs-async/index.js
@@ -0,0 +1,3 @@
+import * as MyNamespace from './my-namespace';
+
+export const b = MyNamespace.y;
diff --git a/fixtures/config/mjs-async/knip.mjs b/fixtures/config/mjs-async/knip.mjs
@@ -0,0 +1,5 @@
+const config = async () => ({
+  ignore: ['dangling.js'],
+});
+
+export default config;
diff --git a/fixtures/config/mjs-async/my-namespace.js b/fixtures/config/mjs-async/my-namespace.js
@@ -0,0 +1,2 @@
+const x = 1;
+export const y = () => x;
diff --git a/fixtures/config/mjs-async/package.json b/fixtures/config/mjs-async/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "@fixtures/config-mjs-async"
+}
diff --git a/fixtures/config/mjs-flat/dangling.js b/fixtures/config/mjs-flat/dangling.js
@@ -0,0 +1 @@
+export const unusedFile = true;
diff --git a/fixtures/config/mjs-flat/index.js b/fixtures/config/mjs-flat/index.js
@@ -0,0 +1,3 @@
+import * as MyNamespace from './my-namespace';
+
+export const b = MyNamespace.y;
diff --git a/fixtures/config/mjs-flat/knip.mjs b/fixtures/config/mjs-flat/knip.mjs
@@ -0,0 +1,5 @@
+const config = {
+  ignore: ['dangling.js'],
+};
+
+export default config;
diff --git a/fixtures/config/mjs-flat/my-namespace.js b/fixtures/config/mjs-flat/my-namespace.js
@@ -0,0 +1,2 @@
+const x = 1;
+export const y = () => x;
diff --git a/fixtures/config/mjs-flat/package.json b/fixtures/config/mjs-flat/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "@fixtures/config-mjs-flat"
+}
diff --git a/fixtures/config/package-json/dangling.js b/fixtures/config/package-json/dangling.js
@@ -0,0 +1 @@
+export const unusedFile = true;
diff --git a/fixtures/config/package-json/index.js b/fixtures/config/package-json/index.js
@@ -0,0 +1,3 @@
+import * as MyNamespace from './my-namespace';
+
+export const b = MyNamespace.y;
diff --git a/fixtures/config/package-json/my-namespace.js b/fixtures/config/package-json/my-namespace.js
@@ -0,0 +1,2 @@
+const x = 1;
+export const y = () => x;
diff --git a/fixtures/config/package-json/package.json b/fixtures/config/package-json/package.json
@@ -0,0 +1,6 @@
+{
+  "name": "@fixtures/config-package-json",
+  "knip": {
+    "ignore": ["dangling.js"]
+  }
+}
diff --git a/fixtures/config/ts-async/dangling.js b/fixtures/config/ts-async/dangling.js
@@ -0,0 +1 @@
+export const unusedFile = true;
diff --git a/fixtures/config/ts-async/index.js b/fixtures/config/ts-async/index.js
@@ -0,0 +1,3 @@
+import * as MyNamespace from './my-namespace';
+
+export const b = MyNamespace.y;
diff --git a/fixtures/config/ts-async/knip.ts b/fixtures/config/ts-async/knip.ts
@@ -0,0 +1,7 @@
+import type { KnipConfig } from '../../../src/index';
+
+const config = async (): Promise<KnipConfig> => ({
+  ignore: ['dangling.js'],
+});
+
+export default config;
diff --git a/fixtures/config/ts-async/my-namespace.js b/fixtures/config/ts-async/my-namespace.js
@@ -0,0 +1,2 @@
+const x = 1;
+export const y = () => x;
diff --git a/fixtures/config/ts-async/package.json b/fixtures/config/ts-async/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "@fixtures/config-ts-async"
+}
diff --git a/fixtures/config/ts-async/tsconfig.json b/fixtures/config/ts-async/tsconfig.json
@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "types": ["node"]
+  }
+}
diff --git a/fixtures/config/ts-flat/dangling.js b/fixtures/config/ts-flat/dangling.js
@@ -0,0 +1 @@
+export const unusedFile = true;
diff --git a/fixtures/config/ts-flat/index.js b/fixtures/config/ts-flat/index.js
@@ -0,0 +1,3 @@
+import * as MyNamespace from './my-namespace';
+
+export const b = MyNamespace.y;
diff --git a/fixtures/config/ts-flat/knip.ts b/fixtures/config/ts-flat/knip.ts
@@ -0,0 +1,7 @@
+import type { KnipConfig } from '../../../src/index';
+
+const config: KnipConfig = {
+  ignore: ['dangling.js'],
+};
+
+export default config;
diff --git a/fixtures/config/ts-flat/my-namespace.js b/fixtures/config/ts-flat/my-namespace.js
@@ -0,0 +1,2 @@
+const x = 1;
+export const y = () => x;
diff --git a/fixtures/config/ts-flat/package.json b/fixtures/config/ts-flat/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "@fixtures/config-ts-flat"
+}
diff --git a/fixtures/config/ts-flat/tsconfig.json b/fixtures/config/ts-flat/tsconfig.json
@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "types": ["node"]
+  }
+}
diff --git a/fixtures/config/ts-function/dangling.js b/fixtures/config/ts-function/dangling.js
@@ -0,0 +1 @@
+export const unusedFile = true;
diff --git a/fixtures/config/ts-function/index.js b/fixtures/config/ts-function/index.js
@@ -0,0 +1,3 @@
+import * as MyNamespace from './my-namespace';
+
+export const b = MyNamespace.y;
diff --git a/fixtures/config/ts-function/knip.ts b/fixtures/config/ts-function/knip.ts
@@ -0,0 +1,7 @@
+import type { KnipConfig } from '../../../src/index';
+
+const config = (): KnipConfig => ({
+  ignore: ['dangling.js'],
+});
+
+export default config;
diff --git a/fixtures/config/ts-function/my-namespace.js b/fixtures/config/ts-function/my-namespace.js
@@ -0,0 +1,2 @@
+const x = 1;
+export const y = () => x;
diff --git a/fixtures/config/ts-function/package.json b/fixtures/config/ts-function/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "@fixtures/config-ts-function"
+}
diff --git a/fixtures/config/ts-function/tsconfig.json b/fixtures/config/ts-function/tsconfig.json
@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "types": ["node"]
+  }
+}
diff --git a/fixtures/config/yaml/dangling.js b/fixtures/config/yaml/dangling.js
@@ -0,0 +1 @@
+export const unusedFile = true;
diff --git a/fixtures/config/yaml/index.js b/fixtures/config/yaml/index.js
@@ -0,0 +1,3 @@
+import * as MyNamespace from './my-namespace';
+
+export const b = MyNamespace.y;
diff --git a/fixtures/config/yaml/knip.yaml b/fixtures/config/yaml/knip.yaml
@@ -0,0 +1,2 @@
+ignore:
+  - 'dangling.js'
diff --git a/fixtures/config/yaml/my-namespace.js b/fixtures/config/yaml/my-namespace.js
@@ -0,0 +1,2 @@
+const x = 1;
+export const y = () => x;
diff --git a/fixtures/config/yaml/package.json b/fixtures/config/yaml/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "@fixtures/config-yaml"
+}
diff --git a/src/ConfigurationChief.ts b/src/ConfigurationChief.ts
@@ -18,6 +18,7 @@ import { getKeysByValue } from './util/object.js';
 import { join, relative, toPosix } from './util/path.js';
 import { normalizePluginConfig, toCamelCase } from './util/plugin.js';
 import { _require } from './util/require.js';
+import { unwrapFunction } from './util/unwrapFunction.js';
 import { byPathDepth } from './util/workspace.js';
 import type { SyncCompilers, AsyncCompilers } from './types/compilers.js';
 import type {
@@ -150,7 +151,9 @@ export class ConfigurationChief {
       throw new ConfigurationError(`Unable to find ${rawConfigArg} or package.json#knip`);
     }
 
-    this.rawConfig = this.resolvedConfigFilePath ? await _load(this.resolvedConfigFilePath) : manifest.knip;
+    this.rawConfig = this.resolvedConfigFilePath
+      ? await this.loadResolvedConfigurationFile(this.resolvedConfigFilePath)
+      : manifest.knip;
 
     // Have to partition compiler functions before Zod touches them
     const parsedConfig = this.rawConfig ? ConfigurationValidator.parse(partitionCompilers(this.rawConfig)) : {};
@@ -159,6 +162,15 @@ export class ConfigurationChief {
     await this.setWorkspaces();
   }
 
+  private async loadResolvedConfigurationFile(configPath: string) {
+    const loadedValue = await _load(configPath);
+    try {
+      return await unwrapFunction(loadedValue);
+    } catch (e) {
+      throw new ConfigurationError(`Error running the function from ${configPath}`);
+    }
+  }
+
   public getCompilers(): [SyncCompilers, AsyncCompilers] {
     return [this.config.syncCompilers, this.config.asyncCompilers];
   }
diff --git a/src/util/unwrapFunction.ts b/src/util/unwrapFunction.ts
@@ -0,0 +1,13 @@
+import { debugLogObject } from './debug.js';
+
+export const unwrapFunction = async (possibleFunction: unknown) => {
+  if (typeof possibleFunction === 'function') {
+    try {
+      return await possibleFunction();
+    } catch (error) {
+      debugLogObject('*', 'Error executing function:', error);
+      throw error;
+    }
+  }
+  return possibleFunction;
+};
diff --git a/test/cli-preprocessor.test.ts b/test/cli-preprocessor.test.ts
@@ -1,18 +1,11 @@
 import assert from 'node:assert/strict';
-import { execSync } from 'node:child_process';
 import test from 'node:test';
 import { resolve } from '../src/util/path.js';
+import { execFactory } from './helpers/execKnip.js';
 
 const cwd = resolve('fixtures/cli-preprocessor');
 
-const exec = (command: string) => {
-  try {
-    const output = execSync(command.replace(/^knip/, 'node ../../dist/cli.js'), { cwd });
-    return output.toString().trim();
-  } catch {
-    console.error(`Error during execution of command: ${command}`);
-  }
-};
+const exec = execFactory(cwd);
 
 test('knip --preprocessor ./index.js', () => {
   assert.equal(exec('knip --preprocessor ./index.js'), 'hi from js preprocessor');
diff --git a/test/cli-reporter.test.ts b/test/cli-reporter.test.ts
@@ -1,14 +1,11 @@
 import assert from 'node:assert/strict';
-import { execSync } from 'node:child_process';
 import test from 'node:test';
 import { resolve } from '../src/util/path.js';
+import { execFactory } from './helpers/execKnip.js';
 
 const cwd = resolve('fixtures/cli-reporter');
 
-const exec = (command: string) => {
-  const output = execSync(command.replace(/^knip/, 'node ../../dist/cli.js'), { cwd });
-  return output.toString().trim();
-};
+const exec = execFactory(cwd);
 
 test('knip --reporter ./index.js', () => {
   assert.equal(exec('knip --reporter ./index.js'), 'hi from js reporter');
diff --git a/test/cli.test.ts b/test/cli.test.ts
@@ -1,16 +1,13 @@
 import assert from 'node:assert/strict';
-import { execSync } from 'node:child_process';
 import test from 'node:test';
 import { helpText } from '../src/util/cli-arguments.js';
 import { resolve } from '../src/util/path.js';
 import { version } from '../src/version.js';
+import { execFactory } from './helpers/execKnip.js';
 
 const cwd = resolve('fixtures/cli');
 
-const exec = (command: string) => {
-  const output = execSync(command.replace(/^knip/, 'node ../../dist/cli.js'), { cwd });
-  return output.toString().trim();
-};
+const exec = execFactory(cwd);
 
 test('knip --version', () => {
   assert.equal(exec('knip --version'), version);
diff --git a/test/config/js-async.test.ts b/test/config/js-async.test.ts
@@ -0,0 +1,12 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+import { resolve } from '../../src/util/path.js';
+import { execFactory } from '../helpers/execKnip.js';
+
+const cwd = resolve('fixtures/config/js-async');
+
+const exec = execFactory(cwd);
+
+test('Support loading js async function for configuration', async () => {
+  assert.equal(exec('knip'), '');
+});
diff --git a/test/config/js-flat.test.ts b/test/config/js-flat.test.ts
@@ -0,0 +1,12 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+import { resolve } from '../../src/util/path.js';
+import { execFactory } from '../helpers/execKnip.js';
+
+const cwd = resolve('fixtures/config/js-flat');
+
+const exec = execFactory(cwd);
+
+test('Support loading js object files for configuration', async () => {
+  assert.equal(exec('knip'), '');
+});
diff --git a/test/config/json.test.ts b/test/config/json.test.ts
@@ -0,0 +1,12 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+import { resolve } from '../../src/util/path.js';
+import { execFactory } from '../helpers/execKnip.js';
+
+const cwd = resolve('fixtures/config/json');
+
+const exec = execFactory(cwd);
+
+test('Support loading json files for configuration', async () => {
+  assert.equal(exec('knip'), '');
+});
diff --git a/test/config/mjs-async.test.ts b/test/config/mjs-async.test.ts
@@ -0,0 +1,12 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+import { resolve } from '../../src/util/path.js';
+import { execFactory } from '../helpers/execKnip.js';
+
+const cwd = resolve('fixtures/config/mjs-async');
+
+const exec = execFactory(cwd);
+
+test('Support loading mjs async function files for configuration', async () => {
+  assert.equal(exec('knip -c knip.mjs'), '');
+});
diff --git a/test/config/mjs-flat.test.ts b/test/config/mjs-flat.test.ts
@@ -0,0 +1,12 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+import { resolve } from '../../src/util/path.js';
+import { execFactory } from '../helpers/execKnip.js';
+
+const cwd = resolve('fixtures/config/mjs-flat');
+
+const exec = execFactory(cwd);
+
+test('Support loading mjs object files for configuration', async () => {
+  assert.equal(exec('knip -c knip.mjs'), '');
+});
diff --git a/test/config/package-json.test.ts b/test/config/package-json.test.ts
diff --git a/test/config/ts-async.test.ts b/test/config/ts-async.test.ts
diff --git a/test/config/ts-flat.test.ts b/test/config/ts-flat.test.ts
diff --git a/test/config/ts-function.test.ts b/test/config/ts-function.test.ts
diff --git a/test/config/yaml.test.ts b/test/config/yaml.test.ts
diff --git a/test/helpers/execKnip.ts b/test/helpers/execKnip.ts
