hasura / hasura/graphql-engine
make CLI flag names future proof
- Dominant language
- TypeScript
- Stars
- 32.1k
- Forks
- 3k
- PR merge metrics
- PR metrics pending
Description
### Component
### What is the current behaviour?
Currently, the CLI uses generic entity names in some commands. For example the following is the command to create a build
```
ddn supergraph build create --project --supergraph
```
### What is the expected behaviour?
I would expect the flag names to be more specific, in the above case I would expect the flags to be named `--project-name` and `supergraph-config` instead of `project` and `supergraph`.
This is more future proof and removes ambiguity IMHO. It leaves room to quantify the entity more if required in the future.
### How to reproduce the issue?
N/A
### Screenshots or Screencast
N/A
### Please provide any traces or logs that could help here.
N/A
### Any possible solutions/workarounds you're aware of?
N/A
### Keywords
Contributor guide
Research direction
Start by locating the CLI definitions for `ddn supergraph build create` and review how its `--project` and `--supergraph` flags are declared. Then identify whether other CLI commands use similarly generic flag names and define the intended rename scope. Done means the agreed flags are consistently named and the affected command behavior and help text reflect them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100