refactor(semantic-release): extracted the scaffolding functionality to follow the plugin pattern

Author: travi

package-lock.json

@@ -58,6 +58,7 @@
     "@form8ion/eslint-config-mocha": "1.2.12",
     "@form8ion/remark-lint-preset": "2.1.6",
     "@rollup/plugin-babel": "5.3.0",
+    "@rollup/plugin-node-resolve": "13.1.1",
     "@travi/any": "2.0.19",
     "babel-plugin-istanbul": "6.1.1",
     "ban-sensitive-files": "1.9.16",

package.json

@@ -1,8 +1,9 @@
 import autoExternal from 'rollup-plugin-auto-external';
+import nodeResolve from '@rollup/plugin-node-resolve';
 
 export default {
   input: 'src/index.js',
-  plugins: [autoExternal()],
+  plugins: [autoExternal(), nodeResolve({mainFields: ['module']})],
   output: [
     {file: 'lib/index.cjs.js', format: 'cjs', sourcemap: true},
     {file: 'lib/index.es.js', format: 'es', sourcemap: true}

rollup.config.js

@@ -1,9 +1,11 @@
+import deepmerge from 'deepmerge';
 import {projectTypes} from '@form8ion/javascript-core';
 
 import sinon from 'sinon';
 import any from '@travi/any';
 import {assert} from 'chai';
 
+import * as semanticReleaseScaffolder from './semantic-release/scaffolder';
 import * as commitizenScaffolder from './commitizen';
 import * as commitlintScaffolder from './commitlint';
 import scaffoldCommitConvention from './scaffolder';
@@ -12,31 +14,26 @@ suite('commit-convention scaffolder', () => {
   let sandbox;
   const projectRoot = any.string();
   const packageManager = any.word();
-  const commitizenScripts = any.simpleObject();
-  const commitizenDevDependencies = any.listOf(any.string);
   const publishedProjectType = any.fromList([projectTypes.PACKAGE, projectTypes.CLI]);
-  const contributionBadges = {
-    'commit-convention': {
-      img: 'https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg',
-      text: 'Conventional Commits',
-      link: 'https://conventionalcommits.org'
-    }
-  };
-  const semanticReleaseBadge = {
-    img: 'https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release',
-    text: 'semantic-release: angular',
-    link: 'https://github.com/semantic-release/semantic-release'
+  const mergedResults = any.simpleObject();
+  const commitizenResults = any.simpleObject();
+  const semanticReleaseResults = any.simpleObject();
+  const conventionalCommitsBadge = {
+    img: 'https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg',
+    text: 'Conventional Commits',
+    link: 'https://conventionalcommits.org'
   };
 
   setup(() => {
     sandbox = sinon.createSandbox();
 
+    sandbox.stub(deepmerge, 'all');
     sandbox.stub(commitlintScaffolder, 'default');
     sandbox.stub(commitizenScaffolder, 'default');
+    sandbox.stub(semanticReleaseScaffolder, 'default');
 
-    commitizenScaffolder.default
-      .withArgs({projectRoot})
-      .resolves({devDependencies: commitizenDevDependencies, scripts: commitizenScripts});
+    commitizenScaffolder.default.withArgs({projectRoot}).resolves(commitizenResults);
+    semanticReleaseScaffolder.default.returns(semanticReleaseResults);
   });
 
   teardown(() => sandbox.restore());
@@ -51,53 +48,66 @@ suite('commit-convention scaffolder', () => {
         pathWithinParent: any.string(),
         projectType: publishedProjectType
       }),
-      {
-        packageProperties: {version: '0.0.0-semantically-released'},
-        badges: {contribution: {'semantic-release': semanticReleaseBadge}}
-      }
+      semanticReleaseResults
     );
   });
 
   test('that the convention is configured', async () => {
     const commitlintConfig = any.simpleObject();
-    const commitlintDevDependencies = any.listOf(any.string);
-    commitlintScaffolder.default
-      .withArgs({projectRoot, config: commitlintConfig})
-      .resolves({devDependencies: commitlintDevDependencies});
+    const commitlintResults = any.simpleObject();
+    commitlintScaffolder.default.withArgs({projectRoot, config: commitlintConfig}).resolves(commitlintResults);
+    deepmerge.all
+      .withArgs([
+        commitizenResults,
+        commitlintResults,
+        {
+          vcsIgnore: {files: [], directories: []},
+          badges: {contribution: {'commit-convention': conventionalCommitsBadge}}
+        },
+        {}
+      ])
+      .returns(mergedResults);
 
-    assert.deepEqual(
+    assert.equal(
       await scaffoldCommitConvention({projectRoot, packageManager, configs: {commitlint: commitlintConfig}}),
-      {
-        devDependencies: [...commitizenDevDependencies, ...commitlintDevDependencies],
-        scripts: commitizenScripts,
-        vcsIgnore: {files: [], directories: []},
-        badges: {contribution: contributionBadges}
-      }
+      mergedResults
     );
   });
 
   test('that commitlint is not configured if no config is provided', async () => {
+    deepmerge.all
+      .withArgs([
+        commitizenResults,
+        {
+          vcsIgnore: {files: [], directories: []},
+          badges: {contribution: {'commit-convention': conventionalCommitsBadge}}
+        },
+        {}
+      ])
+      .returns(mergedResults);
+
     assert.deepEqual(
       await scaffoldCommitConvention({projectRoot, configs: {}, packageManager}),
-      {
-        devDependencies: commitizenDevDependencies,
-        scripts: commitizenScripts,
-        vcsIgnore: {files: [], directories: []},
-        badges: {contribution: contributionBadges}
-      }
+      mergedResults
     );
     assert.notCalled(commitlintScaffolder.default);
   });
 
   test('that semantic-release is configured for packages', async () => {
-    const {badges, packageProperties} = await scaffoldCommitConvention({
-      projectRoot,
-      projectType: publishedProjectType,
-      configs: {},
-      packageManager
-    });
+    deepmerge.all
+      .withArgs([
+        commitizenResults,
+        {
+          vcsIgnore: {files: [], directories: []},
+          badges: {contribution: {'commit-convention': conventionalCommitsBadge}}
+        },
+        semanticReleaseResults
+      ])
+      .returns(mergedResults);
 
-    assert.equal(packageProperties.version, '0.0.0-semantically-released');
-    assert.deepEqual(badges.contribution['semantic-release'], semanticReleaseBadge);
+    assert.deepEqual(
+      await scaffoldCommitConvention({projectRoot, projectType: publishedProjectType, configs: {}, packageManager}),
+      mergedResults
+    );
   });
 });

src/scaffolder-test.js

@@ -1,22 +1,14 @@
 import deepmerge from 'deepmerge';
 import {projectTypes} from '@form8ion/javascript-core';
 
+import {scaffold as scaffoldSemanticRelease} from './semantic-release';
 import scaffoldCommitizen from './commitizen';
 import scaffoldCommitlint from './commitlint';
 
 export default async function ({projectRoot, projectType, configs, pathWithinParent}) {
-  const detailsForProjectsPublishedToARegistry = [projectTypes.PACKAGE, projectTypes.CLI].includes(projectType) ? {
-    packageProperties: {version: '0.0.0-semantically-released'},
-    badges: {
-      contribution: {
-        'semantic-release': {
-          img: 'https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release',
-          text: 'semantic-release: angular',
-          link: 'https://github.com/semantic-release/semantic-release'
-        }
-      }
-    }
-  } : {};
+  const detailsForProjectsPublishedToARegistry = [projectTypes.PACKAGE, projectTypes.CLI].includes(projectType)
+    ? scaffoldSemanticRelease()
+    : {};
 
   if (pathWithinParent) return detailsForProjectsPublishedToARegistry;
 

src/scaffolder.js

@@ -0,0 +1 @@
+export {default as scaffold} from './scaffolder';

src/semantic-release/index.js

@@ -0,0 +1,23 @@
+import {assert} from 'chai';
+
+import scaffoldSemanticRelease from './scaffolder';
+
+suite('semantic-release scaffolder', () => {
+  test('that that the badge and version string are generated', async () => {
+    assert.deepEqual(
+      await scaffoldSemanticRelease(),
+      {
+        packageProperties: {version: '0.0.0-semantically-released'},
+        badges: {
+          contribution: {
+            'semantic-release': {
+              img: 'https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release',
+              text: 'semantic-release: angular',
+              link: 'https://github.com/semantic-release/semantic-release'
+            }
+          }
+        }
+      }
+    );
+  });
+});

src/semantic-release/scaffolder-test.js

@@ -0,0 +1,14 @@
+export default function () {
+  return {
+    packageProperties: {version: '0.0.0-semantically-released'},
+    badges: {
+      contribution: {
+        'semantic-release': {
+          img: 'https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release',
+          text: 'semantic-release: angular',
+          link: 'https://github.com/semantic-release/semantic-release'
+        }
+      }
+    }
+  };
+}