style: xo

Author: gr2m

index.js

@@ -2,11 +2,11 @@
 
 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';
+import verifyGitHub from './lib/verify.js';
+import addChannelGitHub from './lib/add-channel.js';
+import publishGitHub from './lib/publish.js';
+import successGitHub from './lib/success.js';
+import failGitHub from './lib/fail.js';
 
 let verified;
 
@@ -65,4 +65,6 @@ async function fail(pluginConfig, context) {
   await failGitHub(pluginConfig, context);
 }
 
-export default {verifyConditions, addChannel, publish, success, fail};
+const plugin = {verifyConditions, addChannel, publish, success, fail};
+
+export default plugin;

lib/add-channel.js

@@ -1,13 +1,14 @@
 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';
+
+import {RELEASE_NAME} from './definitions/constants.js';
+import parseGithubUrl from './parse-github-url.js';
+import resolveConfig from './resolve-config.js';
+import getClient from './get-client.js';
+import isPrerelease from './is-prerelease.js';
 
 const debug = debugFactory('semantic-release:github');
 
-export default async (pluginConfig, context) => {
+export default async function addChannel(pluginConfig, context) {
   const {
     options: {repositoryUrl},
     branch,
@@ -51,4 +52,4 @@ export default async (pluginConfig, context) => {
   logger.log('Updated GitHub release: %s', url);
 
   return {url, name: RELEASE_NAME};
-};
+}

lib/definitions/constants.js

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

lib/definitions/errors.js

@@ -5,7 +5,7 @@ import {isString} from 'lodash';
 const HOMEPAGE = 'https://github.com/semantic-release/github#readme';
 
 const stringify = (object) =>
-  isString(object) ? object : inspect(object, {breakLength: Infinity, depth: 2, maxArrayLength: 5});
+  isString(object) ? object : inspect(object, {breakLength: Number.POSITIVE_INFINITY, depth: 2, maxArrayLength: 5});
 const linkify = (file) => `${HOMEPAGE}/blob/master/${file}`;
 
 export function EINVALIDASSETS({assets}) {

lib/definitions/rate-limit.js

@@ -24,4 +24,6 @@ const RATE_LIMITS = {
  */
 const GLOBAL_RATE_LIMIT = 1000;
 
-export default {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT};
+const RATE_LIMIT = {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT};
+
+export default RATE_LIMIT;

lib/fail.js

@@ -1,15 +1,16 @@
 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';
+
+import parseGithubUrl from './parse-github-url.js';
+import {ISSUE_ID} from './definitions/constants.js';
+import resolveConfig from './resolve-config.js';
+import getClient from './get-client.js';
+import findSRIssues from './find-sr-issues.js';
+import getFailComment from './get-fail-comment.js';
 
 const debug = debugFactory('semantic-release:github');
 
-export default async (pluginConfig, context) => {
+export default async function fail(pluginConfig, context) {
   const {
     options: {repositoryUrl},
     branch,
@@ -39,12 +40,19 @@ export default async (pluginConfig, context) => {
       } = await github.issues.createComment(comment);
       logger.log('Added comment to issue #%d: %s.', srIssue.number, url);
     } else {
-      const newIssue = {owner, repo, title: failTitle, body: `${body}\n\n${ISSUE_ID}`, labels: labels || [], assignees};
+      const newIssue = {
+        owner,
+        repo,
+        title: failTitle,
+        body: `${body}\n\n${ISSUE_ID}`,
+        labels: labels || [],
+        assignees,
+      };
       debug('create issue: %O', newIssue);
       const {
         data: {html_url: url, number},
       } = await github.issues.create(newIssue);
       logger.log('Created issue #%d: %s.', number, url);
     }
   }
-};
+}

lib/find-sr-issues.js

@@ -1,11 +1,11 @@
-import {ISSUE_ID} from './definitions/constants';
+import {ISSUE_ID} from './definitions/constants.js';
 
-export default async (github, title, owner, repo) => {
+export default async function findIssues(github, title, owner, repo) {
   const {
     data: {items: issues},
   } = await github.search.issuesAndPullRequests({
     q: `in:title+repo:${owner}/${repo}+type:issue+state:open+${title}`,
   });
 
   return issues.filter((issue) => issue.body && issue.body.includes(ISSUE_ID));
-};
+}

lib/get-client.js

@@ -6,7 +6,7 @@ import urljoin from 'url-join';
 import HttpProxyAgent from 'http-proxy-agent';
 import HttpsProxyAgent from 'https-proxy-agent';
 
-import {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT} from './definitions/rate-limit';
+import {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT} from './definitions/rate-limit.js';
 
 /**
  * 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)
 );
 
-export default ({githubToken, githubUrl, githubApiPathPrefix, proxy}) => {
+export default function getClient({githubToken, githubUrl, githubApiPathPrefix, proxy}) {
   const baseUrl = githubUrl && urljoin(githubUrl, githubApiPathPrefix);
   const globalThrottler = new Bottleneck({minTime: GLOBAL_RATE_LIMIT});
   const github = new Octokit({
@@ -60,4 +60,4 @@ export default ({githubToken, githubUrl, githubApiPathPrefix, proxy}) => {
   });
 
   return github;
-};
+}

lib/get-error.js

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

lib/get-fail-comment.js

@@ -15,9 +15,8 @@ ${
   }`
 }`;
 
-export default (branch, errors) => `## :rotating_light: The automated release from the \`${
-  branch.name
-}\` branch failed. :rotating_light:
+export default function getFailComment(branch, errors) {
+  return `## :rotating_light: The automated release from the \`${branch.name}\` branch failed. :rotating_light:
 
 I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.
 
@@ -26,8 +25,8 @@ You can find below the list of errors reported by **semantic-release**. Each one
 Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.
 
 Once all the errors are resolved, **semantic-release** will release your package the next time you push a commit to the \`${
-  branch.name
-}\` branch. You can also manually restart the failed CI job that runs **semantic-release**.
+    branch.name
+  }\` branch. You can also manually restart the failed CI job that runs **semantic-release**.
 
 If you are not sure how to resolve this, here are some links that can help you:
 - [Usage documentation](${USAGE_DOC_URL})
@@ -45,3 +44,4 @@ ${errors.map((error) => formatError(error)).join('\n\n---\n\n')}
 Good luck with your project ✨
 
 Your **[semantic-release](${HOME_URL})** bot :package::rocket:`;
+}

lib/get-release-links.js

@@ -1,4 +1,4 @@
-import {RELEASE_NAME} from './definitions/constants';
+import {RELEASE_NAME} from './definitions/constants.js';
 
 const linkify = (releaseInfo) =>
   `${
@@ -12,11 +12,12 @@ const linkify = (releaseInfo) =>
 const filterReleases = (releaseInfos) =>
   releaseInfos.filter((releaseInfo) => releaseInfo.name && releaseInfo.name !== RELEASE_NAME);
 
-export default (releaseInfos) =>
-  `${
+export default function getReleaseLinks(releaseInfos) {
+  return `${
     filterReleases(releaseInfos).length > 0
       ? `This release is also available on:\n${filterReleases(releaseInfos)
           .map((releaseInfo) => `- ${linkify(releaseInfo)}`)
           .join('\n')}`
       : ''
   }`;
+}

lib/get-search-queries.js

@@ -1,4 +1,4 @@
-export default (base, commits, separator = '+') => {
+export default function getSearchQueries(base, commits, separator = '+') {
   return commits.reduce((searches, commit) => {
     const lastSearch = searches[searches.length - 1];
 
@@ -10,4 +10,4 @@ export default (base, commits, separator = '+') => {
 
     return searches;
   }, []);
-};
+}

lib/get-success-comment.js

@@ -2,8 +2,8 @@ const HOME_URL = 'https://github.com/semantic-release/semantic-release';
 const linkify = (releaseInfo) =>
   `${releaseInfo.url ? `[${releaseInfo.name}](${releaseInfo.url})` : `\`${releaseInfo.name}\``}`;
 
-export default (issue, releaseInfos, nextRelease) =>
-  `:tada: This ${issue.pull_request ? 'PR is included' : 'issue has been resolved'} in version ${
+export default function getSuccessComment(issue, releaseInfos, nextRelease) {
+  return `:tada: This ${issue.pull_request ? 'PR is included' : 'issue has been resolved'} in version ${
     nextRelease.version
   } :tada:${
     releaseInfos.length > 0
@@ -16,3 +16,4 @@ export default (issue, releaseInfos, nextRelease) =>
   }
 
 Your **[semantic-release](${HOME_URL})** bot :package::rocket:`;
+}

lib/glob-assets.js

@@ -7,62 +7,63 @@ import debugFactory from 'debug';
 
 const debug = debugFactory('semantic-release:github');
 
-export default async ({cwd}, assets) =>
-  uniqWith(
-    []
-      .concat(
-        ...(await Promise.all(
-          assets.map(async (asset) => {
-            // Wrap single glob definition in Array
-            let glob = castArray(isPlainObject(asset) ? asset.path : asset);
-            // TODO Temporary workaround for https://github.com/mrmlnc/fast-glob/issues/47
-            glob = uniq([...(await dirGlob(glob, {cwd})), ...glob]);
+export default async function globAssets({cwd}, assets) {
+  return uniqWith(
+    (
+      await Promise.all(
+        assets.map(async (asset) => {
+          // Wrap single glob definition in Array
+          let glob = castArray(isPlainObject(asset) ? asset.path : asset);
+          // TODO Temporary workaround for https://github.com/mrmlnc/fast-glob/issues/47
+          glob = uniq([...(await dirGlob(glob, {cwd})), ...glob]);
 
-            // Skip solo negated pattern (avoid to include every non js file with `!**/*.js`)
-            if (glob.length <= 1 && glob[0].startsWith('!')) {
-              debug(
-                'skipping the negated glob %o as its alone in its group and would retrieve a large amount of files',
-                glob[0]
-              );
-              return [];
-            }
-
-            const globbed = await globby(glob, {
-              cwd,
-              expandDirectories: false, // TODO Temporary workaround for https://github.com/mrmlnc/fast-glob/issues/47
-              gitignore: false,
-              dot: true,
-              onlyFiles: false,
-            });
+          // Skip solo negated pattern (avoid to include every non js file with `!**/*.js`)
+          if (glob.length <= 1 && glob[0].startsWith('!')) {
+            debug(
+              'skipping the negated glob %o as its alone in its group and would retrieve a large amount of files',
+              glob[0]
+            );
+            return [];
+          }
 
-            if (isPlainObject(asset)) {
-              if (globbed.length > 1) {
-                // If asset is an Object with a glob the `path` property that resolve to multiple files,
-                // Output an Object definition for each file matched and set each one with:
-                // - `path` of the matched file
-                // - `name` based on the actual file name (to avoid assets with duplicate `name`)
-                // - other properties of the original asset definition
-                return globbed.map((file) => ({...asset, path: file, name: basename(file)}));
-              }
+          const globbed = await globby(glob, {
+            cwd,
+            expandDirectories: false, // TODO Temporary workaround for https://github.com/mrmlnc/fast-glob/issues/47
+            gitignore: false,
+            dot: true,
+            onlyFiles: false,
+          });
 
-              // If asset is an Object, output an Object definition with:
-              // - `path` of the matched file if there is one, or the original `path` definition (will be considered as a missing file)
+          if (isPlainObject(asset)) {
+            if (globbed.length > 1) {
+              // If asset is an Object with a glob the `path` property that resolve to multiple files,
+              // Output an Object definition for each file matched and set each one with:
+              // - `path` of the matched file
+              // - `name` based on the actual file name (to avoid assets with duplicate `name`)
               // - other properties of the original asset definition
-              return {...asset, path: globbed[0] || asset.path};
+              return globbed.map((file) => ({...asset, path: file, name: basename(file)}));
             }
 
-            if (globbed.length > 0) {
-              // If asset is a String definition, output each files matched
-              return globbed;
-            }
+            // If asset is an Object, output an Object definition with:
+            // - `path` of the matched file if there is one, or the original `path` definition (will be considered as a missing file)
+            // - other properties of the original asset definition
+            return {...asset, path: globbed[0] || asset.path};
+          }
+
+          if (globbed.length > 0) {
+            // If asset is a String definition, output each files matched
+            return globbed;
+          }
 
-            // If asset is a String definition but no match is found, output the elements of the original glob (each one will be considered as a missing file)
-            return glob;
-          })
-          // Sort with Object first, to prioritize Object definition over Strings in dedup
-        ))
+          // If asset is a String definition but no match is found, output the elements of the original glob (each one will be considered as a missing file)
+          return glob;
+        })
+        // Sort with Object first, to prioritize Object definition over Strings in dedup
       )
+    )
+      .flat()
       .sort((asset) => (isPlainObject(asset) ? -1 : 1)),
     // Compare `path` property if Object definition, value itself if String
     (a, b) => resolve(cwd, isPlainObject(a) ? a.path : a) === resolve(cwd, isPlainObject(b) ? b.path : b)
   );
+}

lib/is-prerelease.js

@@ -1 +1,3 @@
-export default ({type, main}) => type === 'prerelease' || (type === 'release' && !main);
+export default function isPrerelease({type, main}) {
+  return type === 'prerelease' || (type === 'release' && !main);
+}

lib/parse-github-url.js

@@ -1,4 +1,4 @@
-export default (repositoryUrl) => {
+export default function parseGitHubUrl(repositoryUrl) {
   const [match, auth, host, path] = /^(?!.+:\/\/)(?:(?<auth>.*)@)?(?<host>.*?):(?<path>.*)$/.exec(repositoryUrl) || [];
   try {
     const [, owner, repo] = /^\/(?<owner>[^/]+)?\/?(?<repo>.+?)(?:\.git)?$/.exec(
@@ -8,4 +8,4 @@ export default (repositoryUrl) => {
   } catch {
     return {};
   }
-};
+}