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

Refactor/cli change #595

Merged
merged 6 commits into from
Jun 1, 2024
Merged

Refactor/cli change #595

merged 6 commits into from
Jun 1, 2024

Conversation

JakeStanger
Copy link
Owner

@JakeStanger JakeStanger commented May 18, 2024

This splits most CLI/IPC commands into two categories:

  • var for ironvars
  • bar for controlling individual bars.

It also introduces more commands for visibility, as well as breaking existing ones.

New commands:

  • show
  • hide
  • toggle_visible
  • set_popup_visible
  • get_popup_visible

The implementation of some existing commands has been improved.

The following other smaller features/fixes are introduced by this PR:

  • The CLI now supports JSON output.
  • The CLI now supports debug output for printing request/response objects.
  • The CLI will now exit code 3 on error.

BREAKING CHANGE: All IPC commands have changed. Namely, type has been changed to command, and bar/var related commands are now under a subcommand. The full spec can be found on the wiki.

BREAKING CHANGE: Several CLI commands are now located under the var and bar categories. Usage of any commands to get/set Ironvars or control bar visibility will need to be updated.

BREAKING CHANGE: The open_popup and close_popup IPC commands are now called show_popup and hide_popup respectively.

BREAKING CHANGE: The popup name argument has been renamed to widget_name on all IPC commands.

BREAKING CHANGE: The set-visibility CLI command now takes a true/false positional argument in place of the -v flag.

BREAKING CHANGE: ok_value responses will no longer print ok as the first line when using the CLI

@JakeStanger JakeStanger added the BREAKING CHANGE Requires one or more breaking changes label May 18, 2024
This splits most CLI/IPC commands into two categories:

- `var` for ironvars
- `bar` for controlling individual bars.

It also introduces more commands for visibility, as well as breaking existing ones.

New commands:

- `show`
- `hide`
- `toggle_visible`
- `set_popup_visible`
- `get_popup_visible`

Lastly, the implementation of some existing commands has been improved.

BREAKING CHANGE: All IPC commands have changed. Namely, `type` has been changed to `command`, and bar/var related commands are now under a `subcommand`. The full spec can be found on the wiki.

BREAKING CHANGE: Several CLI commands are now located under the `var` and `bar` categories. Usage of any commands to get/set Ironvars or control bar visibility will need to be updated.

BREAKING CHANGE: The `open_popup` and `close_popup` IPC commands are now called `show_popup` and `hide_popup` respectively.

BREAKING CHANGE: The popup `name` argument has been renamed to `widget_name` on all IPC commands.

BREAKING CHANGE: The `set-visibility` CLI command now takes a `true`/`false` positional argument in place of the `-v` flag.

BREAKING CHANGE: `ok_value` responses will no longer print `ok` as the first line when using the CLI
@JakeStanger JakeStanger merged commit c28de8d into master Jun 1, 2024
8 checks passed
@JakeStanger JakeStanger deleted the refactor/cli-change branch June 1, 2024 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BREAKING CHANGE Requires one or more breaking changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant