refactor: simplify plugin validation

lib/definitions/errors.js

@@ -4,7 +4,7 @@ const {toLower, isString} = require('lodash');
 const pkg = require('../../package.json');
 const {RELEASE_TYPE} = require('./constants');
 
-const homepage = url.format({...url.parse(pkg.homepage), ...{hash: null}});
+const homepage = url.format({...url.parse(pkg.homepage), hash: null});
 const stringify = obj => (isString(obj) ? obj : inspect(obj, {breakLength: Infinity, depth: 2, maxArrayLength: 5}));
 const linkify = file => `${homepage}/blob/caribou/${file}`;
 
@@ -55,25 +55,25 @@ Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`
 
 Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`,
   }),
-  EPLUGINCONF: ({pluginType, pluginConf}) => ({
-    message: `The \`${pluginType}\` plugin configuration is invalid.`,
-    details: `The [${pluginType} plugin configuration](${linkify(
-      `docs/usage/plugins.md#${toLower(pluginType)}-plugin`
+  EPLUGINCONF: ({type, pluginConf}) => ({
+    message: `The \`${type}\` plugin configuration is invalid.`,
+    details: `The [${type} plugin configuration](${linkify(
+      `docs/usage/plugins.md#${toLower(type)}-plugin`
     )}) if defined, must be a single or an array of plugins definition. A plugin definition is either a string or an object with a \`path\` property.
 
-    Your configuration for the \`${pluginType}\` plugin is \`${stringify(pluginConf)}\`.`,
+    Your configuration for the \`${type}\` plugin is \`${stringify(pluginConf)}\`.`,
   }),
-  EPLUGIN: ({pluginName, pluginType}) => ({
-    message: `A plugin configured in the step ${pluginType} is not a valid semantic-release plugin.`,
-    details: `A valid \`${pluginType}\` **semantic-release** plugin must be a function or an object with a function in the property \`${pluginType}\`.
+  EPLUGIN: ({pluginName, type}) => ({
+    message: `A plugin configured in the step ${type} is not a valid semantic-release plugin.`,
+    details: `A valid \`${type}\` **semantic-release** plugin must be a function or an object with a function in the property \`${type}\`.
 
-The plugin \`${pluginName}\` doesn't have the property \`${pluginType}\` and cannot be used for the \`${pluginType}\` step.
+The plugin \`${pluginName}\` doesn't have the property \`${type}\` and cannot be used for the \`${type}\` step.
 
 Please refer to the \`${pluginName}\` and [semantic-release plugins configuration](${linkify(
       'docs/usage/plugins.md'
     )}) documentation for more details.`,
   }),
-  EANALYZEOUTPUT: ({result, pluginName}) => ({
+  EANALYZECOMMITSOUTPUT: ({result, pluginName}) => ({
     message: 'The `analyzeCommits` plugin returned an invalid value. It must return a valid semver release type.',
     details: `The \`analyzeCommits\` plugin must return a valid [semver](https://semver.org) release type. The valid values are: ${RELEASE_TYPE.map(
       type => `\`${type}\``
@@ -89,7 +89,7 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
       'docs/developer-guide/plugin.md'
     )})`,
   }),
-  ERELEASENOTESOUTPUT: ({result, pluginName}) => ({
+  EGENERATENOTESOUTPUT: ({result, pluginName}) => ({
     message: 'The `generateNotes` plugin returned an invalid value. It must return a `String`.',
     details: `The \`generateNotes\` plugin must return a \`String\`.
 

lib/definitions/plugins.js

@@ -6,62 +6,37 @@ const validatePluginConfig = conf => isString(conf) || isString(conf.path) || is
 module.exports = {
   verifyConditions: {
     default: ['@semantic-release/npm', '@semantic-release/github'],
-    config: {
-      validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
-    },
+    configValidator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
   },
   analyzeCommits: {
     default: '@semantic-release/commit-analyzer',
-    config: {
-      validator: conf => Boolean(conf) && validatePluginConfig(conf),
-    },
-    output: {
-      validator: output => !output || RELEASE_TYPE.includes(output),
-      error: 'EANALYZEOUTPUT',
-    },
+    configValidator: conf => Boolean(conf) && validatePluginConfig(conf),
+    outputValidator: output => !output || RELEASE_TYPE.includes(output),
   },
   verifyRelease: {
     default: false,
-    config: {
-      validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
-    },
+    configValidator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
   },
   generateNotes: {
     default: '@semantic-release/release-notes-generator',
-    config: {
-      validator: conf => !conf || validatePluginConfig(conf),
-    },
-    output: {
-      validator: output => !output || isString(output),
-      error: 'ERELEASENOTESOUTPUT',
-    },
+    configValidator: conf => !conf || validatePluginConfig(conf),
+    outputValidator: output => !output || isString(output),
   },
   prepare: {
     default: ['@semantic-release/npm'],
-    config: {
-      validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
-    },
+    configValidator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
   },
   publish: {
     default: ['@semantic-release/npm', '@semantic-release/github'],
-    config: {
-      validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
-    },
-    output: {
-      validator: output => !output || isPlainObject(output),
-      error: 'EPUBLISHOUTPUT',
-    },
+    configValidator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
+    outputValidator: output => !output || isPlainObject(output),
   },
   success: {
     default: ['@semantic-release/github'],
-    config: {
-      validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
-    },
+    configValidator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
   },
   fail: {
     default: ['@semantic-release/github'],
-    config: {
-      validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
-    },
+    configValidator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
   },
 };