convert packageManagerInstallTask to typescript

Author: mshima

src/environment.js

@@ -1,5 +1,5 @@
 import fs from 'node:fs';
-import path, { isAbsolute, join } from 'node:path';
+import path, { isAbsolute } from 'node:path';
 import EventEmitter from 'node:events';
 import { pathToFileURL } from 'node:url';
 import { createRequire } from 'node:module';
@@ -1261,7 +1261,7 @@ class Environment extends Base {
         return packageManagerInstallTask({
           adapter,
           memFs,
-          packageJsonFile: join(this.cwd, 'package.json'),
+          packageJsonLocation: this.cwd,
           skipInstall,
           nodePackageManager,
           customInstallTask,

src/package-manager.js src/package-manager.ts

@@ -1,10 +1,22 @@
-import path, { dirname } from 'node:path';
+import { dirname, join, resolve } from 'node:path';
 import createdLogger from 'debug';
 import preferredPm from 'preferred-pm';
 import { execa } from 'execa';
+import type { MemFsEditorFile } from 'mem-fs-editor';
+import { type InputOutputAdapter } from '@yeoman/types';
+import { type Store } from 'mem-fs';
 
 const debug = createdLogger('yeoman:environment:package-manager');
 
+export type PackageManagerInstallTaskOptions = {
+  memFs: Store<MemFsEditorFile>;
+  packageJsonLocation: string;
+  adapter: InputOutputAdapter;
+  nodePackageManager?: string;
+  customInstallTask?: (nodePackageManager: string | undefined, defaultTask: () => Promise<boolean>) => boolean | Promise<boolean>;
+  skipInstall?: boolean;
+};
+
 /**
  * Executes package manager install.
  * - checks if package.json was committed.
@@ -16,14 +28,22 @@ const debug = createdLogger('yeoman:environment:package-manager');
   packageJsonFile: join(this.cwd, 'package.json');
 
 */
-export async function packageManagerInstallTask({ memFs, packageJsonFile, customInstallTask, adapter, nodePackageManager, skipInstall }) {
+export async function packageManagerInstallTask({
+  memFs,
+  packageJsonLocation,
+  customInstallTask,
+  adapter,
+  nodePackageManager,
+  skipInstall,
+}: PackageManagerInstallTaskOptions) {
+  packageJsonLocation = resolve(packageJsonLocation);
   /**
    * @private
    * Get the destination package.json file.
    * @return {Vinyl | undefined} a Vinyl file.
    */
   function getDestinationPackageJson() {
-    return memFs.get(path.resolve(packageJsonFile));
+    return memFs.get(join(packageJsonLocation, 'package.json'));
   }
 
   /**
@@ -61,7 +81,7 @@ Changes to package.json were detected.`);
   }
 
   // eslint-disable-next-line unicorn/no-await-expression-member
-  let packageManagerName = nodePackageManager ?? (await preferredPm(dirname(packageJsonFile)))?.name;
+  let packageManagerName = nodePackageManager ?? (await preferredPm(packageJsonLocation))?.name;
 
   const execPackageManager = async () => {
     if (!packageManagerName) {
@@ -76,17 +96,12 @@ Changes to package.json were detected.`);
 
     adapter.log(`
 Running ${packageManagerName} install for you to install the required dependencies.`);
-    await execa(packageManagerName, ['install'], { stdio: 'inherit', cwd: dirname(packageJsonFile) });
+    await execa(packageManagerName, ['install'], { stdio: 'inherit', cwd: packageJsonLocation });
     return true;
   };
 
   if (customInstallTask) {
-    const result = customInstallTask(packageManagerName, execPackageManager);
-    if (!result || !result.then) {
-      return true;
-    }
-
-    return result;
+    return customInstallTask(packageManagerName, execPackageManager);
   }
 
   return execPackageManager();

test/generator-features.js

@@ -6,7 +6,7 @@ import Generator from 'yeoman-generator';
 import { esmocha, expect, mock } from 'esmocha';
 import helpers from './helpers.js';
 
-const { packageManagerInstallTask } = await mock('../src/package-manager.js');
+const { packageManagerInstallTask } = await mock('../src/package-manager.ts');
 const { default: Environment } = await import('../src/environment.js');
 
 const require = createRequire(import.meta.url);

test/package-manager.js

@@ -21,13 +21,13 @@ Running ${pm} install for you to install the required dependencies.`;
 describe('environment (package-manager)', () => {
   let adapter;
   let memFs;
-  let packageJsonFile;
+  let packageJsonLocation;
 
   beforeEach(() => {
     adapter = { log: esmocha.fn() };
     execa.mockReturnValue();
     memFs = { get: esmocha.fn() };
-    packageJsonFile = path.join(__dirname, 'fixtures', 'package-manager', 'npm', 'package.json');
+    packageJsonLocation = path.join(__dirname, 'fixtures', 'package-manager', 'npm');
     preferredPm.mockResolvedValue({ name: 'npm' });
   });
 
@@ -37,7 +37,7 @@ describe('environment (package-manager)', () => {
 
   describe('#packageManagerInstallTask()', () => {
     describe('without a package.json', async () => {
-      beforeEach(() => packageManagerInstallTask({ adapter, memFs, packageJsonFile }));
+      beforeEach(() => packageManagerInstallTask({ adapter, memFs, packageJsonLocation }));
 
       it('should not log', () => {
         expect(adapter.log).not.toBeCalled();
@@ -52,7 +52,7 @@ describe('environment (package-manager)', () => {
       describe('when package.json was not committed', () => {
         beforeEach(async () => {
           memFs.get.mockReturnValue({ committed: false });
-          await packageManagerInstallTask({ adapter, memFs, packageJsonFile });
+          await packageManagerInstallTask({ adapter, memFs, packageJsonLocation });
         });
 
         it('should log', () => {
@@ -76,7 +76,7 @@ No change to package.json was detected. No package manager install will be execu
 
         describe('with skipInstall', () => {
           beforeEach(async () => {
-            await packageManagerInstallTask({ adapter, memFs, packageJsonFile, skipInstall: true });
+            await packageManagerInstallTask({ adapter, memFs, packageJsonLocation, skipInstall: true });
           });
 
           it('should log', async () => {
@@ -92,7 +92,7 @@ No change to package.json was detected. No package manager install will be execu
 
         describe('with npm', () => {
           beforeEach(async () => {
-            await packageManagerInstallTask({ adapter, memFs, packageJsonFile });
+            await packageManagerInstallTask({ adapter, memFs, packageJsonLocation });
           });
 
           it('should log', async () => {
@@ -110,7 +110,7 @@ No change to package.json was detected. No package manager install will be execu
         describe('with yarn', () => {
           beforeEach(async () => {
             preferredPm.mockResolvedValue({ name: 'yarn' });
-            await packageManagerInstallTask({ adapter, memFs, packageJsonFile });
+            await packageManagerInstallTask({ adapter, memFs, packageJsonLocation });
           });
 
           it('should log', async () => {
@@ -128,7 +128,7 @@ No change to package.json was detected. No package manager install will be execu
         describe('with pnpm', () => {
           beforeEach(async () => {
             preferredPm.mockResolvedValue({ name: 'pnpm' });
-            await packageManagerInstallTask({ adapter, memFs, packageJsonFile });
+            await packageManagerInstallTask({ adapter, memFs, packageJsonLocation });
           });
 
           it('should log', async () => {
@@ -145,7 +145,7 @@ No change to package.json was detected. No package manager install will be execu
 
         describe('with an unsupported package manager', () => {
           beforeEach(async () => {
-            await packageManagerInstallTask({ adapter, memFs, packageJsonFile, nodePackageManager: 'foo' });
+            await packageManagerInstallTask({ adapter, memFs, packageJsonLocation, nodePackageManager: 'foo' });
           });
 
           it('should log', async () => {
@@ -162,7 +162,7 @@ No change to package.json was detected. No package manager install will be execu
         describe('error detecting package manager', () => {
           beforeEach(async () => {
             preferredPm.mockResolvedValue(null);
-            await packageManagerInstallTask({ adapter, memFs, packageJsonFile });
+            await packageManagerInstallTask({ adapter, memFs, packageJsonLocation });
           });
 
           it('should log', async () => {