feat: pkg-manager.factory improvements

Author: gearonixx

package.json

@@ -54,6 +54,7 @@
   "devDependencies": {
     "@antfu/ni": "^0.21.12",
     "@types/node": "^20.10.7",
+    "@types/which": "^3.0.3",
     "bumpp": "^9.2.1",
     "eslint": "^8.56.0",
     "esno": "^4.0.0",
@@ -80,8 +81,10 @@
     "@nestjs/common": "^10.3.3",
     "@nestjs/core": "^10.3.3",
     "@nestjs/platform-express": "^10.3.3",
+    "chalk": "^5.3.0",
     "eslint-kit": "^10.19.0",
     "execa": "^8.0.1",
-    "nest-commander": "^3.12.5"
+    "nest-commander": "^3.12.5",
+    "which": "^4.0.0"
   }
 }

pnpm-lock.yaml

@@ -18,15 +18,7 @@ export class InitCommand extends CommandRunner {
   }
 
   public async run(param: string[], options: AnyRecord) {
-    console.log({
-      param,
-      options,
-      manager: this.manager
-    })
-
-    // console.log(this.manager.agent)
     const workspaces = await this.manager.getWorkspaces()
-
     console.log(workspaces)
   }
 }

src/commands/init.command.ts

@@ -0,0 +1,39 @@
+import { parseJson } from '@neodx/fs'
+import { hasOwn, isObject, isTruthy } from '@neodx/std'
+import { execaCommand as $ } from 'execa'
+import { AbstractPackageManager } from '@/pkg-manager/managers/abstract.pkg-manager'
+import { PackageManager } from '@/pkg-manager/pkg-manager.consts'
+import type { WorkspaceProject } from '@/pkg-manager/pkg-manager.types'
+
+export class YarnBerryPackageManager extends AbstractPackageManager {
+  constructor() {
+    super(PackageManager.YARN_BERRY)
+  }
+
+  public async getWorkspaces(): Promise<WorkspaceProject[]> {
+    const cwd = process.cwd()
+
+    const output = await $('yarn workspaces list --json', {
+      cwd
+    })
+
+    const serializedLines = output.stdout.trim().split('\n')
+
+    const workspaces = await Promise.all(
+      serializedLines.map(async (serializedMeta) => {
+        const isWorkspaceProject = (val: unknown): val is WorkspaceProject =>
+          isObject(project) && hasOwn(project, 'location')
+
+        const project = await parseJson(serializedMeta)
+
+        if (isWorkspaceProject(project)) {
+          return project
+        }
+
+        return null
+      })
+    )
+
+    return workspaces.filter(isTruthy)
+  }
+}

src/pkg-manager/managers/yarn-berry.pkg-manager.ts

@@ -27,10 +27,6 @@ export class YarnPackageManager extends AbstractPackageManager {
       cwd
     })
 
-    console.log({
-      output: output.stdout
-    })
-
     const stdout = output.stdout
 
     const jsonStartIndex = stdout.indexOf('{')

src/pkg-manager/managers/yarn.pkg-manager.ts

@@ -10,29 +10,35 @@ export enum PackageManager {
   NPM = 'npm',
   YARN = 'yarn',
   PNPM = 'pnpm',
-  BUN = 'bun'
+  BUN = 'bun',
+  YARN_BERRY = 'yarn@berry'
 }
 
 interface PackageManagerMatcher {
   lockFile: string
+  name: PackageManager
   manager: new () => AbstractPackageManager
 }
 
