Ensure that we only use the TodoComment Sniff for core runs, not for plugin ones #266
Comments
This was referenced Jan 17, 2024
stronk7
added a commit
to stronk7/moodle-plugin-ci
that referenced
this issue
Jan 17, 2024
That sniff covers the core coding style and verifies that all the TODOs (inline or phpdoc block), have a MDL issue associated. But that's not a requirements for plugins, hence disabling that Sniff for them. Fixes moodlehq#266
stronk7
added a commit
to stronk7/moodle-plugin-ci
that referenced
this issue
Jan 18, 2024
A new `todo-comment-regex` option has been added to the phpcs command. It allows to specify the regex that will be used with inspecting todo (TODO and @todo) comments. By default, an empty string is used for the option and that makes the Sniff to stop checking. Whoever wants to check for anything (tracker issue, github issue, arbitrary url, ...) can us the new option to configure it. Fixes moodlehq#266
stronk7
added a commit
to stronk7/moodle-plugin-ci
that referenced
this issue
Jan 18, 2024
A new `todo-comment-regex` option has been added to the phpcs command. It allows to specify the regex that will be used with inspecting todo (TODO and @todo) comments. By default, an empty string is used for the option and that makes the Sniff to stop checking. Whoever wants to check for anything (tracker issue, github issue, arbitrary url, ...) can us the new option to configure it. Fixes moodlehq#266
stronk7
added a commit
to stronk7/moodle-plugin-ci
that referenced
this issue
Jan 19, 2024
A new `todo-comment-regex` option has been added to the phpcs command. It allows to specify the regex that will be used with inspecting todo (TODO and @todo) comments. By default, an empty string is used for the option and that makes the Sniff to stop checking. Whoever wants to check for anything (tracker issue, github issue, arbitrary url, ...) can us the new option to configure it. Fixes moodlehq#266
stronk7
added a commit
to stronk7/moodle-plugin-ci
that referenced
this issue
Jan 19, 2024
A new `todo-comment-regex` option has been added to the phpcs command. It allows to specify the regex that will be used with inspecting todo (TODO and @todo) comments. By default, an empty string is used for the option and that makes the Sniff to stop checking. Whoever wants to check for anything (tracker issue, github issue, arbitrary url, ...) can us the new option to configure it. Fixes moodlehq#266
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
With moodlehq/moodle-cs#91 we are introducing a new Sniff that looks for missing MDL-xxxx issue codes in all the TODO and @todo comments (as stated by the coding style).
This Sniff is only for core, hence we have to prevent it to be executed for plugins within moodle-plugin-ci. By disabling it or by setting
commentRequiredRegexto an empty value.Ciao :-)
The text was updated successfully, but these errors were encountered: