Add support for bun.lock (#1483).

README.md

@@ -604,7 +604,7 @@ Specifies the package manager to use when looking up versions.
   <tr><td>npm</td><td>System-installed npm. Default.</td></tr>
   <tr><td>yarn</td><td>System-installed yarn. Automatically used if yarn.lock is present.</td></tr>
   <tr><td>pnpm</td><td>System-installed pnpm. Automatically used if pnpm-lock.yaml is present.</td></tr>
-  <tr><td>bun</td><td>System-installed bun. Automatically used if bun.lockb is present.</td></tr>
+  <tr><td>bun</td><td>System-installed bun. Automatically used if bun.lock or bun.lockb is present.</td></tr>
 </table>
 
 ## peer

src/cli-options.ts

@@ -436,7 +436,7 @@ const extendedHelpPackageManager: ExtendedHelp = ({ markdown }) => {
       ['npm', `System-installed npm. Default.`],
       ['yarn', `System-installed yarn. Automatically used if yarn.lock is present.`],
       ['pnpm', `System-installed pnpm. Automatically used if pnpm-lock.yaml is present.`],
-      ['bun', `System-installed bun. Automatically used if bun.lockb is present.`],
+      ['bun', `System-installed bun. Automatically used if bun.lock or bun.lockb is present.`],
     ],
   })
 

src/lib/doctor.ts

@@ -91,13 +91,15 @@ const loadPackageFileForDoctor = async (options: Options): Promise<PackageInfo>
 // we have to pass run directly since it would be a circular require if doctor included this file
 const doctor = async (run: Run, options: Options): Promise<void> => {
   await chalkInit()
-  const lockFileName =
+
+  // bun lockFileName defaults to bun.lock but will be overwritten to bun.lockb if detected at the readFile step below
+  let lockFileName: 'package-lock.json' | 'yarn.lock' | 'pnpm-lock.yaml' | 'bun.lock' | 'bun.lockb' =
     options.packageManager === 'yarn'
       ? 'yarn.lock'
       : options.packageManager === 'pnpm'
         ? 'pnpm-lock.yaml'
         : options.packageManager === 'bun'
-          ? 'bun.lockb'
+          ? 'bun.lock'
           : 'package-lock.json'
   const { pkg, pkgFile }: PackageInfo = await loadPackageFileForDoctor(options)
 
@@ -163,7 +165,16 @@ const doctor = async (run: Run, options: Options): Promise<void> => {
   let lockFile = ''
   try {
     lockFile = await fs.readFile(lockFileName, 'utf-8')
-  } catch (e) {}
+  } catch (e) {
+    // try bun.lockb if bun.lock was not found
+    // set lockFileName so the rest of doctor mode uses bun.lockb for lock file updating and restoration
+    if (options.packageManager === 'bun') {
+      lockFileName = 'bun.lockb'
+      try {
+        lockFile = await fs.readFile(lockFileName, 'utf-8')
+      } catch (e) {}
+    }
+  }
 
   // make sure current tests pass before we begin
   try {

src/lib/findLockfile.ts

@@ -34,6 +34,8 @@ export default async function findLockfile(
         return { directoryPath: currentPath, filename: 'deno.jsonc' }
       } else if (files.includes('bun.lockb')) {
         return { directoryPath: currentPath, filename: 'bun.lockb' }
+      } else if (files.includes('bun.lock')) {
+        return { directoryPath: currentPath, filename: 'bun.lock' }
       }
 
       const pathParent = path.resolve(currentPath, '..')

test/determinePackageManager.test.ts

@@ -27,6 +27,27 @@ describe('determinePackageManager', () => {
     packageManager.should.equal('bun')
   })
 
+  it('returns bun if bun.lock exists in cwd', async () => {
+    /** Mock for filesystem calls. */
+    function readdirMock(path: string): Promise<string[]> {
+      switch (path) {
+        case '/home/test-repo':
+        case 'C:\\home\\test-repo':
+          return Promise.resolve(['bun.lock'])
+      }
+
+      throw new Error(`Mock cannot handle path: ${path}.`)
+    }
+
+    const packageManager = await determinePackageManager(
+      {
+        cwd: isWindows ? 'C:\\home\\test-repo' : '/home/test-repo',
+      },
+      readdirMock,
+    )
+    packageManager.should.equal('bun')
+  })
+
   it('returns bun if bun.lockb exists in an ancestor directory', async () => {
     /** Mock for filesystem calls. */
     function readdirMock(path: string): Promise<string[]> {