feat(remove): remove the mocha setup file when removing mocha from a project

Author: travi

src/remover-test.js

@@ -4,12 +4,13 @@ import * as td from 'testdouble';
 import any from '@travi/any';
 
 suite('mocha remover', () => {
-  let remove, canaryExists, removeCanary, configExists, removeConfig;
+  let remove, canaryExists, removeCanary, configExists, removeConfig, setupExists, removeSetup;
   const projectRoot = any.string();
 
   setup(async () => {
     ({remove: removeCanary, test: canaryExists} = await td.replaceEsm('./canary/index.js'));
     ({remove: removeConfig, test: configExists} = await td.replaceEsm('./configuration/index.js'));
+    ({remove: removeSetup, test: setupExists} = await td.replaceEsm('./setup/index.js'));
 
     ({default: remove} = (await import('./remover.js')));
   });
@@ -19,11 +20,13 @@ suite('mocha remover', () => {
   test('that mocha details are removed from the project', async () => {
     td.when(canaryExists({projectRoot})).thenResolve(true);
     td.when(configExists({projectRoot})).thenResolve(true);
+    td.when(setupExists({projectRoot})).thenResolve(true);
 
     const {dependencies} = await remove({projectRoot});
 
     td.verify(removeCanary({projectRoot}));
     td.verify(removeConfig({projectRoot}));
+    td.verify(removeSetup({projectRoot}));
     assert.deepEqual(dependencies.javascript.remove, ['mocha', 'chai', 'sinon']);
   });
 
@@ -42,4 +45,12 @@ suite('mocha remover', () => {
 
     td.verify(removeConfig({projectRoot}), {times: 0});
   });
+
+  test('that removing the setup file is not attempted if it does not exist', async () => {
+    td.when(setupExists({projectRoot})).thenResolve(false);
+
+    await remove({projectRoot});
+
+    td.verify(removeSetup({projectRoot}), {times: 0});
+  });
 });

src/remover.js

@@ -1,5 +1,6 @@
 import {test as canaryExists, remove as removeCanary} from './canary/index.js';
 import {test as configExists, remove as removeConfig} from './configuration/index.js';
+import {test as setupExists, remove as removeSetup} from './setup/index.js';
 
 export default async function ({projectRoot}) {
   if (await canaryExists({projectRoot})) {
@@ -10,5 +11,9 @@ export default async function ({projectRoot}) {
     await removeConfig({projectRoot});
   }
 
+  if (await setupExists({projectRoot})) {
+    await removeSetup({projectRoot});
+  }
+
   return {dependencies: {javascript: {remove: ['mocha', 'chai', 'sinon']}}};
 }

src/setup/index.js

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

src/setup/remover-test.js

@@ -0,0 +1,22 @@
+import * as td from 'testdouble';
+import any from '@travi/any';
+
+suite('mocha setup remover', () => {
+  let remove, fs;
+
+  setup(async () => {
+    fs = await td.replaceEsm('node:fs');
+
+    ({default: remove} = (await import('./remover.js')));
+  });
+
+  teardown(() => td.reset());
+
+  test('that the canary test is removed', async () => {
+    const projectRoot = any.simpleObject();
+
+    await remove({projectRoot});
+
+    td.verify(fs.promises.unlink(`${projectRoot}/test/mocha-setup.js`));
+  });
+});

src/setup/remover.js

@@ -0,0 +1,5 @@
+import {promises as fs} from 'node:fs';
+
+export default async function ({projectRoot}) {
+  await fs.unlink(`${projectRoot}/test/mocha-setup.js`);
+}

src/setup/tester-test.js

@@ -0,0 +1,28 @@
+import * as td from 'testdouble';
+import {assert} from 'chai';
+import any from '@travi/any';
+
+suite('canary predicate', () => {
+  let canaryExists, core;
+  const projectRoot = any.string();
+
+  setup(async () => {
+    core = await td.replaceEsm('@form8ion/core');
+
+    ({default: canaryExists} = (await import('./tester.js')));
+  });
+
+  teardown(() => td.reset());
+
+  test('that `false` is returned if the canary test does not exist', async () => {
+    td.when(core.fileExists(`${projectRoot}/test/mocha-setup.js`)).thenResolve(false);
+
+    assert.isFalse(await canaryExists({projectRoot}));
+  });
+
+  test('that `true` is returned if the canary test does not exist', async () => {
+    td.when(core.fileExists(`${projectRoot}/test/mocha-setup.js`)).thenResolve(true);
+
+    assert.isTrue(await canaryExists({projectRoot}));
+  });
+});

src/setup/tester.js

@@ -0,0 +1,5 @@
+import {fileExists} from '@form8ion/core';
+
+export default function ({projectRoot}) {
+  return fileExists(`${projectRoot}/test/mocha-setup.js`);
+}

test/integration/features/step_definitions/configuration-steps.js

@@ -21,5 +21,5 @@ Then('the testing framework is configured', async function () {
 
 Then('configuration files are removed', async function () {
   assert.isFalse(await fileExists(`${this.projectRoot}/.mocharc.json`));
-  // assert.isFalse(await fileExists(`${this.projectRoot}/test/mocha-setup.js`));
+  assert.isFalse(await fileExists(`${this.projectRoot}/test/mocha-setup.js`));
 });