feat: merge-git-branch-lockfiles-branch-pattern

packages/config/package.json

@@ -34,6 +34,8 @@
   "dependencies": {
     "@pnpm/constants": "workspace:6.0.0",
     "@pnpm/error": "workspace:3.0.0",
+    "@pnpm/git-utils": "workspace:0.0.0",
+    "@pnpm/matcher": "workspace:3.0.0",
     "@pnpm/pnpmfile": "workspace:2.0.0",
     "@pnpm/read-project-manifest": "workspace:3.0.0",
     "@pnpm/types": "workspace:8.0.0",

packages/config/src/Config.ts

@@ -132,6 +132,7 @@ export interface Config {
   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,7 @@ export const types = Object.assign({
   '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],
@@ -266,6 +269,17 @@ export default async (
     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.lockfileOnly = typeof pnpmConfig['lockfileOnly'] === 'undefined'
     ? pnpmConfig.shrinkwrapOnly
     : pnpmConfig['lockfileOnly']
@@ -331,7 +345,6 @@ export default async (
       }
       delete pnpmConfig.lockfileDir
     }
-    pnpmConfig.useGitBranchLockfile = false
     if (opts.cliOptions['virtual-store-dir']) {
       throw new PnpmError('CONFIG_CONFLICT_VIRTUAL_STORE_DIR_WITH_GLOBAL',
         'Configuration conflict. "virtual-store-dir" may not be used with "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/plugin-commands-installation/src/install.ts

@@ -12,7 +12,6 @@ export function rcOptionsTypes () {
   return pick([
     'cache-dir',
     'child-concurrency',
-    'merge-git-branch-lockfiles',
     'dev',
     'engine-strict',
     'fetch-retries',
@@ -34,6 +33,8 @@ export function rcOptionsTypes () {
     'lockfile-directory',
     'lockfile-only',
     'lockfile',
+    'merge-git-branch-lockfiles',
+    'merge-git-branch-lockfiles-branch-pattern',
     'modules-dir',
     'network-concurrency',
     'node-linker',