Support plugin config at root level (resolves #260)

fixtures/plugin-config/index.ts

@@ -0,0 +1 @@
+export default 1;

fixtures/plugin-config/index.vitest.ts

@@ -0,0 +1 @@
+export default 1;

fixtures/plugin-config/knip.json

@@ -0,0 +1,3 @@
+{
+  "vitest": { "entry": ["**/*.vitest.ts"] }
+}

fixtures/plugin-config/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@fixtures/plugin-config",
+  "scripts": {
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "vitest": "*"
+  },
+  "workspaces": [
+    "packages/*"
+  ]
+}

fixtures/workspaces-plugin-config/knip.json

@@ -0,0 +1,6 @@
+{
+  "vitest": { "entry": ["**/*.vitest.ts"] },
+  "workspaces": {
+    "packages/*": {}
+  }
+}

fixtures/workspaces-plugin-config/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@workspaces-plugin-config/root",
+  "workspaces": [
+    "packages/*"
+  ]
+}

fixtures/workspaces-plugin-config/packages/backend/index.ts

@@ -0,0 +1 @@
+export default 1;

fixtures/workspaces-plugin-config/packages/backend/index.vitest.ts

@@ -0,0 +1,3 @@
+import { test } from 'vitest';
+
+test('it', () => {});

fixtures/workspaces-plugin-config/packages/backend/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@workspaces-plugin-config/backend",
+  "scripts": {
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "vitest": "*"
+  }
+}

fixtures/workspaces-plugin-config/packages/frontend/index.ts

@@ -0,0 +1 @@
+export default 1;

fixtures/workspaces-plugin-config/packages/frontend/index.vitest.ts

@@ -0,0 +1 @@
+export default 1;

fixtures/workspaces-plugin-config/packages/frontend/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@workspaces-plugin-config/frontend",
+  "scripts": {
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "vitest": "*"
+  }
+}

src/ConfigurationChief.ts

@@ -15,10 +15,17 @@ import { _dirGlob } from './util/glob.js';
 import { _load } from './util/loader.js';
 import { getKeysByValue } from './util/object.js';
 import { join, relative, toPosix } from './util/path.js';
-import { toCamelCase } from './util/plugin.js';
+import { normalizePluginConfig, toCamelCase } from './util/plugin.js';
 import { byPathDepth } from './util/workspace.js';
 import type { SyncCompilers, AsyncCompilers } from './types/compilers.js';
