Validate plugins

src/config/normalize/lib/definitions.js

@@ -10,6 +10,7 @@ export const applyDefinition = async function (
     path = false,
     cwd = '.',
     glob = false,
+    required = false,
     validate,
     transform,
   },
@@ -26,10 +27,17 @@ export const applyDefinition = async function (
 
   const valueA = await addDefaultValue(value, defaultValue, opts)
   const valueB = await computeValue(valueA, compute, opts)
-  const valueC = await resolvePath(valueB, { path, cwd, glob, opts })
-  await validateValue(valueC, validate, opts)
-  const valueD = await transformValue(valueC, transform, opts)
-  return valueD
+  const valueC = await applyValidateTransform({
+    value: valueB,
+    path,
+    cwd,
+    glob,
+    required,
+    validate,
+    transform,
+    opts,
+  })
+  return valueC
 }
 
 // Apply `pick(value, opts)` which omits the current value if `false` is
@@ -58,6 +66,34 @@ const computeValue = async function (value, compute, opts) {
   return compute === undefined ? value : await callUserFunc(compute, opts)
 }
 
+const applyValidateTransform = async function ({
+  value,
+  path,
+  cwd,
+  glob,
+  required,
+  validate,
+  transform,
+  opts,
+}) {
+  const valueA = await resolvePath(value, { path, cwd, glob, opts })
+  await validateRequired(valueA, required, opts)
+  await validateValue(valueA, validate, opts)
+  const valueB = await transformValue(valueA, transform, opts)
+  return valueB
+}
+
+// Apply `required(value, opts)` which throws if `true` and value is `undefined`
+const validateRequired = async function (value, required, opts) {
+  if (value === undefined && (await callValueFunc(required, value, opts))) {
+    await callValidateFunc(throwRequired, value, opts)
+  }
+}
+
+const throwRequired = function () {
+  throw new Error('must be defined.')
+}
+
 // Apply `validate(value, opts)` which throws on validation errors
 const validateValue = async function (value, validate, opts) {
   if (value !== undefined && validate !== undefined) {

src/config/normalize/validate.js

@@ -58,6 +58,12 @@ const isJson = function (value) {
   }
 }
 
+export const validateFunction = function (value) {
+  if (typeof value !== 'function') {
+    throw new TypeError('must be a function.')
+  }
+}
+
 export const validateFileExists = async function (value) {
   if (!(await pathExists(value))) {
     throw new Error('must be an existing file.')

src/config/plugin/add.js

@@ -37,6 +37,7 @@ const getPluginsByType = async function (
     builtins,
     topProps,
     isCombinationDimension,
+    mainDefinitions,
   },
   config,
 ) {
@@ -52,6 +53,7 @@ const getPluginsByType = async function (
     modulePrefix,
     builtins,
     isCombinationDimension,
+    mainDefinitions,
   })
   const pluginsA = addPluginsConfig({ plugins, config, configProp, topProps })
   return [varName, pluginsA]

src/config/plugin/load.js

@@ -3,6 +3,7 @@ import { createRequire } from 'module'
 import { PluginError, UserError } from '../../error/main.js'
 import { wrapError } from '../../error/wrap.js'
 import { PLUGINS_IMPORT_BASE } from '../normalize/cwd.js'
+import { normalizeConfig } from '../normalize/main.js'
 
 import { getModuleId } from './id.js'
 
@@ -13,10 +14,18 @@ export const loadPlugins = async function ({
   modulePrefix,
   builtins,
   isCombinationDimension,
+  mainDefinitions,
 }) {
   return await Promise.all(
     ids.map((id) =>
-      loadPlugin({ id, type, modulePrefix, builtins, isCombinationDimension }),
+      loadPlugin({
+        id,
+        type,
+        modulePrefix,
+        builtins,
+        isCombinationDimension,
+        mainDefinitions,
+      }),
     ),
   )
 }
@@ -27,10 +36,13 @@ const loadPlugin = async function ({
   modulePrefix,
   builtins,
   isCombinationDimension,
+  mainDefinitions,
 }) {
   const moduleId = getModuleId(id, type, isCombinationDimension)
   const plugin = await importPlugin({ moduleId, type, modulePrefix, builtins })
-  return { ...plugin, id }
+  const pluginA = { ...plugin }
+  const pluginB = await normalizePlugin(pluginA, mainDefinitions)
+  return { ...pluginB, id }
 }
 
 // Builtin modules are lazy loaded for performance reasons
@@ -82,3 +94,11 @@ This Node module was not found, please ensure it is installed.\n\n`,
     )
   }
 }
+
+// Validate a plugin has the correct shape and normalize it
+const normalizePlugin = async function (plugin, mainDefinitions) {
+  return await normalizeConfig(plugin, mainDefinitions, {
+    context: {},
+    ErrorType: PluginError,
+  })
+}

src/config/plugin/types.js

@@ -1,10 +1,18 @@
+import { DEFAULT_REPORTER_OUTPUT } from '../../report/contents/output.js'
+import { getReportMethods } from '../../report/formats/list.js'
 import {
   BUILTIN_REPORTERS,
   DEFAULT_REPORTERS,
 } from '../../report/reporters/main.js'
 import { BUILTIN_RUNNERS, DEFAULT_RUNNERS } from '../../runners/main.js'
 import { normalizeOptionalArray } from '../normalize/transform.js'
-import { validateEmptyArray } from '../normalize/validate.js'
+import {
+  validateBoolean,
+  validateDefinedString,
+  validateObject,
+  validateEmptyArray,
+  validateFunction,
+} from '../normalize/validate.js'
 
 // All plugin types
 export const PLUGIN_TYPES = {
@@ -34,6 +42,13 @@ export const PLUGIN_TYPES = {
     selectPropDefinition: {
       validate: validateEmptyArray,
     },
+    mainDefinitions: [
+      {
+        name: 'launch',
+        required: true,
+        validate: validateFunction,
+      },
+    ],
   },
   reporter: {
     type: 'reporter',
@@ -60,6 +75,32 @@ export const PLUGIN_TYPES = {
         return config.force ? [] : normalizeOptionalArray(value)
       },
     },
+    mainDefinitions: [
+      ...getReportMethods().map((name) => ({
+        name,
+        validate: validateFunction,
+      })),
+      {
+        name: 'capabilities',
+        default: {},
+        validate: validateObject,
+      },
+      {
+        name: 'capabilities.debugStats',
+        default: false,
+        validate: validateBoolean,
+      },
+      {
+        name: 'capabilities.history',
+        default: false,
+        validate: validateBoolean,
+      },
+      {
+        name: 'defaultOutput',
+        default: DEFAULT_REPORTER_OUTPUT,
+        validate: validateDefinedString,
+      },
+    ],
   },
 }
 

src/report/config/main.js

@@ -31,14 +31,12 @@ const addOutput = function (reporter) {
 // `reporter.defaultOutput` is meant for reporters to define the default format
 // and filename
 const getOutput = function ({
-  defaultOutput = DEFAULT_OUTPUT,
+  defaultOutput,
   config: { output = defaultOutput },
 }) {
   return output
 }
 
-const DEFAULT_OUTPUT = 'stdout'
-
 // `reporter.tty` is `true` when output is interactive terminal
 const getTty = function (output) {
   return output === 'stdout' && isTtyOutput()
@@ -57,13 +55,11 @@ const shouldUseReporter = function ({ tty }, command) {
 const addDefaultReporterConfig = function ({
   tty,
   config: { quiet = !tty, showDiff = tty, colors = tty, ...config },
-  capabilities: { debugStats = false, history = false } = {},
   ...reporter
 }) {
   return {
     ...reporter,
     tty,
     config: { ...config, quiet, showDiff, colors },
-    capabilities: { debugStats, history },
   }
 }

src/report/contents/output.js

@@ -15,6 +15,7 @@ export const isOutputPath = function (output) {
 }
 
 const OUTPUT_SPECIAL_VALUES = new Set(['stdout', 'external'])
+export const DEFAULT_REPORTER_OUTPUT = 'stdout'
 
 // Print result to file or to terminal based on the `output` configuration
 // property.

src/report/formats/list.js

@@ -11,3 +11,12 @@ const getFormatPair = function (format) {
 }
 
 export const FORMATS = getFormats()
+
+// Return all possible `report*()` methods
+export const getReportMethods = function () {
+  return [...new Set(FORMATS_ARRAY.flatMap(getFormatReportMethods))]
+}
+
+const getFormatReportMethods = function ({ methods }) {
+  return methods
+}

src/runners/cli/main.js

@@ -1,3 +1 @@
 export { launch } from './launch/main.js'
-
-export const id = 'cli'

src/runners/node/main.js

@@ -1,3 +1 @@
 export { launch } from './launch/main.js'
-
-export const id = 'node'