feat(lift): enabled passing in external enhancers to the lifter

Author: travi

.remarkrc.js

@@ -1,6 +1,6 @@
 // https://github.com/remarkjs/remark/tree/master/packages/remark-stringify#options
 exports.settings = {
-  listItemIndent: 1,
+  listItemIndent: "one",
   emphasis: '_',
   strong: '_',
   bullet: '*',
@@ -11,4 +11,4 @@ exports.plugins = [
   '@form8ion/remark-lint-preset',
   ['remark-toc', {tight: true}],
   ['remark-usage', {heading: 'example'}]
-];
+];

README.md

@@ -103,6 +103,12 @@ const {
         scripts: {},
         eslint: {configs: [], ignore: {directories: []}},
         packageManager: 'npm'
+      },
+      enhancers: {
+        PluginName: {
+          test: () => true,
+          lift: () => ({})
+        }
       }
     });
   }

example.js

@@ -71,6 +71,12 @@ const {
         scripts: {},
         eslint: {configs: [], ignore: {directories: []}},
         packageManager: 'npm'
+      },
+      enhancers: {
+        PluginName: {
+          test: () => true,
+          lift: () => ({})
+        }
       }
     });
   }

src/lift/lift.js

@@ -15,7 +15,7 @@ import {lift as liftPackage} from '../package/index.js';
 import * as packageManagers from '../package-managers/index.js';
 import {determineCurrent as resolvePackageManager} from '../package-managers/index.js';
 
-export default async function ({projectRoot, vcs, results, pathWithinParent}) {
+export default async function ({projectRoot, vcs, results, pathWithinParent, enhancers = {}}) {
   info('Lifting JavaScript-specific details');
 
   const {
@@ -33,7 +33,8 @@ export default async function ({projectRoot, vcs, results, pathWithinParent}) {
 
   const enhancerResults = await applyEnhancers({
     results,
-    enhancers: [
+    enhancers: {
+      ...enhancers,
       huskyPlugin,
       enginesEnhancer,
       coveragePlugin,
@@ -43,7 +44,7 @@ export default async function ({projectRoot, vcs, results, pathWithinParent}) {
       npmConfigPlugin,
       projectTypes,
       packageManagers
-    ],
+    },
     options: {packageManager, projectRoot, vcs, packageDetails: JSON.parse(packageContents)}
   });
 

src/lift/lift.test.js

@@ -4,7 +4,7 @@ import * as core from '@form8ion/core';
 import * as huskyPlugin from '@form8ion/husky';
 import * as commitConventionPlugin from '@form8ion/commit-convention';
 
-import {afterEach, describe, expect, it, vi} from 'vitest';
+import {afterEach, beforeEach, describe, expect, it, vi} from 'vitest';
 import any from '@travi/any';
 import {when} from 'jest-when';
 
@@ -14,14 +14,14 @@ import * as npmConfigPlugin from '../npm-config/index.js';
 import * as enginesEnhancer from './enhancers/engines.js';
 import * as projectTypes from '../project-type/index.js';
 import * as dialects from '../dialects/index.js';
-import * as packageLifter from '../package/lifter.js';
+import liftPackage from '../package/lifter.js';
 import * as packageManagers from '../package-managers/index.js';
 import {determineCurrent as packageManagerResolver} from '../package-managers/index.js';
 import lift from './lift.js';
 
 vi.mock('node:fs');
 vi.mock('@form8ion/core');
-vi.mock('../package/lifter');
+vi.mock('../package/lifter.js');
 vi.mock('../package-managers/index.js');
 
 describe('lift', () => {
@@ -35,42 +35,63 @@ describe('lift', () => {
   const enhancerResults = any.simpleObject();
   const vcsDetails = any.simpleObject();
   const results = {...any.simpleObject(), scripts, tags, dependencies, devDependencies, packageManager: manager};
+  const pathWithinParent = any.string();
+  const packageDetails = any.simpleObject();
+  const internalEnhancers = {
+    huskyPlugin,
+    enginesEnhancer,
+    coveragePlugin,
+    commitConventionPlugin,
+    dialects,
+    codeStylePlugin,
+    npmConfigPlugin,
+    projectTypes,
+    packageManagers
+  };
 
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it('should lift results that are specific to js projects', async () => {
-    const packageDetails = any.simpleObject();
-    const pathWithinParent = any.string();
+  beforeEach(() => {
     when(packageManagerResolver)
       .calledWith({projectRoot, packageManager: manager})
       .mockResolvedValue(packageManager);
     when(fs.readFile)
       .calledWith(`${projectRoot}/package.json`, 'utf8')
       .mockResolvedValue(JSON.stringify(packageDetails));
-    when(core.applyEnhancers).calledWith({
-      results,
-      enhancers: [
-        huskyPlugin,
-        enginesEnhancer,
-        coveragePlugin,
-        commitConventionPlugin,
-        dialects,
-        codeStylePlugin,
-        npmConfigPlugin,
-        projectTypes,
-        packageManagers
-      ],
-      options: {projectRoot, packageManager, vcs: vcsDetails, packageDetails}
-    }).mockResolvedValue(enhancerResults);
+  });
+
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('should lift results that are specific to js projects', async () => {
+    when(core.applyEnhancers)
+      .calledWith({
+        results,
+        enhancers: internalEnhancers,
+        options: {projectRoot, packageManager, vcs: vcsDetails, packageDetails}
+      })
+      .mockResolvedValue(enhancerResults);
 
     const liftResults = await lift({projectRoot, vcs: vcsDetails, results, pathWithinParent});
 
     expect(liftResults).toEqual(enhancerResults);
-    expect(packageLifter.default).toHaveBeenCalledWith(deepmerge.all([
+    expect(liftPackage).toHaveBeenCalledWith(deepmerge.all([
       {projectRoot, scripts, tags, dependencies, devDependencies, packageManager, vcs: vcsDetails, pathWithinParent},
       enhancerResults
     ]));
   });
+
+  it('should apply provided enhancers', async () => {
+    const enhancers = any.simpleObject();
+    when(core.applyEnhancers)
+      .calledWith({
+        results,
+        enhancers: {...enhancers, ...internalEnhancers},
+        options: {projectRoot, packageManager, vcs: vcsDetails, packageDetails}
+      })
+      .mockResolvedValue(enhancerResults);
+
+    const liftResults = await lift({projectRoot, vcs: vcsDetails, results, pathWithinParent, enhancers});
+
+    expect(liftResults).toEqual(enhancerResults);
+  });
 });