In some companies, or communities, code rules are detailed in custom documentation. For example, in my compani, we have a comprehensive code style redacted and hosted in our internal wiki.
When lint action fails, I'd like to add a message like this:
Your code does not pass the code style.
Go ahead and read it carefully at https://example.net/.
Note: you can automatically fix modified files by running make beautify-php
I'd suggest to add a hint section in actions, accepting:
- a single string to be printed
- an array of strings to be printed
Note: I was wondering if accepting a custom callable would be useful, and I am not against it, but if you are about to write custom code, why not writing the full action in custom code, and thus you do not need the hint section.
If this sounds a reasonable feature to you, I am willing to contribute with a PR.
In some companies, or communities, code rules are detailed in custom documentation. For example, in my compani, we have a comprehensive code style redacted and hosted in our internal wiki.
When lint action fails, I'd like to add a message like this:
I'd suggest to add a
hintsection in actions, accepting:Note: I was wondering if accepting a custom callable would be useful, and I am not against it, but if you are about to write custom code, why not writing the full action in custom code, and thus you do not need the
hintsection.If this sounds a reasonable feature to you, I am willing to contribute with a PR.