README is not correctly shown on verdaccio using pnpm publish

[FolknR]

pnpm version: 6.23.6

Code to reproduce the issue:

pnpm publish

Expected behavior:

The readme file is being passed and shown correctly

Actual behavior:

The readme file isn't present in the publishing request body

Additional information:

Readme file is uploaded correctly
There is no issue using pnpm v5
There is no issue using npm

• node -v prints: v16.13.1
• Windows, macOS, or Linux?: Windows

[zkochan]

I am not sure what is the reason. Might be that the content of the readme should be added to the package.json on publish. If that is the case, you can try it, here is the manifest prepared for publish:

pnpm/packages/plugin-commands-publishing/src/pack.ts

Lines 127 to 128 in 5af305f

	const publishManifest = await exportableManifest(projectDir, manifest)
	pack.entry({ mode, mtime, name: 'package/package.json' }, JSON.stringify(publishManifest, null, 2))

probably we can pass the readme to the exportableManifest and it can add it to the proper field of package.json

[FolknR]

I am not sure what is the reason. Might be that the content of the readme should be added to the package.json on publish. If that is the case, you can try it, here is the manifest prepared for publish:

pnpm/packages/plugin-commands-publishing/src/pack.ts

Lines 127 to 128 in 5af305f

	const publishManifest = await exportableManifest(projectDir, manifest)
	pack.entry({ mode, mtime, name: 'package/package.json' }, JSON.stringify(publishManifest, null, 2))

probably we can pass the readme to the exportableManifest and it can add it to the proper field of package.json

Yes, your described option works, thanks. Should I create a PR?

[zkochan]

sure, go ahead

[dangreen]

@zkochan @FolknR Hi guys. No other managers are doing that. Why is pnpm doing this by default? It's increasing package.json's and whole package size.

[zkochan]

So, is it an issue with Verdaccio then? How does it work with npm if npm doesn't populate this field?

cc @juanpicado

[dangreen]

npm reads README.* from package root

https://docs.npmjs.com/about-package-readme-files

also

https://docs.npmjs.com/cli/v8/configuring-npm/package-json#files

README & LICENSE can have any case and extension.

[Yukiniro]

I have the same problem. But what field should I use in package.json.

[juanpicado]

README not being shown for packages (pnpm 6 only) verdaccio/verdaccio#2469

yes it does https://github.com/npm/read-package-json/blob/main/read-json.js#L295

yarn was doing it until v2, yarnpkg/berry#1702

[dangreen]

@zkochan @FolknR how soon are you going to revert/fix it?

[zkochan]

It is not in priority for me. If someone wants to do it, the easiest way is probably to add a setting for it.

[FolknR]

@dangreen I'll fix it this week

[dangreen]

@FolknR Thanks, but I'm already working on a fix.