-export const lockFileMatchers = [
+export const packageManagerMatchers = [
   {
     lockFile: 'package-lock.json',
+    name: PackageManager.NPM,
     manager: NpmPackageManager
   },
   {
     lockFile: 'yarn.lock',
+    name: PackageManager.YARN,
     manager: YarnPackageManager
   },
   {
     lockFile: 'pnpm-lock.yaml',
+    name: PackageManager.PNPM,
     manager: PnpmPackageManager
   },
   {
     lockFile: 'bun.lockb',
+    name: PackageManager.BUN,
     manager: BunPackageManager
   }
 ] satisfies PackageManagerMatcher[]

src/pkg-manager/pkg-manager.consts.ts

@@ -1,21 +1,83 @@
-import { readdir } from '@neodx/fs'
+import { cmdExists } from '@antfu/ni'
+import { ensureFile, scan } from '@neodx/fs'
+import { isTypeOfString, uniq, values } from '@neodx/std'
+import chalk from 'chalk'
+import { execaCommand as $ } from 'execa'
+import { basename, resolve } from 'node:path'
 import type { AbstractPackageManager } from '@/pkg-manager/managers/abstract.pkg-manager'
-import { lockFileMatchers } from '@/pkg-manager/pkg-manager.consts'
+import { YarnBerryPackageManager } from '@/pkg-manager/managers/yarn-berry.pkg-manager'
+import {
+  PackageManager,
+  packageManagerMatchers
+} from '@/pkg-manager/pkg-manager.consts'
+import type { PackageJson } from '@/shared/json'
+import { readJson } from '@/shared/json'
+import { addLibraryPrefix } from '@/shared/misc'
 
 export class PackageManagerFactory {
-  // TODO: extend
   public static async detect(): Promise<AbstractPackageManager> {
-    const files = await readdir(process.cwd())
+    let programmaticAgent: PackageManager
 
-    const match = lockFileMatchers.find((matcher) =>
-      files.includes(matcher.lockFile)
+    const agents = values(PackageManager)
+
+    const lockFilePatterns = await scan(
+      process.cwd(),
+      uniq(packageManagerMatchers.map(({ lockFile }) => lockFile))
     )
 
-    if (match) {
-      return new match.manager()
+    const lockPath = lockFilePatterns.shift() as string
+
+    const packageJsonPath = lockPath
+      ? resolve(lockPath, '../package.json')
+      : resolve(process.cwd(), 'package.json')
+
+    await ensureFile(lockPath)
+    await ensureFile(packageJsonPath)
+
+    const pkg = (await readJson(packageJsonPath)) as PackageJson
+
+    if (isTypeOfString(pkg.packageManager)) {
+      const [name, version] = pkg.packageManager.replace(/^\^/, '').split('@')
+      const agent = name as PackageManager
+
+      const isYarnBerry =
+        agent === PackageManager.YARN &&
+        version &&
+        Number.parseInt(version, 10) > 1
+
+      if (isYarnBerry) {
+        return new YarnBerryPackageManager()
+      }
+
+      if (agents.includes(agent)) {
+        programmaticAgent = agent
+      }
+    }
+
+    const match = packageManagerMatchers.find(
+      (matcher) =>
+        matcher.lockFile === basename(lockPath) ||
+        programmaticAgent === matcher.name
+    )
+
+    if (!match) {
+      throw new Error('Unable to detect a package manager.')
+    }
+
+    if (!cmdExists(match.name)) {
+      console.warn(addLibraryPrefix(`${match.name} is not installed.`))
+      console.info(
+        addLibraryPrefix(
+          `Attempting to install ${chalk.cyan(match.name)} globally...`
+        )
+      )
+
+      await $(`npm i -g ${match.name}`, {
+        stdio: 'inherit',
+        cwd: process.cwd()
+      })
     }
 
-    // TODO better errors
-    throw new Error('never')
+    return new match.manager()
   }
 }

src/pkg-manager/pkg-manager.factory.ts

@@ -9,6 +9,7 @@ export interface PackageJson {
   version: string
   type?: 'module' | 'commonjs'
   dependencies?: Record<string, string>
+  packageManager?: string
   peerDependencies?: Record<string, string>
   devDependencies?: Record<string, string>
   scripts?: Record<string, string>

src/shared/json.ts

@@ -0,0 +1,4 @@
+import chalk from 'chalk'
+
+export const addLibraryPrefix = (message: string) =>
+  `[${chalk.green('gx')}]: ${message}`

src/shared/misc.ts

@@ -0,0 +1,5 @@
+import which from 'which'
+
+export function cmdExists(cmd: string) {
+  return which.sync(cmd, { nothrow: true }) !== null
+}