feat: add details to error messages

lib/definitions/errors.js

@@ -0,0 +1,16 @@
+const url = require('url');
+const pkg = require('../../package.json');
+
+const homepage = url.format({...url.parse(pkg.homepage), ...{hash: null}});
+const linkify = file => `${homepage}/blob/master/${file}`;
+
+module.exports = {
+  EINVALIDCHANGELOGFILE: ({changelogFile}) => ({
+    message: 'Invalid `changelogFile` option.',
+    details: `The [changelogFile option](${linkify(
+      'README.md#changelogfile'
+    )}) option, if defined, must be a non empty \`String\`.
+
+Your configuration for the \`assets\` option is \`${changelogFile}\`.`,
+  }),
+};

lib/get-error.js

@@ -0,0 +1,7 @@
+const SemanticReleaseError = require('@semantic-release/error');
+const ERROR_DEFINITIONS = require('./definitions/errors');
+
+module.exports = (code, ctx) => {
+  const {message, details} = ERROR_DEFINITIONS[code](ctx);
+  return new SemanticReleaseError(message, code, details);
+};

lib/verify.js

@@ -1,19 +1,14 @@
 const {isString, isUndefined} = require('lodash');
 const AggregateError = require('aggregate-error');
-const SemanticReleaseError = require('@semantic-release/error');
+const getError = require('./get-error');
 const resolveConfig = require('./resolve-config');
 
 module.exports = pluginConfig => {
   const {changelogFile} = resolveConfig(pluginConfig);
   const errors = [];
 
   if (!isUndefined(changelogFile) && !(isString(changelogFile) && changelogFile.trim())) {
-    errors.push(
-      new SemanticReleaseError(
-        'The "changelogFile" options, if defined, must be a non empty String.',
-        'EINVALIDCHANGELOGFILE'
-      )
-    );
+    errors.push(getError('EINVALIDCHANGELOGFILE', {changelogFile}));
   }
 
   if (errors.length > 0) {