-import type { RawConfiguration, Configuration, PluginName, WorkspaceConfiguration } from './types/config.js';
+import type {
+  RawConfiguration,
+  RawPluginConfiguration,
+  Configuration,
+  PluginName,
+  PluginsConfiguration,
+  WorkspaceConfiguration,
+} from './types/config.js';
 import type { PackageJson } from '@npmcli/package-json';
 
 const {
@@ -176,6 +183,15 @@ export class ConfigurationChief {
 
     const defaultWorkspaceConfig = getDefaultWorkspaceConfig(extensions);
 
+    const rootPluginConfigs: Partial<PluginsConfiguration> = {};
+
+    for (const [name, pluginConfig] of Object.entries(rawLocalConfig)) {
+      const pluginName = toCamelCase(name) as PluginName;
+      if (PLUGIN_NAMES.includes(pluginName)) {
+        rootPluginConfigs[pluginName] = normalizePluginConfig(pluginConfig as RawPluginConfiguration);
+      }
+    }
+
     const workspaces = Object.entries(initialWorkspaces)
       .filter(([workspaceName]) => !ignoreWorkspaces.includes(workspaceName))
       .reduce(
@@ -195,22 +211,15 @@ export class ConfigurationChief {
             ignoreDependencies: arrayify(workspaceConfig.ignoreDependencies),
           };
 
+          for (const [name, pluginConfig] of Object.entries(rootPluginConfigs)) {
+            const pluginName = toCamelCase(name) as PluginName;
+            if (pluginConfig) workspaces[workspaceName][pluginName] = pluginConfig;
+          }
+
           for (const [name, pluginConfig] of Object.entries(workspaceConfig)) {
             const pluginName = toCamelCase(name) as PluginName;
             if (PLUGIN_NAMES.includes(pluginName)) {
-              if (pluginConfig === false) {
-                workspaces[workspaceName][pluginName] = false;
-              } else {
-                const isObject = typeof pluginConfig !== 'string' && !Array.isArray(pluginConfig);
-                const config = isObject ? arrayify(pluginConfig.config) : pluginConfig ? arrayify(pluginConfig) : null;
-                const entry = isObject && 'entry' in pluginConfig ? arrayify(pluginConfig.entry) : null;
-                const project = isObject && 'project' in pluginConfig ? arrayify(pluginConfig.project) : entry;
-                workspaces[workspaceName][pluginName] = {
-                  config,
-                  entry,
-                  project,
-                };
-              }
+              workspaces[workspaceName][pluginName] = normalizePluginConfig(pluginConfig as RawPluginConfiguration);
             }
           }
           return workspaces;

src/ConfigurationValidator.ts

@@ -62,7 +62,7 @@ const reportConfigSchema = z.object({
   exclude: z.array(z.string()).optional(),
 });
 
-const pluginSchema = z.union([
+export const pluginSchema = z.union([
   z.literal(false),
   globSchema,
   z.object({

src/types/config.ts

@@ -1,11 +1,13 @@
 import { z } from 'zod';
-import { ConfigurationValidator } from '../ConfigurationValidator.js';
+import { ConfigurationValidator, pluginSchema } from '../ConfigurationValidator.js';
 import * as Plugins from '../plugins/index.js';
 import type { Rules } from './issues.js';
 import type { SyncCompilers, AsyncCompilers } from '../types/compilers.js';
 
 export type RawConfiguration = z.infer<typeof ConfigurationValidator>;
 
+export type RawPluginConfiguration = z.infer<typeof pluginSchema>;
+
 type NormalizedGlob = string[];
 
 export type PluginName = keyof typeof Plugins;
@@ -18,7 +20,7 @@ export type PluginConfiguration =
     }
   | false;
 
-type PluginsConfiguration = Record<PluginName, PluginConfiguration>;
+export type PluginsConfiguration = Record<PluginName, PluginConfiguration>;
 
 interface BaseWorkspaceConfiguration {
   entry: NormalizedGlob;

src/util/plugin.ts

@@ -1,4 +1,6 @@
 export { _load as load } from './loader.js';
+import { arrayify } from './array.js';
+import type { RawPluginConfiguration } from 'src/types/config.js';
 
 export const toCamelCase = (name: string) =>
   name.toLowerCase().replace(/(-[a-z])/g, group => group.toUpperCase().replace('-', ''));
@@ -14,3 +16,15 @@ export const hasDependency = (dependencies: Set<string>, values: (string | RegEx
     }
     return false;
   });
+
+export const normalizePluginConfig = (pluginConfig: RawPluginConfiguration) => {
+  if (pluginConfig === false) {
+    return false;
+  } else {
+    const isObject = typeof pluginConfig !== 'string' && !Array.isArray(pluginConfig);
+    const config = isObject ? arrayify(pluginConfig.config) : pluginConfig ? arrayify(pluginConfig) : null;
+    const entry = isObject && 'entry' in pluginConfig ? arrayify(pluginConfig.entry) : null;
+    const project = isObject && 'project' in pluginConfig ? arrayify(pluginConfig.project) : entry;
+    return { config, entry, project };
+  }
+};

tests/plugin-config.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/plugin-config');
+
+test('Use root plugin config', async () => {
+  const { counters } = await main({
+    ...baseArguments,
+    cwd,
+  });
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    total: 2,
+    processed: 2,
+  });
+});

tests/workspaces-plugin-config.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/workspaces-plugin-config');
+
+test('Use root plugin config in workspaces', async () => {
+  const { counters } = await main({
+    ...baseArguments,
+    cwd,
+  });
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    total: 4,
+    processed: 4,
+  });
+});