nodejs / nodejs/node-gyp

Feature Request: display options in addition to commands in --help output

Open
#2,226 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10.7k
Forks
1.9k
Avg merge
1d 4h
Merged PRs (30d)
5

Description

  • Node Version: n/a
  • Platform: n/a
  • Compiler: n/a
  • Module: n/a

Just as the title says, it would be very helpful to have the valid options listed in addition to commands in --help output as I'm always finding myself having to revisit the readme every time to remember what the name of some option is.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the options documented in the README with the command-line entry point that produces --help output. Add the valid options to that output and verify that it matches the README and still lists the existing commands.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, python
Domain
cli, tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.