[epic] warn users when altering package.json during publish

[wraithgar]

Epic

There is a lot of manipulation that read-package-json does when preparing a manifest for publishing. Not all of it can be removed but some if it can (such as typo corrections). In order to stop doing that in the next semver-major we need to identify which changes we can stop doing, and start warning the user about them now.

A command to apply the fixes needs to also exist to easily clear the warnings.

Tasks

Beta Give feedback

1. move read-package-json functionality into @npmcli/package-json as-is
2. move npm publish to use @npmcli/package-json
3. identify which changes to warn about
4. research if readme attribute is load bearing for website
5. add discrete bundleDepencies: false step to @npmcli/package-json
6. come up with the mechanism that will warn in 9 and throw in 10
7. add new dev/dependency step to prepare
8. write npm pkg fix
9. separate npm's call of prepare into warn/don't warn lanes

[wraithgar]

Decision record for what alterations are going to change in 9/10

bundledDependencies

npm 9 warns
npm pkg fix fixes
npm 10 throws

bundleDependencies

• false
  • npm 9 warns
  • npm pkg fix fixes (deletes the attribute)
  • npm 10 throws

gypfile

• npm 9 warns when doing this
• npm 9 warning / 10 exception should direct folks to run npm pkg set scripts.install="node-gyp rebuild";npm pkg set gypfile=true --json
• npm 10 errors if gypfile is not set to true or false if there is a gypfile present

keep the same logic to show a warning for npm 9 and make it error in npm 10 unless they set gypfile: true
action: in normalize change gypfile: true so it sets the correct install script

serverjs

npm 9 warns
npm 10 stops doing this altogether

scriptpath

• npm 9 warns when doing this
• npm pkg fix fixes this
• npm 10 throws and refuses to accept bad script paths

authors

• npm 9 will warn
• npm 10 will stop doing this

readme

• npm 9 will warn
• npm 10 will stop doing this

binDir

stops normalizing in npm 10 and lets binRefs handle the rest

normalizeData

• npm 9 will warn
• npm pkg fix will fix
• npm 10 will throw

binRefs

• Warn in 9
• npm pkg fix fixes
• Throw in 10

NEW PREPARE STEP

entries in devDependencies and dependencies that match names

• Warn in 9
• npm pkg fix fixes
• Throw in 10

[wraithgar]

This will go out w/ the next npm release.