feat(dependencies): remove dependencies defined under dependencies.javascript.remove

Author: travi

src/coverage/lifter.js

@@ -8,13 +8,14 @@ export async function lift({projectRoot, packageManager, vcs}) {
   const codecovResults = await liftCodecov({projectRoot, packageManager, vcs});
 
   if (await nycIsConfigured({projectRoot})) {
-    const [c8Results] = await Promise.all([
+    const [c8Results, nycResults] = await Promise.all([
       scaffoldC8({projectRoot}),
-      removeNyc({projectRoot, packageManager})
+      removeNyc({projectRoot})
     ]);
 
     return deepmerge.all([
       c8Results,
+      nycResults,
       codecovResults,
       {
         scripts: {'test:unit': 'cross-env NODE_ENV=test c8 run-s test:unit:base'},

src/coverage/lifter.test.js

@@ -1,7 +1,7 @@
 import deepmerge from 'deepmerge';
 import {lift as liftCodecov} from '@form8ion/codecov';
 
-import {describe, vi, it, expect, afterEach} from 'vitest';
+import {describe, expect, it, vi} from 'vitest';
 import any from '@travi/any';
 import {when} from 'jest-when';
 
@@ -23,17 +23,16 @@ describe('coverage lifter', () => {
   const codecovResults = any.simpleObject();
   const packageManager = any.word();
 
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-
   it('should replace `nyc` with `c8` if nyc config exists', async () => {
+    const nycResults = any.simpleObject();
     const mergedResults = any.simpleObject();
     when(scaffoldC8).calledWith({projectRoot}).mockResolvedValue(c8Results);
     when(testForNyc).calledWith({projectRoot}).mockResolvedValue(true);
+    when(removeNyc).calledWith({projectRoot}).mockResolvedValue(nycResults);
     when(liftCodecov).calledWith({projectRoot, packageManager, vcs}).mockResolvedValue(codecovResults);
     when(deepmerge.all).calledWith([
       c8Results,
+      nycResults,
       codecovResults,
       {
         scripts: {'test:unit': 'cross-env NODE_ENV=test c8 run-s test:unit:base'},
@@ -45,8 +44,6 @@ describe('coverage lifter', () => {
     ]).mockReturnValue(mergedResults);
 
     expect(await lift({projectRoot, packageManager, vcs})).toEqual(mergedResults);
-
-    expect(removeNyc).toHaveBeenCalledWith({projectRoot, packageManager});
   });
 
   it('should not replace `nyc` with `c8` if nyc config does not exist', async () => {

src/coverage/nyc/remover.js

@@ -1,11 +1,16 @@
-import {promises as fs} from 'fs';
+import {promises as fs} from 'node:fs';
 
-import removeDependencies from '../../dependencies/remover.js';
-
-export default async function ({projectRoot, packageManager}) {
+export default async function ({projectRoot}) {
   await Promise.all([
     fs.unlink(`${projectRoot}/.nycrc`),
-    fs.rm(`${projectRoot}/.nyc_output`, {recursive: true, force: true}),
-    removeDependencies({packageManager, dependencies: ['nyc', '@istanbuljs/nyc-config-babel', 'babel-plugin-istanbul']})
+    fs.rm(`${projectRoot}/.nyc_output`, {recursive: true, force: true})
   ]);
+
+  return {
+    dependencies: {
+      javascript: {
+        remove: ['nyc', '@istanbuljs/nyc-config-babel', 'babel-plugin-istanbul']
+      }
+    }
+  };
 }

src/coverage/nyc/remover.test.js

@@ -3,11 +3,9 @@ import {promises as fs} from 'node:fs';
 import {describe, it, expect, vi, afterEach} from 'vitest';
 import any from '@travi/any';
 
-import removeDependencies from '../../dependencies/remover.js';
 import removeNyc from './remover.js';
 
 vi.mock('node:fs');
-vi.mock('../../dependencies/remover.js');
 
 describe('nyc remover', () => {
   afterEach(() => {
@@ -16,15 +14,11 @@ describe('nyc remover', () => {
 
   it('should remove configuration and dependencies', async () => {
     const projectRoot = any.string();
-    const packageManager = any.word();
 
-    await removeNyc({projectRoot, packageManager});
+    const {dependencies} = await removeNyc({projectRoot});
 
     expect(fs.unlink).toHaveBeenCalledWith(`${projectRoot}/.nycrc`);
     expect(fs.rm).toHaveBeenCalledWith(`${projectRoot}/.nyc_output`, {recursive: true, force: true});
-    expect(removeDependencies).toHaveBeenCalledWith({
-      packageManager,
-      dependencies: ['nyc', '@istanbuljs/nyc-config-babel', 'babel-plugin-istanbul']
-    });
+    expect(dependencies.javascript.remove).toEqual(['nyc', '@istanbuljs/nyc-config-babel', 'babel-plugin-istanbul']);
   });
 });

src/dependencies/processor.js

@@ -2,6 +2,7 @@ import {error, info} from '@travi/cli-messages';
 import {DEV_DEPENDENCY_TYPE, PROD_DEPENDENCY_TYPE} from '@form8ion/javascript-core';
 
 import install from './installer.js';
+import remove from './remover.js';
 
 export default async function ({dependencies = {}, devDependencies, projectRoot, packageManager}) {
   info('Processing dependencies');
@@ -16,11 +17,12 @@ export default async function ({dependencies = {}, devDependencies, projectRoot,
     throw new Error(`Expected dependencies to be an object. Instead received: ${dependencies}`);
   }
 
-  const {javascript: {production = [], development = []} = {}} = dependencies;
+  const {javascript: {production = [], development = [], remove: dependenciesToRemove = []} = {}} = dependencies;
 
   try {
     await install(production, PROD_DEPENDENCY_TYPE, projectRoot, packageManager);
     await install(development, DEV_DEPENDENCY_TYPE, projectRoot, packageManager);
+    await remove({packageManager, dependencies: dependenciesToRemove});
   } catch (e) {
     error('Failed to update dependencies');
     error(e, {level: 'secondary'});

src/dependencies/processor.test.js

@@ -4,9 +4,11 @@ import {describe, it, expect, vi} from 'vitest';
 import any from '@travi/any';
 
 import installDependencies from './installer.js';
+import removeDependencies from './remover.js';
 import processDependencies from './processor.js';
 
 vi.mock('./installer.js');
+vi.mock('./remover.js');
 
 describe('dependencies processor', () => {
   const projectRoot = any.string();
@@ -15,11 +17,17 @@ describe('dependencies processor', () => {
   it('should process the provided dependency lists', async () => {
     const production = any.listOf(any.word);
     const development = any.listOf(any.word);
+    const remove = any.listOf(any.word);
 
-    await processDependencies({dependencies: {javascript: {production, development}}, projectRoot, packageManager});
+    await processDependencies({
+      dependencies: {javascript: {production, development, remove}},
+      projectRoot,
+      packageManager
+    });
 
     expect(installDependencies).toHaveBeenCalledWith(production, PROD_DEPENDENCY_TYPE, projectRoot, packageManager);
     expect(installDependencies).toHaveBeenCalledWith(development, DEV_DEPENDENCY_TYPE, projectRoot, packageManager);
+    expect(removeDependencies).toHaveBeenCalledWith({packageManager, dependencies: remove});
   });
 
   it('should process as empty lists when dependencies are not provided', async () => {
@@ -41,6 +49,7 @@ describe('dependencies processor', () => {
 
     expect(installDependencies).toHaveBeenCalledWith([], PROD_DEPENDENCY_TYPE, projectRoot, packageManager);
     expect(installDependencies).toHaveBeenCalledWith([], DEV_DEPENDENCY_TYPE, projectRoot, packageManager);
+    expect(removeDependencies).toHaveBeenCalledWith({packageManager, dependencies: []});
   });
 
   it('should prevent an installation error from bubbling', async () => {