Skip to content

Commit

Permalink
Readme/Changelog: update for release of v 1.2.0
Browse files Browse the repository at this point in the history
Includes:
* Mention of all relevant changes.
* Adding a link for the version diff.
* Updating the `VERSION` document with the version nr for the release.
* Updating the PHPCSDebug output sample in the README
  • Loading branch information
jrfnl committed Sep 23, 2022
1 parent 5745b7a commit 3a2cdfb
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 9 deletions.
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,26 @@ This projects adheres to [Keep a CHANGELOG](http://keepachangelog.com/) and uses
_Nothing yet._


## [1.2.0] - 2022-09-23

### Added
* An XSD schema for PHPCS sniff documentation files. Thanks to [@dingo_d] for this awesome contribution!
The XSD schema can be added to PHPCS sniff documentation XML files and can be used to verify these files comply with the requirements set by PHPCS, so the documentation will display correctly when using the PHPCS `--generator=...` feature.
Information about how to use this new feature has been added to the README.
* PHPCSDebug/TokenList sniff: tabs and spacess will now be visualized in whitespace-only tokens. In comment tokens, leading and trailing whitespace will be visualized.
Whitespace will also be visualized for any token which has (or should have) undergone a "tabs to spaces" conversion.

### Changed
* PHPCSDebug/TokenList sniff: the `'orig_content'` will now be shown for all tokens which have undergone a "tabs to spaces" conversion. Previously it was only shown for whitespace tokens which had been converted.
* The package will now identify itself as a static analysis tool to Composer. Thanks [@GaryJones]!
* Various other code and documentation improvements.
* Miscellaneous updates to the development environment and CI scripts.

### Fixed
* FeatureComplete: wrong error message was displayed for missing test case files in colors enabled mode.
* PHPCSDebug/TokenList sniff: for rare edge cases when PHPCS has not set the `'length'` information for a token, the length will no longer be calculated, but will show as `?`. This prevents a mismatch/misrepresentation between the output of the sniff and the real token array.


## [1.1.1] - 2022-04-28

### Changed
Expand Down Expand Up @@ -49,8 +69,12 @@ Initial release containing:


[Unreleased]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/stable...HEAD
[1.2.0]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.1.1...1.2.0
[1.1.1]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.1.0...1.1.1
[1.1.0]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.0.1...1.1.0
[1.0.1]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.0.0...1.0.1

[Composer PHPCS plugin]: https://github.com/PHPCSStandards/composer-installer

[@dingo_d]: https://github.com/dingo-d
[@GaryJones]: https://github.com/GaryJones
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,23 +153,23 @@ Ptr | Ln | Col | Cond | ( #) | Token Type | [len]: Content
2 | L3 | C 1 | CC 0 | ( 0) | T_COMMENT | [ 32]: // Boolean not operator: All OK.
3 | L4 | C 1 | CC 0 | ( 0) | T_IF | [ 2]: if
4 | L4 | C 3 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
4 | L4 | C 3 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
5 | L4 | C 4 | CC 0 | ( 0) | T_OPEN_PARENTHESIS | [ 1]: (
6 | L4 | C 5 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
6 | L4 | C 5 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
7 | L4 | C 6 | CC 0 | ( 1) | T_CONSTANT_ENCAPSED_STRING | [ 4]: 'bb'
8 | L4 | C 10 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
8 | L4 | C 10 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
9 | L4 | C 11 | CC 0 | ( 1) | T_IS_NOT_IDENTICAL | [ 3]: !==
10 | L4 | C 14 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
10 | L4 | C 14 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
11 | L4 | C 15 | CC 0 | ( 1) | T_CONSTANT_ENCAPSED_STRING | [ 4]: 'bb'
12 | L4 | C 19 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
12 | L4 | C 19 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
13 | L4 | C 20 | CC 0 | ( 0) | T_CLOSE_PARENTHESIS | [ 1]: )
14 | L4 | C 21 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
14 | L4 | C 21 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
15 | L4 | C 22 | CC 0 | ( 0) | T_OPEN_CURLY_BRACKET | [ 1]: {
16 | L4 | C 23 | CC 0 | ( 0) | T_WHITESPACE | [ 0]:
17 | L5 | C 1 | CC 0 | ( 0) | T_WHITESPACE | [ 1]: \t
17 | L5 | C 1 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
18 | L5 | C 2 | CC 0 | ( 0) | T_IF | [ 2]: if
19 | L5 | C 4 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
19 | L5 | C 4 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
20 | L5 | C 5 | CC 0 | ( 0) | T_OPEN_PARENTHESIS | [ 1]: (
21 | L5 | C 6 | CC 0 | ( 0) | T_WHITESPACE | [ 0]:
```
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.1.1
1.2.0

0 comments on commit 3a2cdfb

Please sign in to comment.