search

moodlehq / moodle-local_codechecker

A Moodle local plugin providing a simple web UI to run the MoodleCS coding style checks with PHP_CodeSniffer.
63 stars 72 forks source link

Bump moodlehq/moodle-cs from 3.3.15 to 3.4.2 #233

Closed dependabot[bot] closed 7 months ago

dependabot[bot] commented 7 months ago

Bumps moodlehq/moodle-cs from 3.3.15 to 3.4.2.

Release notes

Sourced from moodlehq/moodle-cs's releases.

v3.4.2

Added

  • Add new moodle.Files.LangFilesOrdering sniff to check that lang files are sorted by key.

  • Add new moodle.Commenting.MissingDocBlock sniff to check that all the artifacts (classes, interfaces, traits, ...) and functions are documented.

  • Add new moodle.Commenting.VariableComment sniff to check that the @var tag and its types are used correctly.

  • Add new moodle.Commenting.ValidTag sniff to check that only allowed tags are used.

  • Add new moodle.Commenting.FileExpectedTags sniff to check that files or classes have the correct PHPDoc block with both @copyright and @license information.

    The expected contents of the @license tag can be controlled both by the preferredLicenseRegex property in ruleset files or by the moodleLicenseRegex configuration option in phpcs.xml files and CLI invocations. Setting them to empty string disables the Sniff completely. By default, the "https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later" content is checked.

Note that all the moodle.Commenting sniffs above are part of the migration from moodle-local_moodlecheck to moodle-cs. You can find more information about the deprecation of the former and links to track the progress in the announcement in General developer forum.

Changed

  • Various reorganisations of tests, fixtures and utils affecting a number of sniffs.

v3.4.1

Fixed

  • Solved a problem with the moodle.Commenting.Package sniff when running against arbitrary (not Moodle based) directories.

Full changelog

v3.4.0

Added

  • Add new moodle.PHPUnit.TestCasesAbstract sniff to check that testcase classes are declared abstract.
  • Add new moodle.PHPUnit.TestClassesFinal sniff to check that test classes are declared final.
  • Add new moodle.Commenting.Package sniff to replace those present in moodle-local_moodlecheck.
  • Add new moodle.Commenting.Category sniffs to replace those present in moodle-local_moodlecheck.
  • New phpcs.xml.dist to enforce the coding style to follow by ´moodle-cs´ itself. Basically, PSR12 ruled. CI verified from now on.

Changed

  • Modified own CI scripts, updating various GH actions.
  • Reallocated own tests structure, to better organise them and fixture files.
  • Update composer dependencies to current versions, notably PHP_CodeSniffer (3.9.0) and PHPCompatibility (e5cd2e24).
  • As part of the move to be PSR12 compliant, all the methods used for testing have been converted, without deprecation, to camel case (setStandard(), setSniff(), ...).
  • ACTION REQUIRED: Any clone/fork using moodle-cs and having own tests will need to adapt them to the new method names.

Fixed

  • The moodle.Files.MoodleInternal sniff no longer treats Attributes as side-effects.

Full changelog

Changelog

Sourced from moodlehq/moodle-cs's changelog.

[v3.4.2] - 2024-03-21

Added

  • Add new moodle.Files.LangFilesOrdering sniff to check that lang files are sorted by key.

  • Add new moodle.Commenting.MissingDocBlock sniff to check that all the artifacts (classes, interfaces, traits, ...) and functions are documented.

  • Add new moodle.Commenting.VariableComment sniff to check that the @var tag and its types are used correctly.

  • Add new moodle.Commenting.ValidTag sniff to check that only allowed tags are used.

  • Add new moodle.Commenting.FileExpectedTags sniff to check that files or classes have the correct PHPDoc block with both @copyright and @license information.

    The expected contents of the @license tag can be controlled both by the preferredLicenseRegex property in ruleset files or by the moodleLicenseRegex configuration option in phpcs.xml files and CLI invocations. Setting them to empty string disables the Sniff completely. By default, the "https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later" content is checked.

Note that all the moodle.Commenting sniffs above are part of the migration from moodle-local_moodlecheck to moodle-cs. You can find more information about the deprecation of the former and links to track the progress in the announcement in General developer forum.

Changed

  • Various reorganisations of tests, fixtures and utils affecting a number of sniffs.

[v3.4.1] - 2024-03-08

Fixed

  • Solved a problem with the moodle.Commenting.Package sniff when running against arbitrary (not Moodle based) directories.

[v3.4.0] - 2024-03-07

Added

  • Add new moodle.PHPUnit.TestCasesAbstract sniff to check that testcase classes are declared abstract.
  • Add new moodle.PHPUnit.TestClassesFinal sniff to check that test classes are declared final.
  • Add new moodle.Commenting.Package sniff to replace those present in moodle-local_moodlecheck.
  • Add new moodle.Commenting.Category sniffs to replace those present in moodle-local_moodlecheck.
  • New phpcs.xml.dist to enforce the coding style to follow by moodle-cs itself. Basically, PSR12 ruled. CI verified from now on.

Changed

  • Modified own CI scripts, updating various GH actions.
  • Reallocated own tests structure, to better organise them and fixture files.
  • Update composer dependencies to current versions, notably PHP_CodeSniffer (3.9.0) and PHPCompatibility (e5cd2e24).
  • As part of the move to be PSR12 compliant, all the methods used for testing have been converted, without deprecation, to camel case (setStandard(), setSniff(), ...).
  • ACTION REQUIRED: Any clone/fork using moodle-cs and having own tests will need to adapt them to the new method names.

Fixed

  • The moodle.Files.MoodleInternal sniff no longer treats Attributes as side-effects.
Commits
  • c453d81 Prepare the v3.4.2 release
  • 380108f Move unit test method Missing Docblock to new code and skip test_ methods (#127)
  • 6974134 Merge pull request #126 from andrewnicols/typeNormalisation
  • 6027bd8 Add null,true,false to list of accepted types
  • 20ada0f Move type normalisation to TypeUtil
  • 24bc48a Merge pull request #121 from andrewnicols/varSniff
  • f4c4202 Correct Todo Sniff array<int|string> usage
  • 0638212 Add sniff to detect @​var usage
  • 7c207d5 Merge pull request #125 from andrewnicols/fileHasSniff
  • f136673 Create FileExpectedTags Sniff to check for copyright + license
  • Additional commits viewable in compare view


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
dependabot[bot] commented 7 months ago

Superseded by #234.