rectorphp / getrector-com

Rector Website
https://getrector.com
MIT License
25 stars 37 forks source link

Enhance Rector rule discovery and configuration experience #2512

Open tigitz opened 1 month ago

tigitz commented 1 month ago

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 commented 1 month ago

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,