feat: add git-branch-lockfile config to generate lockfile in each branch

packages/config/package.json

@@ -34,6 +34,8 @@
   "dependencies": {
     "@pnpm/constants": "workspace:6.1.0",
     "@pnpm/error": "workspace:3.0.1",
+    "@pnpm/git-utils": "workspace:0.0.0",
+    "@pnpm/matcher": "workspace:3.0.0",
     "@pnpm/pnpmfile": "workspace:2.0.2",
     "@pnpm/read-project-manifest": "workspace:3.0.2",
     "@pnpm/types": "workspace:8.0.1",

packages/config/src/Config.ts

@@ -130,6 +130,9 @@ export interface Config {
   modulesDir?: string
   sharedWorkspaceLockfile?: boolean
   useLockfile: boolean
+  useGitBranchLockfile: boolean
+  mergeGitBranchLockfiles?: boolean
+  mergeGitBranchLockfilesBranchPattern?: string[]
   globalPnpmfile?: string
   npmPath?: string
   gitChecks?: boolean

packages/config/src/index.ts

@@ -4,6 +4,8 @@ import { LAYOUT_VERSION } from '@pnpm/constants'
 import PnpmError from '@pnpm/error'
 import { requireHooks } from '@pnpm/pnpmfile'
 import { safeReadProjectManifestOnly } from '@pnpm/read-project-manifest'
+import { getCurrentBranch } from '@pnpm/git-utils'
+import matcher from '@pnpm/matcher'
 import camelcase from 'camelcase'
 import loadNpmConf from '@zkochan/npm-conf'
 import npmTypes from '@zkochan/npm-conf/lib/types'
@@ -36,6 +38,8 @@ export const types = Object.assign({
   bail: Boolean,
   'cache-dir': String,
   'child-concurrency': Number,
+  'merge-git-branch-lockfiles': Boolean,
+  'merge-git-branch-lockfiles-branch-pattern': Array,
   color: ['always', 'auto', 'never'],
   'config-dir': String,
   dev: [null, true],
@@ -53,6 +57,7 @@ export const types = Object.assign({
   'global-dir': String,
   'global-path': String,
   'global-pnpmfile': String,
+  'git-branch-lockfile': Boolean,
   hoist: Boolean,
   'hoist-pattern': Array,
   'ignore-pnpmfile': Boolean,
@@ -185,6 +190,7 @@ export default async (
       'bitbucket.org',
     ],
     globalconfig: npmDefaults.globalconfig,
+    'git-branch-lockfile': false,
     hoist: true,
     'hoist-pattern': ['*'],
     'ignore-workspace-root-check': false,
@@ -261,6 +267,21 @@ export default async (
     if (typeof pnpmConfig['packageLock'] === 'boolean') return pnpmConfig['packageLock']
     return false
   })()
+  pnpmConfig.useGitBranchLockfile = (() => {
+    if (typeof pnpmConfig['gitBranchLockfile'] === 'boolean') return pnpmConfig['gitBranchLockfile']
+    return false
+  })()
+  pnpmConfig.mergeGitBranchLockfiles = await (async () => {
+    if (typeof pnpmConfig['mergeGitBranchLockfiles'] === 'boolean') return pnpmConfig['mergeGitBranchLockfiles']
+    if (pnpmConfig['mergeGitBranchLockfilesBranchPattern'] != null && pnpmConfig['mergeGitBranchLockfilesBranchPattern'].length > 0) {
+      const branch = await getCurrentBranch()
+      if (branch) {
+        const branchMatcher = matcher(pnpmConfig['mergeGitBranchLockfilesBranchPattern'])
+        return branchMatcher(branch)
+      }
+    }
+    return undefined
+  })()
   pnpmConfig.pnpmHomeDir = getDataDir(process)
 
   if (cliOptions['global']) {

packages/config/test/index.ts

@@ -2,6 +2,7 @@
 import { promises as fs } from 'fs'
 import path from 'path'
 import PATH from 'path-name'
+import { getCurrentBranch } from '@pnpm/git-utils/test/utils/mock'
 import getConfig from '@pnpm/config'
 import PnpmError from '@pnpm/error'
 import prepare, { prepareEmpty } from '@pnpm/prepare'
@@ -786,3 +787,92 @@ test('getConfig() sets sideEffectsCacheRead and sideEffectsCacheWrite when side-
   expect(config.sideEffectsCacheRead).toBeTruthy()
   expect(config.sideEffectsCacheWrite).toBeTruthy()
 })
+
+test('respect merge-git-branch-lockfiles-branch-pattern', async () => {
+  {
+    const { config } = await getConfig({
+      cliOptions: {},
+      packageManager: {
+        name: 'pnpm',
+        version: '1.0.0',
+      },
+    })
+
+    expect(config.mergeGitBranchLockfilesBranchPattern).toBeUndefined()
+    expect(config.mergeGitBranchLockfiles).toBeUndefined()
+  }
+  {
+    prepareEmpty()
+
+    const npmrc = [
+      'merge-git-branch-lockfiles-branch-pattern[]=main',
+      'merge-git-branch-lockfiles-branch-pattern[]=release/**',
+    ].join('\n')
+
+    await fs.writeFile('.npmrc', npmrc, 'utf8')
+
+    const { config } = await getConfig({
+      cliOptions: {
+        global: false,
+      },
+      packageManager: {
+        name: 'pnpm',
+        version: '1.0.0',
+      },
+    })
+
+    expect(config.mergeGitBranchLockfilesBranchPattern).toEqual(['main', 'release/**'])
+  }
+})
+
+test('getConfig() sets merge-git-branch-lockfiles when branch matches merge-git-branch-lockfiles-branch-pattern', async () => {
+  prepareEmpty()
+  {
+    const npmrc = [
+      'merge-git-branch-lockfiles-branch-pattern[]=main',
+      'merge-git-branch-lockfiles-branch-pattern[]=release/**',
+    ].join('\n')
+
+    await fs.writeFile('.npmrc', npmrc, 'utf8')
+
+    getCurrentBranch.mockReturnValue('develop')
+    const { config } = await getConfig({
+      cliOptions: {
+        global: false,
+      },
+      packageManager: {
+        name: 'pnpm',
+        version: '1.0.0',
+      },
+    })
+
+    expect(config.mergeGitBranchLockfilesBranchPattern).toEqual(['main', 'release/**'])
+    expect(config.mergeGitBranchLockfiles).toBe(false)
+  }
+  {
+    getCurrentBranch.mockReturnValue('main')
+    const { config } = await getConfig({
+      cliOptions: {
+        global: false,
+      },
+      packageManager: {
+        name: 'pnpm',
+        version: '1.0.0',
+      },
+    })
+    expect(config.mergeGitBranchLockfiles).toBe(true)
+  }
+  {
+    getCurrentBranch.mockReturnValue('release/1.0.0')
+    const { config } = await getConfig({
+      cliOptions: {
+        global: false,
+      },
+      packageManager: {
+        name: 'pnpm',
+        version: '1.0.0',
+      },
+    })
+    expect(config.mergeGitBranchLockfiles).toBe(true)
+  }
+})

packages/config/tsconfig.json

@@ -18,6 +18,12 @@
     {
       "path": "../error"
     },
+    {
+      "path": "../git-utils"
+    },
+    {
+      "path": "../matcher"
+    },
     {
       "path": "../pnpmfile"
     },

packages/core/src/getPeerDependencyIssues.ts

@@ -16,6 +16,7 @@ export type ListMissingPeersOptions = Partial<GetContextOptions>
 | 'preferWorkspacePackages'
 | 'saveWorkspaceProtocol'
 | 'storeController'
+| 'useGitBranchLockfile'
 | 'workspacePackages'
 >
 & Pick<GetContextOptions, 'storeDir'>

packages/core/src/install/extendInstallOptions.ts

@@ -23,6 +23,8 @@ export interface StrictInstallOptions {
   extraBinPaths: string[]
   hoistingLimits?: HoistingLimits
   useLockfile: boolean
+  useGitBranchLockfile: boolean
+  mergeGitBranchLockfiles: boolean
   linkWorkspacePackagesDepth: number
   lockfileOnly: boolean
   fixLockfile: boolean
@@ -162,6 +164,8 @@ const defaults = async (opts: InstallOptions) => {
       process.getuid() !== 0,
     update: false,
     useLockfile: true,
+    useGitBranchLockfile: false,
+    mergeGitBranchLockfiles: false,
     userAgent: `${packageManager.name}/${packageManager.version} npm/? node/${process.version} ${process.platform} ${process.arch}`,
     verifyStoreIntegrity: true,
     workspacePackages: {},

packages/core/src/install/index.ts

@@ -25,6 +25,7 @@ import {
   writeCurrentLockfile,
   writeLockfiles,
   writeWantedLockfile,
+  cleanGitBranchLockfiles,
 } from '@pnpm/lockfile-file'
 import { writePnpFile } from '@pnpm/lockfile-to-pnp'
 import { extendProjectsWithTargetDirs } from '@pnpm/lockfile-utils'
@@ -202,6 +203,10 @@ export async function mutateModules (
     streamParser.removeListener('data', reporter)
   }
 
+  if (opts.mergeGitBranchLockfiles) {
+    await cleanGitBranchLockfiles(ctx.lockfileDir)
+  }
+
   return result
 
   async function _install (): Promise<UpdatedProject[]> {
@@ -779,7 +784,7 @@ const _installInContext: InstallFunction = async (projects, ctx, opts) => {
   }
 
   const depsStateCache: DepsStateCache = {}
-  const lockfileOpts = { forceSharedFormat: opts.forceSharedLockfile }
+  const lockfileOpts = { forceSharedFormat: opts.forceSharedLockfile, useGitBranchLockfile: opts.useGitBranchLockfile, mergeGitBranchLockfiles: opts.mergeGitBranchLockfiles }
   if (!opts.lockfileOnly && opts.enableModulesDir) {
     const result = await linkPackages(
       projects,

packages/core/src/link/index.ts

@@ -129,7 +129,7 @@ export default async function link (
   } else {
     newPkg = opts.manifest
   }
-  const lockfileOpts = { forceSharedFormat: opts.forceSharedLockfile }
+  const lockfileOpts = { forceSharedFormat: opts.forceSharedLockfile, useGitBranchLockfile: opts.useGitBranchLockfile, mergeGitBranchLockfiles: opts.mergeGitBranchLockfiles }
   if (opts.useLockfile) {
     await writeLockfiles({
       currentLockfile: updatedCurrentLockfile,

packages/core/src/link/options.ts

@@ -29,6 +29,9 @@ interface StrictLinkOptions {
 
   publicHoistPattern: string[] | undefined
   forcePublicHoistPattern: boolean
+
+  useGitBranchLockfile: boolean
+  mergeGitBranchLockfiles: boolean
 }
 
 export type LinkOptions =