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

Enhance Rector rule discovery and configuration experience #2512

Open
tigitz opened this issue Aug 13, 2024 · 1 comment
Open

Enhance Rector rule discovery and configuration experience #2512

tigitz opened this issue Aug 13, 2024 · 1 comment

Comments

@tigitz
Copy link
Contributor

tigitz commented Aug 13, 2024

When starting new projects, I regularly review and select Rector rules, including evaluating new ones and reassessing previously used rules. I've encountered some challenges with this process and have suggestions for improvement:

  1. Discoverability of rule search:

    • The https://getrector.com/find-rule page is not easily discoverable
    • Suggestion: Add it to the header menu, documentation menu, or implement a search input in the header
  2. Rule exploration and presentation:

    • Current search functionality assumes prior knowledge of rules
    • Suggestion: Implement a browsable, hierarchical display of all rules
    • Proposed layout:
      • Left panel: Tree-like display of rule categories
        image

      • Right panel: Detailed rule information when selected
        image

  3. Enhance developer experience (DX):

    • Add a "Copy FQCN" button in the rule detail view for quick configuration
    • Implement a "save for later" feature for selected rules
    • Provide an option to generate configuration code for saved rules

IMO these improvements would significantly streamline the rule selection and configuration process.

Thanks again for the great tool.

@TomasVotruba
Copy link
Member

Hi Tigitz,

thanks for suggestions. We don't plan any new features for time being, but contributions might help to ship those.

Would you like to contribute these? If so, let's start with the easy one:

documentation menu,

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

2 participants