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

[Task] Create a protections show command that gets run when you say !draupnir protections <name> #35

Open
Gnuxie opened this issue Nov 5, 2024 · 2 comments

Comments

@Gnuxie
Copy link
Member

Gnuxie commented Nov 5, 2024

Description

We can't see the protection's settings and their documentation, and we also can't see the active capability provider set, or their interfaces. But we need to.

Acceptance Criteria

  • The command shows each protection setting with its current and default values.
  • The command shows each capability and the active capability provider.
  • The two sections are separated by a break
  • If we already have documentation to hand about what the settings are used for, then include it.

PRs

@Gnuxie
Copy link
Member Author

Gnuxie commented Nov 28, 2024

Things not completed in the-draupnir-project/Draupnir#626:

  • Protections show command is aliased when someone uses !draupnir protections <name>
    • I don't think our command infrastructure supports an easy way to do this, which sucks. We could make
      the return type of the protections command a union of its list result and the protections show result.
      That would work ok, but it might be confusing.
  • Commands to change the active capability provider (probably needs to be considered under [Story] Add capability management to Draupnir and MPS #6 instead)
  • We need to demonstrate with an example that protections can create commands specifically for the purpose of making configuration of protection settings easier. Since the commands to alter settings are quite long and horrible.

Gnuxie added a commit to the-draupnir-project/Draupnir that referenced this issue Nov 28, 2024
…ng-about

Remove old protection settings config from all protections. This is a change in matrix-protection-suite 2.0 where replace protection settings have been replaced by the new `ConfigDescription`.

We've also added a protections show command which will show a summary of the protection's config and configured capability providers. 

the-draupnir-project/planning#35

![Screenshot_20241126_135802](https://github.com/user-attachments/assets/b856f190-6c84-4a11-a28f-48edc39afa3d)
@Gnuxie
Copy link
Member Author

Gnuxie commented Dec 14, 2024

  • Change the order of protections in the protections list command so that they show by enabled and then by alphabetical order
  • Make sure that we DO NOT show the help command when misspelling a protection name.

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