Add almost vlt support

Author: jdalton

src/commands/optimize.ts

@@ -69,6 +69,10 @@ const getOverridesDataByAgent: Record<Agent, GetOverrides> = {
     const overrides = (pkgJson as any)?.pnpm?.overrides ?? {}
     return { type: 'pnpm', overrides }
   },
+  vlt(pkgJson: PackageJsonContent) {
+    const overrides = (pkgJson as any)?.overrides ?? {}
+    return { type: 'vlt', overrides }
+  },
   // Yarn resolutions documentation:
   // https://yarnpkg.com/configuration/manifest#resolutions
   'yarn/berry'(pkgJson: PackageJsonContent) {
@@ -117,6 +121,11 @@ const lockIncludesByAgent: Record<Agent, AgentLockIncludesFn> = (() => {
         'm'
       ).test(lockSrc)
     },
+    vlt(lockSrc: string, name: string) {
+      // Detects the package name in the following cases:
+      //   "name"
+      return lockSrc.includes(`"${name}"`)
+    },
     'yarn/berry': yarn,
     'yarn/classic': yarn
   }
@@ -127,36 +136,36 @@ type AgentModifyManifestFn = (
   overrides: Overrides
 ) => void
 
-const updateManifestByAgent: Record<Agent, AgentModifyManifestFn> = {
-  bun(pkgJson: EditablePackageJson, overrides: Overrides) {
-    pkgJson.update({
-      [RESOLUTIONS_FIELD_NAME]: <PnpmOrYarnOverrides>overrides
-    })
-  },
-  npm(pkgJson: EditablePackageJson, overrides: Overrides) {
+const updateManifestByAgent: Record<Agent, AgentModifyManifestFn> = (() => {
+  function updateOverrides(pkgJson: EditablePackageJson, overrides: Overrides) {
     pkgJson.update({
       [OVERRIDES_FIELD_NAME]: overrides
     })
-  },
-  pnpm(pkgJson: EditablePackageJson, overrides: Overrides) {
-    pkgJson.update({
-      pnpm: {
-        ...(<object>pkgJson.content['pnpm']),
-        [OVERRIDES_FIELD_NAME]: overrides
-      }
-    })
-  },
-  'yarn/berry'(pkgJson: EditablePackageJson, overrides: Overrides) {
-    pkgJson.update({
-      [RESOLUTIONS_FIELD_NAME]: <PnpmOrYarnOverrides>overrides
-    })
-  },
-  'yarn/classic'(pkgJson: EditablePackageJson, overrides: Overrides) {
+  }
+  function updateResolutions(
+    pkgJson: EditablePackageJson,
+    overrides: Overrides
+  ) {
     pkgJson.update({
       [RESOLUTIONS_FIELD_NAME]: <PnpmOrYarnOverrides>overrides
     })
   }
-}
+  return {
+    bun: updateResolutions,
+    npm: updateOverrides,
+    pnpm(pkgJson: EditablePackageJson, overrides: Overrides) {
+      pkgJson.update({
+        pnpm: {
+          ...(<object>pkgJson.content['pnpm']),
+          [OVERRIDES_FIELD_NAME]: overrides
+        }
+      })
+    },
+    vlt: updateOverrides,
+    'yarn/berry': updateResolutions,
+    'yarn/classic': updateResolutions
+  }
+})()
 
 type AgentListDepsOptions = {
   npmExecPath?: string
@@ -251,6 +260,16 @@ const lsByAgent = (() => {
       }
       return stdout
     },
+    async vlt(agentExecPath: string, cwd: string) {
+      try {
+        return (
+          await spawn(agentExecPath!, ['ls', '--view', 'human', ':not(.dev)'], {
+            cwd
+          })
+        ).stdout
+      } catch {}
+      return ''
+    },
     async 'yarn/berry'(agentExecPath: string, cwd: string) {
       try {
         return (
@@ -286,6 +305,7 @@ const depsIncludesByAgent: Record<Agent, AgentDepsIncludesFn> = {
   bun: (stdout: string, name: string) => stdout.includes(` ${name}@`),
   npm: (stdout: string, name: string) => stdout.includes(`/${name}\n`),
   pnpm: (stdout: string, name: string) => stdout.includes(`/${name}\n`),
+  vlt: (stdout: string, name: string) => stdout.includes(` ${name}@`),
   'yarn/berry': (stdout: string, name: string) => stdout.includes(` ${name}@`),
   'yarn/classic': (stdout: string, name: string) => stdout.includes(` ${name}@`)
 }
@@ -663,6 +683,12 @@ export const optimize: CliSubcommand = {
       )
       return
     }
+    if (agent === 'vlt') {
+      console.log(
+        `✘ ${COMMAND_TITLE}: ${agent} does not support overrides. Soon, though ⚡`
+      )
+      return
+    }
     const lockName = lockPath ? path.basename(lockPath) : 'lock file'
     if (lockSrc === undefined) {
       console.log(`✘ ${COMMAND_TITLE}: No ${lockName} found`)

src/utils/package-manager-detector.ts

@@ -19,7 +19,8 @@ export const AGENTS = [
   'npm',
   'pnpm',
   'yarn/berry',
-  'yarn/classic'
+  'yarn/classic',
+  'vlt'
 ] as const
 export type Agent = (typeof AGENTS)[number]
 export type StringKeyValueObject = { [key: string]: string }
@@ -90,15 +91,16 @@ const maintainedNodeVersions = (() => {
 
 const LOCKS: Record<string, Agent> = {
   'bun.lockb': 'bun',
-  'pnpm-lock.yaml': 'pnpm',
-  'pnpm-lock.yml': 'pnpm',
-  'yarn.lock': 'yarn/classic',
   // If both package-lock.json and npm-shrinkwrap.json are present in the root
   // of a project, npm-shrinkwrap.json will take precedence and package-lock.json
   // will be ignored.
   // https://docs.npmjs.com/cli/v10/configuring-npm/package-lock-json#package-lockjson-vs-npm-shrinkwrapjson
   'npm-shrinkwrap.json': 'npm',
   'package-lock.json': 'npm',
+  'pnpm-lock.yaml': 'pnpm',
+  'pnpm-lock.yml': 'pnpm',
+  'yarn.lock': 'yarn/classic',
+  'vlt-lock.json': 'vlt',
   // Look for a hidden lock file if .npmrc has package-lock=false:
   // https://docs.npmjs.com/cli/v10/configuring-npm/package-lock-json#hidden-lockfiles
   //
@@ -126,6 +128,9 @@ const readLockFileByAgent: Record<Agent, ReadLockFile> = (() => {
       return undefined
     }
   }
+  const defaultReader = wrapReader(
+    async (lockPath: string) => await readFileUtf8(lockPath)
+  )
   return {
     bun: wrapReader(async (lockPath: string, agentExecPath: string) => {
       let lockBuffer: Buffer | undefined
@@ -137,18 +142,16 @@ const readLockFileByAgent: Record<Agent, ReadLockFile> = (() => {
       try {
         return <string>parseBunLockb(lockBuffer)
       } catch {}
-      // To print a Yarn lockfile to your console without writing it to disk use `bun bun.lockb`.
+      // To print a Yarn lockfile to your console without writing it to disk
+      // use `bun bun.lockb`.
       // https://bun.sh/guides/install/yarnlock
       return (await spawn(agentExecPath, [lockPath])).stdout.trim()
     }),
-    npm: wrapReader(async (lockPath: string) => await readFileUtf8(lockPath)),
-    pnpm: wrapReader(async (lockPath: string) => await readFileUtf8(lockPath)),
-    'yarn/berry': wrapReader(
-      async (lockPath: string) => await readFileUtf8(lockPath)
-    ),
-    'yarn/classic': wrapReader(
-      async (lockPath: string) => await readFileUtf8(lockPath)
-    )
+    npm: defaultReader,
+    pnpm: defaultReader,
+    vlt: defaultReader,
+    'yarn/berry': defaultReader,
+    'yarn/classic': defaultReader
   }
 })()