[BUG] `npm publish` complains on `bin` field examples from npm docs

[mrazauskas]

Is there an existing issue for this?

• I have searched the existing issues

This issue exists in the latest npm version

• I am using the latest npm

Current Behavior

npm publish complains and auto correct the bin field examples from npm docs.

Expected Behavior

Seems like the examples are correct, there is no need to complain or alter the code.

Steps To Reproduce

First example:

1. Create fresh repo with npm init -y
2. Add dummy file cli.js
3. Copy bin field entry from npm docs to package.json:

"bin": {
  "myapp": "./cli.js"
}

Second example:

1. Create fresh repo with npm init -y
2. Add dummy file cli.js
3. Copy bin field entry from npm docs to package.json:

"bin": "./cli.js"

Finally run npm publish --dry-run. In both cases npm complains:

npm WARN publish npm auto-corrected some errors in your package.json when publishing.  Please run "npm pkg fix" to address these errors.
npm WARN publish errors corrected:
npm WARN publish "bin[myapp]" script name was cleaned

Environment

• npm: 10.2.4
• Node.js: 20.11.1
• OS Name: macOS
• System Model Name: Macbook Pro
• npm config:

; "user" config from /Users/(replaced)/.npmrc

//registry.npmjs.org/:_authToken = (protected) 

; node bin location = /Users/(replaced)/.n/bin/node
; node version = v20.11.1
; npm local prefix = /Users/(replaced)/Projects/x-npm-bin
; npm version = 10.2.4
; cwd = /Users/(replaced)/Projects/x-npm-bin
; HOME = /Users/(replaced)
; Run `npm config ls -l` to show all defaults.

[trivikr]

Related: npm/package-json#83

[Santoshraj2]

@mrazauskas As we are trying to create the executable files in the bin folder , the executable files should be in bin folder and path should be the directory to the bin folder . if we keep it out of bin and publish it , It will give us the same warning as it is a required to put the files in bin and same path should be given in package.json file.

do below steps and it should work as expected.

1. create cli.js file inside bin folder
2. make below entry in package.json file.
   "bin": {
   "myapp": "bin/cli.js"
   }

[mrazauskas]

Thanks for comment. It works, of course. I just try to explain that npm complains about the examples from its own documentation website.

[mrazauskas]

@Santoshraj2 Hm.. I was speaking about the two examples just under the one you have fixed. Also not sure if these examples is the problem. As far as I can understand ./path/to/program and path/to/program are equivalent. Might be I mis something, but it also can be that validation logic of the bin field is incorrect.

[Santoshraj2]

@mrazauskas Yes you are right ./path/to/program and path/to/program are same. so other examples looks fine to me.