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

--help flag to show options #11

Closed
l0b0 opened this issue Jul 12, 2021 · 5 comments · May be fixed by #74
Closed

--help flag to show options #11

l0b0 opened this issue Jul 12, 2021 · 5 comments · May be fixed by #74
Assignees
Labels
good first issue Good for newcomers

Comments

@l0b0
Copy link
Collaborator

l0b0 commented Jul 12, 2021

As far as I can tell this tool has no way to figure out the synopsis without either looking at the code or going to the readme in this repo.

@m-mohr m-mohr added the good first issue Good for newcomers label Jul 12, 2021
@m-mohr
Copy link
Collaborator

m-mohr commented Jul 12, 2021

Thanks, yes, that is true. This project started as a proof-of-concept and as such fully focussed on validation and nothing else. As such the CLI interface is very bare-bone. Would be nice to have though. I'm open to PRs, should not be too hard to do (with yargs instead of minimist). I'm currently slammed with work for STAC Browser, but will keep an eye on it.

@l0b0
Copy link
Collaborator Author

l0b0 commented Jul 12, 2021

Thanks! I probably won't have time to work on this, and also I'm not very familiar with the tool stack (except Node.js itself).

@l0b0 l0b0 mentioned this issue Nov 17, 2021
4 tasks
@l0b0 l0b0 mentioned this issue Dec 5, 2021
@m-mohr
Copy link
Collaborator

m-mohr commented Dec 11, 2021

A very minimal help output is now available:

> stac-node-validator --help
STAC Node Validator v1.1.0

For more information on using this command line tool, please visit
https://github.com/stac-utils/stac-node-validator/blob/master/README.md#usage

I'll not implement a full-fledged help section anytime soon, but happy to accept PRs.

m-mohr added a commit that referenced this issue Dec 11, 2021
@l0b0 l0b0 closed this as completed Dec 12, 2021
@m-mohr m-mohr reopened this Dec 12, 2021
@m-mohr
Copy link
Collaborator

m-mohr commented Dec 12, 2021

Leaving this open, maybe someone else wants to contribute something. :-)

@m-mohr m-mohr mentioned this issue Aug 12, 2023
@m-mohr m-mohr self-assigned this Aug 12, 2023
@m-mohr m-mohr linked a pull request Aug 12, 2023 that will close this issue
@m-mohr
Copy link
Collaborator

m-mohr commented Aug 14, 2023

Implemented and released with 2.0.0-beta.1.

@m-mohr m-mohr closed this as completed Aug 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants