fix(commit-convention): exported the commit-convention functionality through the public api

Author: travi

.eslintrc.yml

@@ -3,9 +3,3 @@ extends:
   - '@form8ion'
   - '@form8ion/cucumber'
   - '@form8ion/mocha'
-
-rules:
-  no-restricted-exports:
-    - error
-    - restrictedNamedExports:
-      - then

src/commit-convention/index.js

@@ -6,7 +6,7 @@ import {assert} from 'chai';
 
 import * as commitizenScaffolder from './commitizen';
 import * as commitlintScaffolder from './commitlint';
-import scaffoldCommitConvention from './index';
+import scaffoldCommitConvention from './scaffolder';
 
 suite('commit-convention scaffolder', () => {
   let sandbox;

src/commit-convention/scaffolder.js

@@ -1,3 +1,45 @@
-export default function () {
-  return undefined;
+import deepmerge from 'deepmerge';
+import {projectTypes} from '@form8ion/javascript-core';
+
+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'
+        }
+      }
+    }
+  } : {};
+
+  if (pathWithinParent) return detailsForProjectsPublishedToARegistry;
+
+  const [commitizenResults, commitlintResults] = await Promise.all([
+    scaffoldCommitizen({projectRoot}),
+    configs.commitlint && scaffoldCommitlint({projectRoot, config: configs.commitlint})
+  ]);
+
+  return deepmerge.all([
+    commitizenResults,
+    ...commitlintResults ? [commitlintResults] : [],
+    {
+      vcsIgnore: {files: [], directories: []},
+      badges: {
+        contribution: {
+          'commit-convention': {
+            img: 'https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg',
+            text: 'Conventional Commits',
+            link: 'https://conventionalcommits.org'
+          }
+        }
+      }
+    },
+    detailsForProjectsPublishedToARegistry
+  ]);
 }

src/commit-convention/commitizen-test.js renamed to src/commitizen-test.js

@@ -16,5 +16,5 @@ When('the project is scaffolded', async function () {
     node_modules: stubbedNodeModules
   });
 
-  await scaffold({projectRoot: process.cwd()});
+  await scaffold({projectRoot: process.cwd(), configs: {}});
 });