WIP convert to import

Author: gr2m

index.js

@@ -1,11 +1,12 @@
 /* eslint require-atomic-updates: off */
 
-const {defaultTo, castArray} = require('lodash');
-const verifyGitHub = require('./lib/verify');
-const addChannelGitHub = require('./lib/add-channel');
-const publishGitHub = require('./lib/publish');
-const successGitHub = require('./lib/success');
-const failGitHub = require('./lib/fail');
+import {defaultTo, castArray} from 'lodash';
+
+import verifyGitHub from './lib/verify';
+import addChannelGitHub from './lib/add-channel';
+import publishGitHub from './lib/publish';
+import successGitHub from './lib/success';
+import failGitHub from './lib/fail';
 
 let verified;
 
@@ -64,4 +65,4 @@ async function fail(pluginConfig, context) {
   await failGitHub(pluginConfig, context);
 }
 
-module.exports = {verifyConditions, addChannel, publish, success, fail};
+export default {verifyConditions, addChannel, publish, success, fail};

lib/add-channel.js

@@ -1,11 +1,13 @@
-const debug = require('debug')('semantic-release:github');
-const {RELEASE_NAME} = require('./definitions/constants');
-const parseGithubUrl = require('./parse-github-url');
-const resolveConfig = require('./resolve-config');
-const getClient = require('./get-client');
-const isPrerelease = require('./is-prerelease');
-
-module.exports = async (pluginConfig, context) => {
+import debugFactory from 'debug';
+import {RELEASE_NAME} from './definitions/constants';
+import parseGithubUrl from './parse-github-url';
+import resolveConfig from './resolve-config';
+import getClient from './get-client';
+import isPrerelease from './is-prerelease';
+
+const debug = debugFactory('semantic-release:github');
+
+export default async (pluginConfig, context) => {
   const {
     options: {repositoryUrl},
     branch,

lib/definitions/constants.js

@@ -2,4 +2,4 @@ const ISSUE_ID = '<!-- semantic-release:github -->';
 
 const RELEASE_NAME = 'GitHub release';
 
-module.exports = {ISSUE_ID, RELEASE_NAME};
+export default {ISSUE_ID, RELEASE_NAME};

lib/definitions/errors.js

@@ -1,84 +1,115 @@
-const {inspect} = require('util');
-const {isString} = require('lodash');
-const pkg = require('../../package.json');
+import {inspect} from 'node:util';
+
+import {isString} from 'lodash';
+
+const HOMEPAGE = 'https://github.com/semantic-release/github#readme';
 
-const [homepage] = pkg.homepage.split('#');
 const stringify = (object) =>
   isString(object) ? object : inspect(object, {breakLength: Infinity, depth: 2, maxArrayLength: 5});
-const linkify = (file) => `${homepage}/blob/master/${file}`;
+const linkify = (file) => `${HOMEPAGE}/blob/master/${file}`;
 
-module.exports = {
-  EINVALIDASSETS: ({assets}) => ({
+export function EINVALIDASSETS({assets}) {
+  return {
     message: 'Invalid `assets` option.',
     details: `The [assets option](${linkify(
       'README.md#assets'
     )}) must be an \`Array\` of \`Strings\` or \`Objects\` with a \`path\` property.
 
 Your configuration for the \`assets\` option is \`${stringify(assets)}\`.`,
-  }),
-  EINVALIDSUCCESSCOMMENT: ({successComment}) => ({
+  };
+}
+
+export function EINVALIDSUCCESSCOMMENT({successComment}) {
+  return {
     message: 'Invalid `successComment` option.',
     details: `The [successComment option](${linkify(
       'README.md#successcomment'
     )}) if defined, must be a non empty \`String\`.
 
 Your configuration for the \`successComment\` option is \`${stringify(successComment)}\`.`,
-  }),
-  EINVALIDFAILTITLE: ({failTitle}) => ({
+  };
+}
+
+export function EINVALIDFAILTITLE({failTitle}) {
+  return {
     message: 'Invalid `failTitle` option.',
     details: `The [failTitle option](${linkify('README.md#failtitle')}) if defined, must be a non empty \`String\`.
 
 Your configuration for the \`failTitle\` option is \`${stringify(failTitle)}\`.`,
-  }),
-  EINVALIDFAILCOMMENT: ({failComment}) => ({
+  };
+}
+
+export function EINVALIDFAILCOMMENT({failComment}) {
+  return {
     message: 'Invalid `failComment` option.',
     details: `The [failComment option](${linkify('README.md#failcomment')}) if defined, must be a non empty \`String\`.
 
 Your configuration for the \`failComment\` option is \`${stringify(failComment)}\`.`,
-  }),
-  EINVALIDLABELS: ({labels}) => ({
+  };
+}
+
+export function EINVALIDLABELS({labels}) {
+  return {
     message: 'Invalid `labels` option.',
     details: `The [labels option](${linkify(
       'README.md#options'
     )}) if defined, must be an \`Array\` of non empty \`String\`.
 
 Your configuration for the \`labels\` option is \`${stringify(labels)}\`.`,
-  }),
-  EINVALIDASSIGNEES: ({assignees}) => ({
+  };
+}
+
+export function EINVALIDASSIGNEES({assignees}) {
+  return {
     message: 'Invalid `assignees` option.',
     details: `The [assignees option](${linkify('README.md#options')}) must be an \`Array\` of non empty \`Strings\`.
 
 Your configuration for the \`assignees\` option is \`${stringify(assignees)}\`.`,
-  }),
-  EINVALIDRELEASEDLABELS: ({releasedLabels}) => ({
+  };
+}
+
+export function EINVALIDRELEASEDLABELS({releasedLabels}) {
+  return {
     message: 'Invalid `releasedLabels` option.',
     details: `The [releasedLabels option](${linkify(
       'README.md#options'
     )}) if defined, must be an \`Array\` of non empty \`String\`.
 
 Your configuration for the \`releasedLabels\` option is \`${stringify(releasedLabels)}\`.`,
-  }),
-  EINVALIDADDRELEASES: ({addReleases}) => ({
+  };
+}
+
+export function EINVALIDADDRELEASES({addReleases}) {
+  return {
     message: 'Invalid `addReleases` option.',
     details: `The [addReleases option](${linkify('README.md#options')}) if defined, must be one of \`false|top|bottom\`.
 
 Your configuration for the \`addReleases\` option is \`${stringify(addReleases)}\`.`,
-  }),
-  EINVALIDGITHUBURL: () => ({
+  };
+}
+
+export function EINVALIDGITHUBURL() {
+  return {
     message: 'The git repository URL is not a valid GitHub URL.',
     details: `The **semantic-release** \`repositoryUrl\` option must a valid GitHub URL with the format \`<GitHub_or_GHE_URL>/<owner>/<repo>.git\`.
 
 By default the \`repositoryUrl\` option is retrieved from the \`repository\` property of your \`package.json\` or the [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) of the repository cloned by your CI environment.`,
-  }),
-  EINVALIDPROXY: ({proxy}) => ({
+  };
+}
+
+export function EINVALIDPROXY({proxy}) {
+  return {
     message: 'Invalid `proxy` option.',
     details: `The [proxy option](${linkify(
       'README.md#proxy'
     )}) must be a \`String\`  or an \`Objects\` with a \`host\` and a \`port\` property.
 
 Your configuration for the \`proxy\` option is \`${stringify(proxy)}\`.`,
-  }),
-  EMISSINGREPO: ({owner, repo}) => ({
+  };
+}
+
+export function EMISSINGREPO({owner, repo}) {
+  return {
     message: `The repository ${owner}/${repo} doesn't exist.`,
     details: `The **semantic-release** \`repositoryUrl\` option must refer to your GitHub repository. The repository must be accessible with the [GitHub API](https://developer.github.com/v3).
 
@@ -87,29 +118,38 @@ By default the \`repositoryUrl\` option is retrieved from the \`repository\` pro
 If you are using [GitHub Enterprise](https://enterprise.github.com) please make sure to configure the \`githubUrl\` and \`githubApiPathPrefix\` [options](${linkify(
       'README.md#options'
     )}).`,
-  }),
-  EGHNOPERMISSION: ({owner, repo}) => ({
+  };
+}
+
+export function EGHNOPERMISSION({owner, repo}) {
+  return {
     message: `The GitHub token doesn't allow to push on the repository ${owner}/${repo}.`,
     details: `The user associated with the [GitHub token](${linkify(
       'README.md#github-authentication'
     )}) configured in the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable must allows to push to the repository ${owner}/${repo}.
 
 Please make sure the GitHub user associated with the token is an [owner](https://help.github.com/articles/permission-levels-for-a-user-account-repository/#owner-access-on-a-repository-owned-by-a-user-account) or a [collaborator](https://help.github.com/articles/permission-levels-for-a-user-account-repository/#collaborator-access-on-a-repository-owned-by-a-user-account) if the reposotory belong to a user account or has [write permissions](https://help.github.com/articles/managing-team-access-to-an-organization-repository) if the repository [belongs to an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization).`,
-  }),
-  EINVALIDGHTOKEN: ({owner, repo}) => ({
+  };
+}
+
+export function EINVALIDGHTOKEN({owner, repo}) {
+  return {
     message: 'Invalid GitHub token.',
     details: `The [GitHub token](${linkify(
       'README.md#github-authentication'
     )}) configured in the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable must be a valid [personal token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) allowing to push to the repository ${owner}/${repo}.
 
 Please make sure to set the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable in your CI with the exact value of the GitHub personal token.`,
-  }),
-  ENOGHTOKEN: ({owner, repo}) => ({
+  };
+}
+
+export function ENOGHTOKEN({owner, repo}) {
+  return {
     message: 'No GitHub token specified.',
     details: `A [GitHub personal token](${linkify(
       'README.md#github-authentication'
     )}) must be created and set in the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable on your CI environment.
 
 Please make sure to create a [GitHub personal token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) and to set it in the \`GH_TOKEN\` or \`GITHUB_TOKEN\` environment variable on your CI environment. The token must allow to push to the repository ${owner}/${repo}.`,
-  }),
-};
+  };
+}

lib/definitions/rate-limit.js

@@ -24,4 +24,4 @@ const RATE_LIMITS = {
  */
 const GLOBAL_RATE_LIMIT = 1000;
 
-module.exports = {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT};
+export default {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT};

lib/fail.js

@@ -1,13 +1,15 @@
-const {template} = require('lodash');
-const debug = require('debug')('semantic-release:github');
-const parseGithubUrl = require('./parse-github-url');
-const {ISSUE_ID} = require('./definitions/constants');
-const resolveConfig = require('./resolve-config');
-const getClient = require('./get-client');
-const findSRIssues = require('./find-sr-issues');
-const getFailComment = require('./get-fail-comment');
+import {template} from 'lodash';
+import debugFactory from 'debug';
+import parseGithubUrl from './parse-github-url';
+import {ISSUE_ID} from './definitions/constants';
+import resolveConfig from './resolve-config';
+import getClient from './get-client';
+import findSRIssues from './find-sr-issues';
+import getFailComment from './get-fail-comment';
 
-module.exports = async (pluginConfig, context) => {
+const debug = debugFactory('semantic-release:github');
+
+export default async (pluginConfig, context) => {
   const {
     options: {repositoryUrl},
     branch,

lib/find-sr-issues.js

@@ -1,6 +1,6 @@
-const {ISSUE_ID} = require('./definitions/constants');
+import {ISSUE_ID} from './definitions/constants';
 
-module.exports = async (github, title, owner, repo) => {
+export default async (github, title, owner, repo) => {
   const {
     data: {items: issues},
   } = await github.search.issuesAndPullRequests({

lib/get-client.js

@@ -1,12 +1,12 @@
-const {memoize, get} = require('lodash');
-const {Octokit} = require('@octokit/rest');
-const pRetry = require('p-retry');
-const Bottleneck = require('bottleneck');
-const urljoin = require('url-join');
-const HttpProxyAgent = require('http-proxy-agent');
-const HttpsProxyAgent = require('https-proxy-agent');
+import {memoize, get} from 'lodash';
+import {Octokit} from '@octokit/rest';
+import pRetry, {AbortError} from 'p-retry';
+import Bottleneck from 'bottleneck';
+import urljoin from 'url-join';
+import HttpProxyAgent from 'http-proxy-agent';
+import HttpsProxyAgent from 'https-proxy-agent';
 
-const {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT} = require('./definitions/rate-limit');
+import {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT} from './definitions/rate-limit';
 
 /**
  * Http error status for which to not retry.
@@ -26,7 +26,7 @@ const getThrottler = memoize((rate, globalThrottler) =>
   new Bottleneck({minTime: get(RATE_LIMITS, rate)}).chain(globalThrottler)
 );
 
-module.exports = ({githubToken, githubUrl, githubApiPathPrefix, proxy}) => {
+export default ({githubToken, githubUrl, githubApiPathPrefix, proxy}) => {
   const baseUrl = githubUrl && urljoin(githubUrl, githubApiPathPrefix);
   const globalThrottler = new Bottleneck({minTime: GLOBAL_RATE_LIMIT});
   const github = new Octokit({
@@ -51,7 +51,7 @@ module.exports = ({githubToken, githubUrl, githubApiPathPrefix, proxy}) => {
         return await getThrottler(limitKey, globalThrottler).wrap(request)(options);
       } catch (error) {
         if (SKIP_RETRY_CODES.has(error.status)) {
-          throw new pRetry.AbortError(error);
+          throw new AbortError(error);
         }
 
         throw error;

lib/get-error.js

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

lib/get-fail-comment.js

@@ -15,7 +15,7 @@ ${
   }`
 }`;
 
-module.exports = (branch, errors) => `## :rotating_light: The automated release from the \`${
+export default (branch, errors) => `## :rotating_light: The automated release from the \`${
   branch.name
 }\` branch failed. :rotating_light: