CHANGELOG.md

Change log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

The format of this change log follows the advice given at Keep a CHANGELOG.

Unreleased

v3.4.10 - 2024-07-04

Changed

• The moodle.NamingConventions.ValidFunctionName sniff will now ignore errors on methods employing the #[\Override] attribute.
• The moodle.Commenting.MissingDocblock sniff no longer warns about missing docs on non-global anonymous classes, for example those written as an instance class in a unit test.

Fixed

• Fixed an edge case leading to the file phpdoc block being incorrectly detected by various sniffs.
• Fixed a couple of problems with the moodle.Files.BoilerplateComment related to empty comment lines and to comments in the <?php open tag line.

v3.4.9 - 2024-06-19

Fixed

• Fixed a recent regression by allowing to the moodle.Files.BoilerplateComment sniff to contain "extra" consecutive comment lines immediately after the official boilerplate ends.

v3.4.8 - 2024-06-14

Added

• The existing moodle.PHPUnit.TestCaseCovers sniff now detects multiple uses of the @coversDefaultClass annotation. Only one is allowed by class.
• The existing moodle.Files.BoilerplateComment sniff now performs more checks (spacing, placement, blank lines, ...) and is able to fix many of them.

Changed

• Made codes for moodle.Commenting.MissingDocblock more specific to the scenario (Fixes #154).

v3.4.7 - 2024-05-31

Added

• Add new moodle.PHPUnit.ParentSetUpTearDown sniff to verify, among other things, that all the setUp(), tearDown(), setUpBeforeClass() and tearDownAfterClass() methods in unit tests are properly calling to their parent counterparts. Applies to Moodle 4.5 and up.
• Add new moodle.Commenting.ConstructorReturn sniff to check that constructors do not document a return value.

Changed

• Update composer dependencies to current versions, notably PHP_CodeSniffer (3.10.1) and PHPCompatibility (96072c30).
• The moodle.Commenting.MissingDocblock sniff will now detect use of the Override attribute (Fixes #155).

Fixed

• Various fixes to own (GH workflow) integration tests.

v3.4.6 - 2024-04-03

Fixed

• Solved a problem where Windows file paths were not normalised leading to false positive results on some path-based sniffs.
• Solved a problem with fetching the name of an anonymous class, or closure.

v3.4.5 - 2024-03-31

Fixed

• Solved a problem when checking constructor's promoted properties that was leading to some false positives.

v3.4.4 - 2024-03-29

Changed

• Improved some internal moodle.Util.Docblocks helpers and uses.

Fixed

• The @deprecated tag is allowed to be alone within PHPDoc blocks.

v3.4.3 - 2024-03-27

Added

• Add new moodle.Commenting.DocblockDescription sniff to check that all the artifacts (classes, interfaces, traits, ...) and functions PHPDoc blocks have some description.

Changed

• The moodle.Commenting.MissingDocBlock sniff now also checks that constants are documented.

Fixed

• Solved a problem with file-level PHPDoc blocks not controlling the required blank lines after it.
• Fixed the PHPDoc block detection when multi-line PHP 8 attributes are used in the middle.

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.

v3.3.15 - 2024-02-15

Added

• Function declaration lines are verified to have correct whitespace separation (1 space or 0 spaces) between all their parts.

Changed

• Modified own CI scripts, bumping them from NodeJS 16 to NodeJS 20 actions.

Fixed

• PHP enum uses are not considered side-effects by some sniffs.
• PHPDoc blocks are allowed before PHP attributes, that are immediately followed by the PHP structure.
• The PHPUnit dataProvider sniff now reports the problematic lines properly.
• The valid variable names sniff now detects properly escaped (\$) contents within double quoted strings and they aren't considered - for validation - anymore.
• Avoided PHP error when checking empty PHP files.

v3.3.14 - 2024-01-26

Changed

• Modified internal CI scripts towards better Codecov future support.

Fixed

• Solved a problem with some moodle.PHPUnit Sniffs running an endless loop when processing abstract test methods.

v3.3.13 - 2024-01-19

Changed

• Applied various internal, coding and CI improvements:
  • Modified own CI tests to behave better.
  • Locked nikic/php-parser to v4 to avoid jumping to v5 yet (PHP compatibility).
• Updated composer dependencies to current versions, notably PHP_CodeSniffer (3.8.1).

Added

• New moodle.Commenting.TodoComment Sniff will be in charge to control that all the todo comments in core (both // TODO and @todo ones) always come with a link to the MDL project in the Tracker.

  Its behaviour can be controlled both by the commentRequiredRegex property in ruleset files or by the moodleTodoCommentRegex configuration option in phpcs.xml files and CLI invocations. Setting them to empty string disables the Sniff completely.

v3.3.12 - 2023-12-19

Changed

• Moved PHP_CodeSniffer from squizlabs (being abandoned) to PHPCSStandars (new repository). Everybody is welcome to contribute or help sponsoring the project!
• Update composer dependencies to current versions, notably PHP_CodeSniffer (3.8.0) and PHPCompatibility (306cd263).
• Applied various internal, coding and CI improvements:
  • Ruleset fixes.
  • PHP 8.3 compliance achieved.
  • PHP 8.3 GitHub workflows support.

v3.3.11 - 2023-11-29

Changed

• Amended the installation instructions to be able to use some dev dependencies.
• Moved all links to "master" branches to their new "main" counterparts.

Fixed

• Solved a problem with the CommaAfterLast Sniff that was causing some valid multi-line arrays to be identified as invalid, missing commas.

v3.3.10 - 2023-10-20

Added

• Detected various duplicate array keys cases (code smell).
• Enforced, for Moodle 4.4dev and up, that all the test methods have a return type specified (normally : void).

v3.3.9 - 2023-09-26

Added

• Defined (via .gitattributes) which files must not be part of distribution (generated .zip & .gz in GitHub, --prefer-dist in Composer, ...) packages. This includes docs, ci files, tests... Note that it's still possible to download the complete packages (using git clone, --prefer-source with Composer, ...).

Fixed

• Removed the PSR1.Classes.ClassDeclaration.MissingNamespace sniff from the moodle-extra standard because it was reporting some (for Moodle) false positives.

v3.3.8 - 2023-09-22

Added

• Detect PHPUnit data provider (@dataProvider) declarations using () after the function name.

Fixed

• Fixed a problem with some non test files (coverage.php, ...) being managed as such.

v3.3.7 - 2023-09-22

Added

• Require trailing commas in multi-line arrays.
• Verify that both namespace and use (class import) declarations don't use leading slashes (\).
• Verify various aspects/common mistakes related with PHPUnit data providers:
  • Private providers.
  • Missing providers.
  • Providers with incorrect names.
  • Providers with wrong return types.
  • Non-static providers.

Fixed

• Fixed incorrect handling of abstract methods within PHPUnit sniffs.

v3.3.6 - 2023-09-15

Added

• A new moodle-extra coding standard which moves towards a more PSR-12 compliant coding style.
• Enforce the use of the short array syntax ([]), warning about the long alternative (array()): Generic.Arrays.DisallowLongArraySyntax. This will be raised from warning to error in 1 year.

v3.3.5 - 2023-08-28

Changed

• Update composer dependencies to current versions, notably PHPCompatibility (0a17f9ed).
• Enforce the use of && and || logical operators, now erroring (after a grace period of 1 year) with and and or uses: Squiz.Operators.ValidLogicalOperators

v3.3.4 - 2023-05-28

Changed

• Update composer dependencies to current versions, notably PHPCompatibility (70e4ca24).

Added

• Various internal, code coverage related, improvements.
  • Add GHA PHP 8.2 support.
  • Upload and integrate the repository with Codecov, for better tracking of changes.
  • Completely cover the MoodleUtil class, in charge of providing important information about Moodle (versions, branches, components...)

v3.3.3 - 2023-03-14

Removed

• Revert the check for the only one-space rule before the assignment operator @ Squiz.WhiteSpace.OperatorSpacing as an interim solution while we revisit MDLSITE-6594.

v3.3.2 - 2023-02-13

Added

• Check for one (and only one) space before assignment operator @ Squiz.WhiteSpace.OperatorSpacing

v3.3.1 - 2023-01-19

Fixed

• Updated the outdated list of valid magic methods.

v3.3.0 - 2023-01-13

Added

• Enforce the use of && and || logical operators, warning about and and or: Squiz.Operators.ValidLogicalOperators

Changed

• Many internal changes towards better self-testing and integration with other tools (GH workflows, codechecker, core, phpunit...).
• Upgraded the PHPCompatibility standard from 3 years old version 9.3.5 (no releases since then) to current development version.

Fixed

• Stop considering class_alias like a side effect.
• Add back the Squiz.Arrays.ArrayBracketSpacing sniff.

v3.2.0 - 2022-02-28

This release is the first release of the new moodlehq/moodle-cs packages.

These rules, in an identical form, were previously available as a part of the local_codechecker Moodle plugin but are being moved to their own repository to make installation friendlier for developers.

All features are maintained and no new features have been introduced to either the rules, or the sniffs.

All the details about previous releases can be found in local_codechecker own change log.