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

Include a summary of command syntax upon parse error #270

Open
isomorpheme opened this issue Aug 30, 2024 · 0 comments
Open

Include a summary of command syntax upon parse error #270

isomorpheme opened this issue Aug 30, 2024 · 0 comments

Comments

@isomorpheme
Copy link

#269 adds a message linking to the README, since that already describes the syntax, but it would be nicer to have a one-line summary immediately in the message, without having to click a link - something like @prefix merge [on friday] [and deploy [SUBPROJECT] [to ENV]].

The question there is how to make sure it stays in sync with the actual parser; it's easy to forget to update a hardcoded string (and indeed, at time of writing, the README doesn't document the syntax for deploying specific subprojects). This might require switching the parsing setup away from plain parser combinators to something that's more introspectible.

As a nice-to-have, the summary could be tailored to the configuration of the repository, e.g. if multiple deploy environments aren't configured, omit the syntax for specifically targeting one.

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