feat: add binDir step to normalize function

wraithgar · wraithgar · commit 08eae4767be2 · 2025-07-15T12:58:22.000-07:00
This adds the `binDir` step to `.normalize()`.  This will translate `directories.bin` into a `.bin` entry.

`read-package-json-fast` technically had TWO apis.  You could call it as exported, or you could call `.normalize`.  The only difference between the two was that `.normalize` did not include the translation of `directories.bin` into `.bin`.  We don't need another top level api for this package.  Adding `binDir` to the `normalize` step is the right one.  That's part of preparing a package for local consumption.  I'm relatively certain we have bugs we've missed here because of this.  This also means any bugs we fix in `binDir` will be fixed in all use cases.  The existing `binDir` step (using glob) is also preferable to the code that `read-package-json-fast` was using (using manual recursive directory walking).

Ultimately this will help us finish porting existing code that uses `read-package-json-fast` to this library.
diff --git a/lib/index.js b/lib/index.js
@@ -34,6 +34,7 @@ class PackageJson {
     'scripts',
     'funding',
     'bin',
+    'binDir',
   ])
 
   // npm pkg fix
@@ -112,7 +113,7 @@ class PackageJson {
     return p.prepare(opts)
   }
 
-  // read-package-json-fast compatible behavior
+  // read-package-json-fast.normalize compatible behavior (distinct from just read-package-json-fast
   static async normalize (path, opts) {
     const p = new PackageJson()
     await p.load(path)
diff --git a/tap-snapshots/test/normalize.js.test.cjs b/tap-snapshots/test/normalize.js.test.cjs
@@ -103,6 +103,10 @@ exports[`test/normalize.js TAP @npmcli/package-json - with changes dedupe option
 Array []
 `
 
+exports[`test/normalize.js TAP @npmcli/package-json - with changes directories.bin > must match snapshot 1`] = `
+Array []
+`
+
 exports[`test/normalize.js TAP @npmcli/package-json - with changes normalize bin > must match snapshot 1`] = `
 Array []
 `
diff --git a/test/normalize.js b/test/normalize.js
@@ -167,6 +167,19 @@ for (const [name, testNormalize] of Object.entries(testMethods)) {
       })
     })
 
+    t.test('directories.bin', async t => {
+      const { content } = await testNormalize(t, ({
+        'package.json': JSON.stringify({
+          name: 'bin-test',
+          directories: {
+            bin: './bin',
+          },
+        }),
+        bin: { echo: '#!/bin/sh\n\necho "hello world"' },
+      }))
+      t.strictSame(content.bin, { echo: 'bin/echo' })
+    })
+
     t.test('dedupe optional deps out of regular deps', async t => {
       t.test('choose optional deps in conflict, removing empty dependencies', async t => {
         const { content } = await testNormalize(t, ({

Original file line number	Diff line number	Diff line change
@@ -103,6 +103,10 @@ exports[`test/normalize.js TAP @npmcli/package-json - with changes dedupe option
`103`	`103`	`Array []`
`104`	`104`	`
`105`	`105`
	`106`	+exports[`test/normalize.js TAP @npmcli/package-json - with changes directories.bin > must match snapshot 1`] = `
	`107`	`+Array []`
	`108`	+`
	`109`	`+`
`106`	`110`	exports[`test/normalize.js TAP @npmcli/package-json - with changes normalize bin > must match snapshot 1`] = `
`107`	`111`	`Array []`
`108`	`112`	`