Skip to content

Commit

Permalink
Prepare the v3.4.2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
stronk7 committed Mar 21, 2024
1 parent 380108f commit c453d81
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@ This project adheres to [Semantic Versioning](https://semver.org/).
The format of this change log follows the advice given at [Keep a CHANGELOG](https://keepachangelog.com).

## [Unreleased]
## [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](https://moodle.org/mod/forum/discuss.php?d=455786).

### 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.
Expand Down Expand Up @@ -167,7 +182,8 @@ All features are maintained and no new features have been introduced to either t

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

[Unreleased]: https://github.com/moodlehq/moodle-cs/compare/v3.4.1...main
[Unreleased]: https://github.com/moodlehq/moodle-cs/compare/v3.4.2...main
[v3.4.2]: https://github.com/moodlehq/moodle-cs/compare/v3.4.1...v3.4.2
[v3.4.1]: https://github.com/moodlehq/moodle-cs/compare/v3.4.0...v3.4.1
[v3.4.0]: https://github.com/moodlehq/moodle-cs/compare/v3.3.15...v3.4.0
[v3.3.15]: https://github.com/moodlehq/moodle-cs/compare/v3.3.14...v3.3.15
Expand Down

0 comments on commit c453d81

Please sign in to comment.