Skip to content

Commit c453d81

Browse files
committed
Prepare the v3.4.2 release
1 parent 380108f commit c453d81

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

CHANGELOG.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,21 @@ This project adheres to [Semantic Versioning](https://semver.org/).
66
The format of this change log follows the advice given at [Keep a CHANGELOG](https://keepachangelog.com).
77

88
## [Unreleased]
9+
## [v3.4.2] - 2024-03-21
10+
### Added
11+
- Add new `moodle.Files.LangFilesOrdering` sniff to check that lang files are sorted by key.
12+
- Add new `moodle.Commenting.MissingDocBlock` sniff to check that all the artifacts (classes, interfaces, traits, ...) and functions are documented.
13+
- Add new `moodle.Commenting.VariableComment` sniff to check that the `@var` tag and its types are used correctly.
14+
- Add new `moodle.Commenting.ValidTag` sniff to check that only allowed tags are used.
15+
- Add new `moodle.Commenting.FileExpectedTags` sniff to check that files or classes have the correct PHPDoc block with both `@copyright` and `@license` information.
16+
17+
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.
18+
19+
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](https://moodle.org/mod/forum/discuss.php?d=455786).
20+
21+
### Changed
22+
- Various reorganisations of tests, fixtures and utils affecting a number of sniffs.
23+
924
## [v3.4.1] - 2024-03-08
1025
### Fixed
1126
- Solved a problem with the `moodle.Commenting.Package` sniff when running against arbitrary (not Moodle based) directories.
@@ -167,7 +182,8 @@ All features are maintained and no new features have been introduced to either t
167182

168183
All the details about [previous releases] can be found in [local_codechecker](https://github.com/moodlehq/moodle-local_codechecker) own change log.
169184

170-
[Unreleased]: https://github.com/moodlehq/moodle-cs/compare/v3.4.1...main
185+
[Unreleased]: https://github.com/moodlehq/moodle-cs/compare/v3.4.2...main
186+
[v3.4.2]: https://github.com/moodlehq/moodle-cs/compare/v3.4.1...v3.4.2
171187
[v3.4.1]: https://github.com/moodlehq/moodle-cs/compare/v3.4.0...v3.4.1
172188
[v3.4.0]: https://github.com/moodlehq/moodle-cs/compare/v3.3.15...v3.4.0
173189
[v3.3.15]: https://github.com/moodlehq/moodle-cs/compare/v3.3.14...v3.3.15

0 commit comments

Comments
 (0)