Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] 2 of 3 man page configuration options unsupported #25

Closed
Zordrak opened this issue Aug 24, 2021 · 1 comment
Closed

[BUG] 2 of 3 man page configuration options unsupported #25

Zordrak opened this issue Aug 24, 2021 · 1 comment

Comments

@Zordrak
Copy link

Zordrak commented Aug 24, 2021

What / Why

Firstly please forgive any assertions I make that are completely wrong - I'm doing my best to understand something that is completely alien to me.

https://docs.npmjs.com/cli/v7/configuring-npm/package-json states 3 ways to add a man page in a package.json:

I do not know whether the intention is for directories.man to be supported by bin-links or as a process managed by npm or Arborist that would interrogate the directory and convert its contents into a man Array property before sending it to bin-links.

Giving the benefit of the doubt that it is the latter - I would expect per the documentation for bin-links to support either a String or an Array for a man property, however it currently only supports an Array:

if (manTarg && pkg.man && Array.isArray(pkg.man) && pkg.man.length) {

I do not know the progeny of this toolset and what begat what so as to know if this is a feature request for string support, or a bug request that expected string support is missing - but it seems to be missing either way.

References

@wraithgar
Copy link
Member

The normalization of the package.json entry is done during parsing by read-package-json by way of npm-normalize-package-bin

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants