refactor(configuration): extract scaffolding to the config plugin

Author: travi

src/configuration/index.js

@@ -1,2 +1,3 @@
-export {default as remove} from './remover.js';
+export {default as scaffold} from './scaffolder.js';
 export {default as test} from './tester.js';
+export {default as remove} from './remover.js';

src/configuration/scaffolder-test.js

@@ -0,0 +1,31 @@
+import {fileTypes} from '@form8ion/core';
+
+import * as td from 'testdouble';
+import any from '@travi/any';
+import {assert} from 'chai';
+
+suite('configuration scaffolder', () => {
+  let scaffoldConfig, configFile;
+
+  setup(async () => {
+    configFile = await td.replaceEsm('@form8ion/config-file');
+
+    ({default: scaffoldConfig} = (await import('./scaffolder.js')));
+  });
+
+  teardown(() => td.reset());
+  test('that the configuration file is created', async () => {
+    const projectRoot = any.string();
+
+    assert.deepEqual(await scaffoldConfig({projectRoot}), {});
+
+    td.verify(
+      configFile.write({
+        format: fileTypes.JSON,
+        path: projectRoot,
+        name: 'mocha',
+        config: {ui: 'tdd', require: ['@babel/register', './test/mocha-setup.js']}
+      })
+    );
+  });
+});

src/configuration/scaffolder.js

@@ -0,0 +1,13 @@
+import {write} from '@form8ion/config-file';
+import {fileTypes} from '@form8ion/core';
+
+export default async function ({projectRoot}) {
+  await write({
+    format: fileTypes.JSON,
+    path: projectRoot,
+    name: 'mocha',
+    config: {ui: 'tdd', require: ['@babel/register', './test/mocha-setup.js']}
+  });
+
+  return {};
+}

src/scaffolder-test.js

@@ -1,6 +1,5 @@
 import path from 'node:path';
 import filedirname from 'filedirname';
-import {fileTypes} from '@form8ion/core';
 
 import {assert} from 'chai';
 import any from '@travi/any';
@@ -9,13 +8,13 @@ import * as td from 'testdouble';
 const [, __dirname] = filedirname();
 
 suite('mocha scaffolder', () => {
-  let mkdir, configFile, fs, scaffoldMocha;
+  let mkdir, config, fs, scaffoldMocha;
   const projectRoot = any.string();
 
   setup(async () => {
     mkdir = await td.replaceEsm('../thirdparty-wrappers/make-dir.js');
-    configFile = await td.replaceEsm('@form8ion/config-file');
     fs = await td.replaceEsm('node:fs');
+    config = await td.replaceEsm('./configuration/index.js');
 
     ({default: scaffoldMocha} = (await import('./scaffolder.js')));
   });
@@ -39,14 +38,7 @@ suite('mocha scaffolder', () => {
         nextSteps: [{summary: 'Remove the canary test for mocha once more valuable tests exist'}]
       }
     );
-    td.verify(
-      configFile.write({
-        format: fileTypes.JSON,
-        path: projectRoot,
-        name: 'mocha',
-        config: {ui: 'tdd', require: ['@babel/register', './test/mocha-setup.js']}
-      })
-    );
+    td.verify(config.scaffold({projectRoot}));
     td.verify(
       fs.promises.copyFile(
         path.resolve(__dirname, '..', 'templates', 'mocha-setup.txt'),

src/scaffolder.js

@@ -1,11 +1,11 @@
 import {promises as fs} from 'node:fs';
 import path from 'node:path';
 import filedirname from 'filedirname';
-import {fileTypes} from '@form8ion/core';
-import {write} from '@form8ion/config-file';
 
 import mkdir from '../thirdparty-wrappers/make-dir.js';
 
+import {scaffold as scaffoldConfig} from './configuration/index.js';
+
 const [, __dirname] = filedirname();
 
 export default async function ({projectRoot}) {
@@ -17,12 +17,7 @@ export default async function ({projectRoot}) {
 
   await Promise.all([
     fs.copyFile(path.resolve(__dirname, '..', 'templates', 'canary-test.txt'), `${createdSrcDirectory}/canary-test.js`),
-    write({
-      format: fileTypes.JSON,
-      path: projectRoot,
-      name: 'mocha',
-      config: {ui: 'tdd', require: ['@babel/register', './test/mocha-setup.js']}
-    }),
+    scaffoldConfig({projectRoot}),
     fs.copyFile(path.resolve(__dirname, '..', 'templates', 'mocha-setup.txt'), `${createdTestDirectory}/mocha-setup.js`)
   ]);