-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
fix(zk_toolbox): make ecosystem configuration not found error more clear #2128
Conversation
@@ -201,7 +201,7 @@ impl EcosystemConfig { | |||
/// Result of checking if the ecosystem exists. | |||
#[derive(Error, Debug)] | |||
pub enum EcosystemConfigFromFileError { | |||
#[error("Ecosystem configuration not found")] | |||
#[error("Ecosystem configuration not found (make sure you have created one `zk_inception ecosystem create` + are in the ecosystem folder `cd path/to/ecosystem/name`)")] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably, we could do something:
Could not find 'ZkStack.toml' in <path>, please create ecosystem first
zk_inception ecosystem create`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most common I see for this error is when people forget to cd into ecosystem folder after zk_inception ecosystem create
. Can you think of alternative wording you would prefer to my wording?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably at the end of the create phase, we could show that you have to cd to the new path?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thats a good idea also but I think most people will overlook that, would be good to have it in the error too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Deniallugo updated wording + added message in ecosystem created, mind reviewing?
@@ -214,7 +214,7 @@ impl EcosystemConfig { | |||
/// Result of checking if the ecosystem exists. | |||
#[derive(Error, Debug)] | |||
pub enum EcosystemConfigFromFileError { | |||
#[error("Ecosystem configuration not found")] | |||
#[error("Ecosystem configuration not found (Could not find 'ZkStack.toml' in <path>: Make sure you have created an ecosystem & are in the new folder `cd path/to/ecosystem/name`)")] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does it make sense to print the actual path? or no?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
makes sense to me - Updated
closed in favour of #2424 |
What ❔
Why ❔
Checklist
zk fmt
andzk lint
.zk spellcheck
.