fix: harmonize parameters passed to getError

lib/branches/normalize.js

@@ -51,7 +51,7 @@ function maintenance({maintenance, release}) {
       tags,
       range: getRange(min, max),
       accept: diff ? RELEASE_TYPE.slice(0, RELEASE_TYPE.indexOf(diff)) : [],
-      'merge-range': getRange(maintenanceMin, getUpperBound(range)),
+      mergeRange: getRange(maintenanceMin, getUpperBound(range)),
     };
   });
 }

lib/definitions/errors.js

@@ -29,11 +29,9 @@ Please make sure to add the \`repositoryUrl\` to the [semantic-release configura
       'docs/usage/configuration.md'
     )}).`,
   }),
-  EGITNOPERMISSION: ({options}) => ({
+  EGITNOPERMISSION: ({options: {repositoryUrl}, branch: {name}}) => ({
     message: 'The push permission to the Git repository is required.',
-    details: `**semantic-release** cannot push the version tag to the branch \`${
-      options.branch
-    }\` on remote Git repository with URL \`${options.repositoryUrl}\`.
+    details: `**semantic-release** cannot push the version tag to the branch \`${name}\` on remote Git repository with URL \`${repositoryUrl}\`.
 
 Please refer to the [authentication configuration documentation](${linkify(
       'docs/usage/ci-configuration.md#authentication'
@@ -41,7 +39,7 @@ Please refer to the [authentication configuration documentation](${linkify(
       'docs/usage/configuration.md#repositoryurl'
     )}) is configured with a [valid Git URL](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols).`,
   }),
-  EINVALIDTAGFORMAT: ({tagFormat}) => ({
+  EINVALIDTAGFORMAT: ({options: {tagFormat}}) => ({
     message: 'Invalid `tagFormat` option.',
     details: `The [tagFormat](${linkify(
       'docs/usage/configuration.md#tagformat'
@@ -49,7 +47,7 @@ Please refer to the [authentication configuration documentation](${linkify(
 
 Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`,
   }),
-  ETAGNOVERSION: ({tagFormat}) => ({
+  ETAGNOVERSION: ({options: {tagFormat}}) => ({
     message: 'Invalid `tagFormat` option.',
     details: `The [tagFormat](${linkify(
       'docs/usage/configuration.md#tagformat'
@@ -205,40 +203,26 @@ Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
 
 Your configuration for the problematic branches is \`${stringify(branches)}\`.`,
   }),
-  EINVALIDNEXTVERSION: ({nextRelease, branch, commits, validBranches}) => ({
-    message: `The release \`${nextRelease.version}\` on branch \`${
-      branch.name
-    }\` cannot be published as it is out of range.`,
-    details: `Based on the releases published on other branches, only versions within the range \`${
-      branch.range
-    }\` can be published from branch \`${branch.name}\`.
+  EINVALIDNEXTVERSION: ({nextRelease: {version}, branch: {name, range}, commits, validBranches}) => ({
+    message: `The release \`${version}\` on branch \`${name}\` cannot be published as it is out of range.`,
+    details: `Based on the releases published on other branches, only versions within the range \`${range}\` can be published from branch \`${name}\`.
 
 The following commit${commits.length > 1 ? 's are' : ' is'} responsible for the invalid release:
 ${commits.map(({commit: {short}, subject}) => `- ${subject} (${short})`).join('\n')}
 
 ${
       commits.length > 1 ? 'Those commits' : 'This commit'
-    } should be moved to a valid branch with [git merge](https://git-scm.com/docs/git-merge) or [git cherry-pick](https://git-scm.com/docs/git-cherry-pick) and removed from branch \`${
-      branch.name
-    }\` with [git revert](https://git-scm.com/docs/git-revert) or [git reset](https://git-scm.com/docs/git-reset).
+    } should be moved to a valid branch with [git merge](https://git-scm.com/docs/git-merge) or [git cherry-pick](https://git-scm.com/docs/git-cherry-pick) and removed from branch \`${name}\` with [git revert](https://git-scm.com/docs/git-revert) or [git reset](https://git-scm.com/docs/git-reset).
 
 A valid branch could be ${wordsList(validBranches.map(({name}) => `\`${name}\``))}.
 
 See the [workflow configuration documentation](${linkify('docs/usage/workflow-configuration.md')}) for more details.`,
   }),
-  EINVALIDMAINTENANCEMERGE: ({nextRelease, branch}) => ({
-    message: `The release \`${nextRelease.version}\` on branch \`${
-      branch.name
-    }\` cannot be published as it is out of range.`,
-    details: `Only releases within the range \`${branch['merge-range']}\` can be merged into the maintenance branch \`${
-      branch.name
-    }\` and published to the \`${nextRelease.channel}\` distribution channel.
+  EINVALIDMAINTENANCEMERGE: ({nextRelease: {channel, gitTag, version}, branch: {mergeRange, name}}) => ({
+    message: `The release \`${version}\` on branch \`${name}\` cannot be published as it is out of range.`,
+    details: `Only releases within the range \`${mergeRange}\` can be merged into the maintenance branch \`${name}\` and published to the \`${channel}\` distribution channel.
 
-The branch \`${
-      branch.name
-    }\` head should be [reset](https://git-scm.com/docs/git-reset) to a previous commit so the commit with tag \`${
-      nextRelease.gitTag
-    }\` is removed from the branch history.
+The branch \`${name}\` head should be [reset](https://git-scm.com/docs/git-reset) to a previous commit so the commit with tag \`${gitTag}\` is removed from the branch history.
 
 See the [workflow configuration documentation](${linkify('docs/usage/workflow-configuration.md')}) for more details.`,
   }),

lib/get-releases-to-add.js

@@ -34,7 +34,7 @@ module.exports = context => {
               ({channel, version}) =>
                 channel === higherBranch.channel &&
                 channel !== branch.channel &&
-                (branch.type !== 'maintenance' || semver.gte(version, getLowerBound(branch['merge-range'])))
+                (branch.type !== 'maintenance' || semver.gte(version, getLowerBound(branch.mergeRange)))
             )
           )
             // Find ones that are not released on the building branch channel

lib/verify.js

@@ -3,7 +3,12 @@ const AggregateError = require('aggregate-error');
 const {isGitRepo, verifyTagName} = require('./git');
 const getError = require('./get-error');
 
-module.exports = async ({cwd, env, options: {repositoryUrl, tagFormat, branches}}) => {
+module.exports = async context => {
+  const {
+    cwd,
+    env,
+    options: {repositoryUrl, tagFormat, branches},
+  } = context;
   const errors = [];
 
   if (!(await isGitRepo({cwd, env}))) {
@@ -14,14 +19,14 @@ module.exports = async ({cwd, env, options: {repositoryUrl, tagFormat, branches}
 
   // Verify that compiling the `tagFormat` produce a valid Git tag
   if (!(await verifyTagName(template(tagFormat)({version: '0.0.0'})))) {
-    errors.push(getError('EINVALIDTAGFORMAT', {tagFormat}));
+    errors.push(getError('EINVALIDTAGFORMAT', context));
   }
 
   // Verify the `tagFormat` contains the variable `version` by compiling the `tagFormat` template
   // with a space as the `version` value and verify the result contains the space.
   // The space is used as it's an invalid tag character, so it's guaranteed to no be present in the `tagFormat`.
   if ((template(tagFormat)({version: ' '}).match(/ /g) || []).length !== 1) {
-    errors.push(getError('ETAGNOVERSION', {tagFormat}));
+    errors.push(getError('ETAGNOVERSION', context));
   }
 
   branches.forEach(branch => {