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

Validation of upload data should happen later in the programm #841

Open
2 tasks
BioPhoton opened this issue Oct 15, 2024 · 0 comments
Open
2 tasks

Validation of upload data should happen later in the programm #841

BioPhoton opened this issue Oct 15, 2024 · 0 comments
Labels
🧩 cli 🧩 nx-plugin 🤓 UX UX improvement for CLI users
Milestone

Comments

@BioPhoton
Copy link
Collaborator

User story

As a developer I want to have a a tool that handles miss configuration or miss usage as graceful as possible while still helping me to understand the problem and gat some actionable feedback.

When it comes to configuration of the CLI I ran into cases where I feel hindered by the strictness of the upload options.

The validation requires the fields project, server, organization, apyKey to be set or non of them.

Cases where it is hindering:

  • it throws when running any command also collect
  • env variables for .env file or the process it self can cause those errors
  • it adds complexity to the code as we have to consider this case internally now to get good Dx

How it could work instead:

  • the upload config is all optional in CoreConfig
  • it gets evaluated with the uploadConfig.parse helper inside the autorun and upload command right before calling the functionality from core

Acceptance criteria

  • All CLI commands but upload should work with partially configured upload data
  • The nx-plugin should work for all commands but upload should work with partially configured upload data

Implementation details

No response

@BioPhoton BioPhoton added 🤓 UX UX improvement for CLI users 🧩 cli 🧩 nx-plugin labels Oct 15, 2024
@BioPhoton BioPhoton added this to the 4. Public milestone Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧩 cli 🧩 nx-plugin 🤓 UX UX improvement for CLI users
Projects
None yet
Development

No branches or pull requests

1 participant