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

Refactor help and error handling for op/open-preview.sh #167

Open
apolopena opened this issue Dec 21, 2021 · 0 comments
Open

Refactor help and error handling for op/open-preview.sh #167

apolopena opened this issue Dec 21, 2021 · 0 comments
Assignees
Labels
enhancement New feature or request passed-dev-qa Optional state. Use this when QAing other peoples fixes in another branch.ready to be merged to main

Comments

@apolopena
Copy link
Owner

apolopena commented Dec 21, 2021

Problem this feature will solve

  • -h --help text is not as clear as it could be.
  • -h --help textshould be inline to the script not in a file outside the script.
  • There is no error handling for the following edge cases:
    • no gp binary
    • invalid option
    • leading slash in the PATH
    • default port cannot be derived

Background

Proposed Solution

Clarify - -h --help text and put it inline to the script.

  • Add error handling for the following edge cases:
    • no gp binary
    • invalid option
    • leading slash in the PATH
    • default port cannot be derived

Constraints and Assumptions

<! -- Any constraints and/or assumption relevant for the development and use of this feature? -->

Alternatives or Workarounds

Figure out the options yourself by reading the code in open-preview.sh

Additional context

Add any other context or screenshots about the feature request here.

@apolopena apolopena added the enhancement New feature or request label Dec 21, 2021
@apolopena apolopena self-assigned this Jan 22, 2022
@apolopena apolopena added this to the Backlog 🗂 milestone Jan 22, 2022
@apolopena apolopena changed the title add -h and --help options to op/open-preview.sh Refactor help and error handling for op/open-preview.sh Feb 10, 2022
@apolopena apolopena added in-development Bug or feature is currently being worked on in-dev-qa and removed in-development Bug or feature is currently being worked on labels Feb 10, 2022
apolopena added a commit that referenced this issue Feb 10, 2022
@apolopena apolopena added passed-dev-qa Optional state. Use this when QAing other peoples fixes in another branch.ready to be merged to main and removed in-dev-qa labels Feb 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request passed-dev-qa Optional state. Use this when QAing other peoples fixes in another branch.ready to be merged to main
Projects
None yet
Development

No branches or pull requests

1 participant