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

saltbox venv list table does not support inclusion of working formulas #6

Open
JeffreyUrban opened this issue Jun 26, 2020 · 1 comment · May be fixed by #7
Open

saltbox venv list table does not support inclusion of working formulas #6

JeffreyUrban opened this issue Jun 26, 2020 · 1 comment · May be fixed by #7

Comments

@JeffreyUrban
Copy link

JeffreyUrban commented Jun 26, 2020

The table of commands generated by saltbox venv list does not support valid formulas for commands in the 'Formula' column, since the formula column is generated from the name of the command in the referenced saltbox.yaml. Changing the name shown in the formula column to be a formula breaks the command, since it makes a corresponding change to the command name, so the formula is then also the command-name, which would be part of the formula.

For example, a working formula for git-cmd is git-cmd <path-to-project.yml> <cmd>, but it is shown in the Formula column as only git-cmd, which fails without meaningful help if run per the table: saltbox venv exec f0cal-project git-cmd.

The table doesn't have a suitable place for formulas and doesn't point to documentation on the formulas.

@JeffreyUrban
Copy link
Author

Suggest renaming column 'Formula' to 'Command' or at least 'Formula-Name' to match other existing nomenclature and adding a header that shows valid structure(s) for help on the formulas and the formulas themselves such as:

saltbox venv exec <box> <formula> -h List arguments
saltbox venv exec <box> <formula> <positional-arguments> <optional-arguments> Run command

@JeffreyUrban JeffreyUrban linked a pull request Jun 26, 2020 that will close this issue
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

Successfully merging a pull request may close this issue.

1 participant