feat: implement gitSubdir according to npa spec (#442)

Kakadus · web-flow · commit db21624fd9ee · 2026-02-06T08:49:56.000-08:00
This implements the `gitSubdir` parameter, which is already parsed by npa, finally allowing users of npm to specifiy subdirectories in git dependencies. The respective parsing logic has already been agreed on and implemented nearly 4 years ago here: npm/npm-package-arg#91. In this PR, the git fetcher is changed to resolve the `gitSubdir` parameter from the spec if found, as suggested by the author in the original npa PR. ## References Fixes npm/cli#528 Fixes npm/npm#2974 Relates to npm/npm-package-arg#46 Relates to npm/npm-package-arg#91 Inspired from and crediting sspiff@8bd5461, which seems to have been lost after merging the PR at npa.
diff --git a/lib/git.js b/lib/git.js
@@ -245,7 +245,7 @@ class GitFetcher extends Fetcher {
           pkgid: `git:${nameat}${this.resolved}`,
           resolved: this.resolved,
           integrity: null, // it'll always be different, if we have one
-        }).extract(tmp).then(() => handler(tmp), er => {
+        }).extract(tmp).then(() => handler(`${tmp}${this.spec.gitSubdir || ''}`), er => {
           // fall back to ssh download if tarball fails
           if (er.constructor.name.match(/^Http/)) {
             return this.#clone(handler, false)
@@ -263,7 +263,7 @@ class GitFetcher extends Fetcher {
       if (!this.resolved) {
         await this.#addGitSha(sha)
       }
-      return handler(tmp)
+      return handler(`${tmp}${this.spec.gitSubdir || ''}`)
     })
   }
 
diff --git a/test/git.js b/test/git.js
@@ -781,3 +781,50 @@ t.test('fails without arborist constructor', { skip: isWindows && 'posix only' }
   const extract = resolve(me, 'extract-prepack')
   t.rejects(() => ws.extract(extract))
 })
+
+t.test('gitSubdir extraction', { skip: isWindows && 'posix only' }, async t => {
+  const subdirRepo = resolve(me, 'subdir-repo')
+  const git = (...cmd) => spawnGit(cmd, { cwd: subdirRepo })
+  const write = (f, c) => fs.writeFileSync(`${subdirRepo}/${f}`, c)
+
+  await mkdir(subdirRepo, { recursive: true })
+  await git('init')
+  await git('config', 'user.name', 'pacotedev')
+  await git('config', 'user.email', 'i+pacotedev@izs.me')
+  await git('config', 'tag.gpgSign', 'false')
+  await git('config', 'commit.gpgSign', 'false')
+  await git('config', 'tag.forceSignAnnotated', 'false')
+
+  // root package.json (should be ignored)
+  await write('package.json', JSON.stringify({
+    name: 'root-package',
+    version: '1.0.0',
+  }))
+
+  // subdirectory with actual package
+  await mkdir(`${subdirRepo}/packages/subpkg`, { recursive: true })
+  await write('packages/subpkg/package.json', JSON.stringify({
+    name: 'sub-package',
+    version: '1.0.0',
+    description: 'package in subdirectory',
+  }))
+  await write('packages/subpkg/index.js', 'console.log("subpkg")')
+
+  await git('add', '.')
+  await git('commit', '-m', 'add subdirectory package')
+
+  const subdirRemote = `git://localhost:${gitPort}/subdir-repo`
+  const gf = new GitFetcher(`${subdirRemote}#HEAD::path:packages/subpkg`, opts)
+  const extract = resolve(me, 'extract-subdir')
+  await gf.extract(extract)
+
+  // verify it reads from subdirectory, not root
+  const manifest = await gf.manifest()
+  t.equal(manifest.name, 'sub-package')
+  t.equal(manifest.version, '1.0.0')
+  t.equal(manifest.description, 'package in subdirectory')
+
+  // verify files are extracted from subdirectory
+  t.ok(fs.statSync(`${extract}/index.js`))
+  t.ok(fs.statSync(`${extract}/package.json`))
+})
