Use mem-fs-editor fromBasePath (#1517)

* bump mem-fs-editor to v11.0.1 * handle mem-fs-editor fromBasePath * bump node in integration.yml
yeoman · May 24, 2024 · 520c16d · 520c16d
1 parent 4387297
commit 520c16d
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 35 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -19,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [18.x]
+        node-version: [18.17.x]
 
     steps:
       - uses: actions/checkout@v4

diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -19,7 +19,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node-version: [16.x]
+        node-version: [18.17.x]
 
     steps:
       - name: Checkout yeoman-test

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -61,7 +61,7 @@
     "json-schema": "^0.4.0",
     "latest-version": "^7.0.0",
     "lodash-es": "^4.17.21",
-    "mem-fs-editor": "^11.0.0",
+    "mem-fs-editor": "^11.0.1",
     "minimist": "^1.2.8",
     "read-package-up": "^11.0.0",
     "semver": "^7.5.4",

diff --git a/src/actions/fs.ts b/src/actions/fs.ts
@@ -81,10 +81,10 @@ export class FsMixin {
     this: BaseGenerator,
     ...args: OverloadParameters<MemFsEditor['copy']>
   ): OverloadReturnType<MemFsEditor['copy']> {
+    const [from, to, options = {}, ...remaining] = args;
+    options.fromBasePath = options.fromBasePath ?? this.templatePath();
     // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
-    return this.fs.copy(
-      ...applyToFirstAndSecondStringArg(this.templatePath.bind(this), this.destinationPath.bind(this), args),
-    );
+    return this.fs.copy(from, this.destinationPath(to), options, ...remaining);
   }
 
   /**
@@ -175,10 +175,10 @@ export class FsMixin {
     this: BaseGenerator,
     ...args: OverloadParameters<MemFsEditor['copy']>
   ): OverloadReturnType<MemFsEditor['copy']> {
+    const [from, to, options = {}, ...remaining] = args;
+    options.fromBasePath = options.fromBasePath ?? this.destinationPath();
     // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
-    return this.fs.copy(
-      ...applyToFirstAndSecondStringArg(this.destinationPath.bind(this), this.destinationPath.bind(this), args),
-    );
+    return this.fs.copy(from, this.destinationPath(to), options, ...remaining);
   }
 
   /**
@@ -190,10 +190,10 @@ export class FsMixin {
     this: BaseGenerator,
     ...args: OverloadParameters<MemFsEditor['move']>
   ): OverloadReturnType<MemFsEditor['move']> {
+    const [from, to, options = {}, ...remaining] = args;
+    options.fromBasePath = options.fromBasePath ?? this.destinationPath();
     // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
-    return this.fs.move(
-      ...applyToFirstAndSecondStringArg(this.destinationPath.bind(this), this.destinationPath.bind(this), args),
-    );
+    return this.fs.move(from, this.destinationPath(to), options, ...remaining);
   }
 
   /**

diff --git a/test/fs.test.ts b/test/fs.test.ts
@@ -21,8 +21,9 @@ const ARG_COPYSETTINGS = 4;
 
 type FSOpResult = {
   name: string;
-  first: string;
+  first?: string;
   second?: string;
+  fromBasePath?: string;
   dest: string;
   returnsUndefined?: boolean;
 };
@@ -32,8 +33,8 @@ testResults = testResults.concat([
   { name: 'readTemplate', first: 'templatePath', dest: 'read' },
   {
     name: 'copyTemplate',
-    first: 'templatePath',
     second: 'destinationPath',
+    fromBasePath: 'templatePath',
     dest: 'copy',
   },
   {
@@ -52,14 +53,14 @@ testResults = testResults.concat([
   { name: 'deleteDestination', first: 'destinationPath', dest: 'delete' },
   {
     name: 'copyDestination',
-    first: 'destinationPath',
     second: 'destinationPath',
+    fromBasePath: 'destinationPath',
     dest: 'copy',
   },
   {
     name: 'moveDestination',
-    first: 'destinationPath',
     second: 'destinationPath',
+    fromBasePath: 'destinationPath',
     dest: 'move',
   },
   { name: 'existsDestination', first: 'destinationPath', dest: 'exists' },
@@ -137,21 +138,21 @@ describe('generators.Base (actions/fs)', () => {
   for (const operation of testResults) {
     const passedArg1 = randomString();
     const passedArg2 = randomString();
-    const passedArg3 = {};
+    const passedArg3: any = {};
     const passedArg4 = { foo: 'bar' };
 
     // eslint-disable-next-line @typescript-eslint/no-loop-func
     describe(`#${operation.name}`, () => {
       let returnValue: any;
       let expectedReturn: string | undefined;
-      let firstArgumentHandler: SinonStub;
+      let firstArgumentHandler: SinonStub | undefined;
       let secondArgumentHandler: SinonStub;
 
       beforeEach(async function () {
         returnValue = await this.base[operation.name](passedArg1, passedArg2, passedArg3, passedArg4);
 
         expectedReturn = operation.returnsUndefined ? undefined : returns[operation.dest];
-        firstArgumentHandler = this.base[operation.first];
+        firstArgumentHandler = operation.first ? this.base[operation.first] : undefined;
         if (operation.second !== undefined && operation.second !== null) {
           secondArgumentHandler = this.base[operation.second];
         }
@@ -166,7 +167,9 @@ describe('generators.Base (actions/fs)', () => {
       });
 
       it('handles the first parameter', () => {
-        assert.equal(firstArgumentHandler.getCall(0).args[0], passedArg1);
+        if (firstArgumentHandler) {
+          assert.equal(firstArgumentHandler.getCall(0).args[0], passedArg1);
+        }
       });
 
       it('handles the second parameter', () => {
@@ -175,8 +178,10 @@ describe('generators.Base (actions/fs)', () => {
           assert.equal(secondArgumentHandler.getCall(1).args[0], passedArg2);
         } else if (operation.second) {
           assert(secondArgumentHandler.calledOnce);
-          assert(firstArgumentHandler.calledOnce);
           assert.equal(secondArgumentHandler.getCall(0).args[0], passedArg2);
+          if (firstArgumentHandler) {
+            assert(firstArgumentHandler.calledOnce);
+          }
         }
       });
 
@@ -185,7 +190,7 @@ describe('generators.Base (actions/fs)', () => {
         assert(destCall.calledOnce);
         const call = destCall.getCall(0);
         // First argument should be the trated first arguments
-        assert.equal(call.args[0], baseReturns[operation.first]);
+        assert.equal(call.args[0], operation.first ? baseReturns[operation.first] : passedArg1);
 
         // Second argument should be the trated first arguments
         if (operation.second) {
@@ -196,6 +201,9 @@ describe('generators.Base (actions/fs)', () => {
 
         assert.equal(call.args[2], passedArg3);
         assert.equal(call.args[3].foo, passedArg4.foo);
+        if (operation.fromBasePath) {
+          assert.equal(call.args[2].fromBasePath, baseReturns[operation.fromBasePath]);
+        }
       });
     });
   }