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

Add list with anchors for all rules, update 72->73 #269

Closed
wants to merge 1 commit into from

Conversation

sandoba
Copy link

@sandoba sandoba commented Nov 6, 2022

Makes the growing collection of rules easier to use, similar to https://github.com/rectorphp/rector/edit/main/docs/rector_rules_overview.md.

@samsonasik
Copy link
Member

The docs is generated by command:

composer docs

"docs": [

It should not be added manually.

@sandoba
Copy link
Author

sandoba commented Nov 6, 2022

Well but isn't it supposed to be used by humans and should therefore be as easy to use as possible? If rules are added or removed in the future comparing the rector.php of a project with the current list would be much quicker.

And I've just submitted another pull request for "rectorphp/rector-doctrine" as well which had a duplicate listing for "TypedPropertyFromToOneRelationTypeRector". Not sure where that would come from if the generation is automated?

@samsonasik
Copy link
Member

If there is a bug in docs generation, the command need to be patched.

The docs is read from rector rules code sample

@johanadivare
Copy link
Contributor

@samsonasik when i ran composer docs on master i saw some changes this is probably because i did it manually with #261 shall i make another pull request with running composer docs for the project?

@samsonasik
Copy link
Member

@johanadivare other PR is ok 👍 .

We basically should have weekly auto-generating PR like in rector-src for composer docs command

https://github.com/rectorphp/rector-src/blob/84361b82b630d31b49b009b46bdd3b1312ced2e8/.github/workflows/weekly_pull_requests.yaml#L22

but currently, autocommit consuming re-usable workflow not trigger CI on rector-* packages, see

we probably need to give stefanzweifel/git-auto-commit-action a try in the future, ref related feature request:

@TomasVotruba
Copy link
Member

Closing as this is automated by composer docs run

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 this pull request may close these issues.

None yet

4 participants