Skip to content

Commit 3a2cdfb

Browse files
committed
Readme/Changelog: update for release of v 1.2.0
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
1 parent 5745b7a commit 3a2cdfb

File tree

3 files changed

+33
-9
lines changed

3 files changed

+33
-9
lines changed

CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,26 @@ This projects adheres to [Keep a CHANGELOG](http://keepachangelog.com/) and uses
1010
_Nothing yet._
1111

1212

13+
## [1.2.0] - 2022-09-23
14+
15+
### Added
16+
* An XSD schema for PHPCS sniff documentation files. Thanks to [@dingo_d] for this awesome contribution!
17+
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.
18+
Information about how to use this new feature has been added to the README.
19+
* PHPCSDebug/TokenList sniff: tabs and spacess will now be visualized in whitespace-only tokens. In comment tokens, leading and trailing whitespace will be visualized.
20+
Whitespace will also be visualized for any token which has (or should have) undergone a "tabs to spaces" conversion.
21+
22+
### Changed
23+
* 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.
24+
* The package will now identify itself as a static analysis tool to Composer. Thanks [@GaryJones]!
25+
* Various other code and documentation improvements.
26+
* Miscellaneous updates to the development environment and CI scripts.
27+
28+
### Fixed
29+
* FeatureComplete: wrong error message was displayed for missing test case files in colors enabled mode.
30+
* 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.
31+
32+
1333
## [1.1.1] - 2022-04-28
1434

1535
### Changed
@@ -49,8 +69,12 @@ Initial release containing:
4969

5070

5171
[Unreleased]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/stable...HEAD
72+
[1.2.0]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.1.1...1.2.0
5273
[1.1.1]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.1.0...1.1.1
5374
[1.1.0]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.0.1...1.1.0
5475
[1.0.1]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.0.0...1.0.1
5576

5677
[Composer PHPCS plugin]: https://github.com/PHPCSStandards/composer-installer
78+
79+
[@dingo_d]: https://github.com/dingo-d
80+
[@GaryJones]: https://github.com/GaryJones

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -153,23 +153,23 @@ Ptr | Ln | Col | Cond | ( #) | Token Type | [len]: Content
153153
2 | L3 | C 1 | CC 0 | ( 0) | T_COMMENT | [ 32]: // Boolean not operator: All OK.
154154
155155
3 | L4 | C 1 | CC 0 | ( 0) | T_IF | [ 2]: if
156-
4 | L4 | C 3 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
156+
4 | L4 | C 3 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
157157
5 | L4 | C 4 | CC 0 | ( 0) | T_OPEN_PARENTHESIS | [ 1]: (
158-
6 | L4 | C 5 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
158+
6 | L4 | C 5 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
159159
7 | L4 | C 6 | CC 0 | ( 1) | T_CONSTANT_ENCAPSED_STRING | [ 4]: 'bb'
160-
8 | L4 | C 10 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
160+
8 | L4 | C 10 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
161161
9 | L4 | C 11 | CC 0 | ( 1) | T_IS_NOT_IDENTICAL | [ 3]: !==
162-
10 | L4 | C 14 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
162+
10 | L4 | C 14 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
163163
11 | L4 | C 15 | CC 0 | ( 1) | T_CONSTANT_ENCAPSED_STRING | [ 4]: 'bb'
164-
12 | L4 | C 19 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
164+
12 | L4 | C 19 | CC 0 | ( 1) | T_WHITESPACE | [ 1]:
165165
13 | L4 | C 20 | CC 0 | ( 0) | T_CLOSE_PARENTHESIS | [ 1]: )
166-
14 | L4 | C 21 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
166+
14 | L4 | C 21 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
167167
15 | L4 | C 22 | CC 0 | ( 0) | T_OPEN_CURLY_BRACKET | [ 1]: {
168168
16 | L4 | C 23 | CC 0 | ( 0) | T_WHITESPACE | [ 0]:
169169
170-
17 | L5 | C 1 | CC 0 | ( 0) | T_WHITESPACE | [ 1]: \t
170+
17 | L5 | C 1 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
171171
18 | L5 | C 2 | CC 0 | ( 0) | T_IF | [ 2]: if
172-
19 | L5 | C 4 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
172+
19 | L5 | C 4 | CC 0 | ( 0) | T_WHITESPACE | [ 1]:
173173
20 | L5 | C 5 | CC 0 | ( 0) | T_OPEN_PARENTHESIS | [ 1]: (
174174
21 | L5 | C 6 | CC 0 | ( 0) | T_WHITESPACE | [ 0]:
175175
```

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.1.1
1+
1.2.0

0 commit comments

Comments
 (0)