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

Consider returning command results as a JSON string #14

Open
ericglau opened this issue Sep 13, 2024 · 0 comments
Open

Consider returning command results as a JSON string #14

ericglau opened this issue Sep 13, 2024 · 0 comments

Comments

@ericglau
Copy link
Member

Currently the commands return results in plain text.

Examples:

  • deploy prints Deployed to address: ...
  • proposeUpgrade prints Proposal ID: ... and Proposal URL: ...
  • getDeployApprovalProcess and getUpgradeApprovalProcess print Approval process ID: and Via: ... (if via it is not undefined)

Since this CLI is mainly consumed programmatically, for example from the Foundry Upgrades plugin, we should consider making these results more consumable by printing JSON strings instead.

Particularly, it would also allow for some returned fields to be undefined, for example the via field from the approval process.

This would be a breaking change and it is why the current version of this CLI is still tagged as alpha.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant