Skip to content

Commit 2b9fa1e

Browse files
committed
Readme/Changelog: update for release of v 1.1.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 cd65082 commit 2b9fa1e

File tree

3 files changed

+42
-29
lines changed

3 files changed

+42
-29
lines changed

CHANGELOG.md

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

1212

13+
## [1.1.0] - 2020-12-20
14+
15+
### Added
16+
* New column "nested parentheses count" - `( #)` - in the output of the `PHPCSDebug.Debug.TokenList` sniff.
17+
18+
### Changed
19+
* The minimum required PHPCS version for the `PHPCSDebug` standard has been raised to PHPCS `3.1.0`.
20+
* `PHPCSDebug.Debug.TokenList`: The column separator has been changed from `::` to `|`.
21+
* All functionality is now also tested against PHP 8.0.
22+
* Miscellaneous updates to the development environment and CI scripts.
23+
24+
1325
## [1.0.1] - 2020-06-28
1426

1527
### Changed
@@ -25,7 +37,8 @@ Initial release containing:
2537
* A `PHPCSDebug` standard to help debugging sniffs.
2638

2739

28-
[Unreleased]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/master...HEAD
40+
[Unreleased]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/stable...HEAD
41+
[1.1.0]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.0.1...1.1.0
2942
[1.0.1]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.0.0...1.0.1
3043

3144
[Dealerdirect Composer PHPCS plugin]: https://github.com/Dealerdirect/phpcodesniffer-composer-installer/

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -137,34 +137,34 @@ phpcs ./SniffNameUnitTest.inc --standard=YourStandard,PHPCSDebug --sniffs=YourSt
137137

138138
The output will look something along the lines of:
139139
```
140-
Ptr :: Ln :: Col :: Cond :: Token Type :: [len]: Content
140+
Ptr | Ln | Col | Cond | ( #) | Token Type | [len]: Content
141141
-------------------------------------------------------------------------
142-
0 :: L1 :: C 1 :: CC 0 :: T_OPEN_TAG :: [5]: <?php
143-
144-
1 :: L2 :: C 1 :: CC 0 :: T_WHITESPACE :: [0]:
145-
146-
2 :: L3 :: C 1 :: CC 0 :: T_COMMENT :: [32]: // Boolean not operator: All OK.
147-
148-
3 :: L4 :: C 1 :: CC 0 :: T_IF :: [2]: if
149-
4 :: L4 :: C 3 :: CC 0 :: T_WHITESPACE :: [1]:
150-
5 :: L4 :: C 4 :: CC 0 :: T_OPEN_PARENTHESIS :: [1]: (
151-
6 :: L4 :: C 5 :: CC 0 :: T_WHITESPACE :: [1]:
152-
7 :: L4 :: C 6 :: CC 0 :: T_CONSTANT_ENCAPSED_STRING :: [4]: 'bb'
153-
8 :: L4 :: C 10 :: CC 0 :: T_WHITESPACE :: [1]:
154-
9 :: L4 :: C 11 :: CC 0 :: T_IS_NOT_IDENTICAL :: [3]: !==
155-
10 :: L4 :: C 14 :: CC 0 :: T_WHITESPACE :: [1]:
156-
11 :: L4 :: C 15 :: CC 0 :: T_CONSTANT_ENCAPSED_STRING :: [4]: 'bb'
157-
12 :: L4 :: C 19 :: CC 0 :: T_WHITESPACE :: [1]:
158-
13 :: L4 :: C 20 :: CC 0 :: T_CLOSE_PARENTHESIS :: [1]: )
159-
14 :: L4 :: C 21 :: CC 0 :: T_WHITESPACE :: [1]:
160-
15 :: L4 :: C 22 :: CC 0 :: T_OPEN_CURLY_BRACKET :: [1]: {
161-
16 :: L4 :: C 23 :: CC 0 :: T_WHITESPACE :: [0]:
162-
163-
17 :: L5 :: C 1 :: CC 0 :: T_WHITESPACE :: [1]: \t
164-
18 :: L5 :: C 2 :: CC 0 :: T_IF :: [2]: if
165-
19 :: L5 :: C 4 :: CC 0 :: T_WHITESPACE :: [1]:
166-
20 :: L5 :: C 5 :: CC 0 :: T_OPEN_PARENTHESIS :: [1]: (
167-
21 :: L5 :: C 6 :: CC 0 :: T_WHITESPACE :: [0]:
142+
0 | L1 | C 1 | CC 0 | ( 0) | T_OPEN_TAG | [5]: <?php
143+
144+
1 | L2 | C 1 | CC 0 | ( 0) | T_WHITESPACE | [0]:
145+
146+
2 | L3 | C 1 | CC 0 | ( 0) | T_COMMENT | [32]: // Boolean not operator: All OK.
147+
148+
3 | L4 | C 1 | CC 0 | ( 0) | T_IF | [2]: if
149+
4 | L4 | C 3 | CC 0 | ( 0) | T_WHITESPACE | [1]:
150+
5 | L4 | C 4 | CC 0 | ( 0) | T_OPEN_PARENTHESIS | [1]: (
151+
6 | L4 | C 5 | CC 0 | ( 1) | T_WHITESPACE | [1]:
152+
7 | L4 | C 6 | CC 0 | ( 1) | T_CONSTANT_ENCAPSED_STRING | [4]: 'bb'
153+
8 | L4 | C 10 | CC 0 | ( 1) | T_WHITESPACE | [1]:
154+
9 | L4 | C 11 | CC 0 | ( 1) | T_IS_NOT_IDENTICAL | [3]: !==
155+
10 | L4 | C 14 | CC 0 | ( 1) | T_WHITESPACE | [1]:
156+
11 | L4 | C 15 | CC 0 | ( 1) | T_CONSTANT_ENCAPSED_STRING | [4]: 'bb'
157+
12 | L4 | C 19 | CC 0 | ( 1) | T_WHITESPACE | [1]:
158+
13 | L4 | C 20 | CC 0 | ( 0) | T_CLOSE_PARENTHESIS | [1]: )
159+
14 | L4 | C 21 | CC 0 | ( 0) | T_WHITESPACE | [1]:
160+
15 | L4 | C 22 | CC 0 | ( 0) | T_OPEN_CURLY_BRACKET | [1]: {
161+
16 | L4 | C 23 | CC 0 | ( 0) | T_WHITESPACE | [0]:
162+
163+
17 | L5 | C 1 | CC 0 | ( 0) | T_WHITESPACE | [1]: \t
164+
18 | L5 | C 2 | CC 0 | ( 0) | T_IF | [2]: if
165+
19 | L5 | C 4 | CC 0 | ( 0) | T_WHITESPACE | [1]:
166+
20 | L5 | C 5 | CC 0 | ( 0) | T_OPEN_PARENTHESIS | [1]: (
167+
21 | L5 | C 6 | CC 0 | ( 0) | T_WHITESPACE | [0]:
168168
```
169169

170170
PHPCS itself can also display similar information using the `-vv` or `-vvv` verbosity flags, however, when using those, you will receive a *lot* more information than just the token list and, while useful for debugging PHPCS itself, the additional information is mostly just noise when developing a sniff.

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.0.1
1+
1.1.0

0 commit comments

Comments
 (0)