search

nodejs / node-core-utils

CLI tools for Node.js Core collaborators
https://nodejs.github.io/node-core-utils/
MIT License
234 stars 106 forks source link

git node --help does not work #204

Open targos opened 6 years ago

targos commented 6 years ago 
$ git node --help
No manual entry for git-node

Can we do something about it?

git-node --help is OK.

Edit: this is on Linux with zsh

joyeecheung commented 6 years ago

Hmm so I think to make it work on Linux, we should set up proper man pages (it works on Mac because the rules on macOS seem to be different).

Refs: https://www.atlassian.com/blog/git/extending-git

joyeecheung commented 6 years ago

General outline

  1. Write a man page in man/git-node.1
  2. Crete a post-install script that moves man/git-node.1 to the path.join(process.execPath, '..', '..', 'share', 'man', 'man1') (or is there a better way to find out the man pages location of the current Node.js intallation? Or maybe move it to /usr/local/share/man/man1?)

question:

  1. Should we provide a uninstall command?
  2. I am not sure how it works on Windows..
priyank-p commented 6 years ago

For generating man pages we can use something like cli-manpage and put the command generating it under a prepublishOnlyso it runs before publishing.

And then use a post-install script to move it if it's the correct platform.

Should we provide a uninstall command?

I think so, but maybe not as a command, it should remove itself once the package is uninstalled.

I am not sure how it works on Windows..

I am not sure about it too.

richardlau commented 6 years ago

git help defaults to html on Windows. --html-path, --man-path and --info-path arguments to git show where the Git documentation is stored.

gibfahn commented 6 years ago

Doesn't seem to work for me on macOS with the latest npm version of node-core-utils, am I doing something wrong?

image image 
git version: 2.16.2
node-core-utils version: 1.11.1
github-actions[bot] commented 3 years ago

This issue is stale because it has been open many days with no activity. It will be closed soon unless the stale label is removed or a comment is made.

mmarchini commented 3 years ago

Just tested, still an issue

github-actions[bot] commented 3 years ago

This issue is stale because it has been open many days with no activity. It will be closed soon unless the stale label is removed or a comment is made.

joyeecheung commented 3 years ago

Oh wait, we could just log the help text instead of creating a man page anyway

github-actions[bot] commented 3 years ago

This issue is stale because it has been open many days with no activity. It will be closed soon unless the stale label is removed or a comment is made.