Generic/DisallowSpaceIndent: multi line comments and the case of the moving space #1599
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Aug 10, 2017
jrfnl
force-pushed
the
feature/disallowspaceindent-multi-line-comments
branch
from
bfcc2a0
to
29c9155
Compare
|
Rebased for merge conflicts. |
jrfnl
force-pushed
the
feature/disallowspaceindent-multi-line-comments
branch
from
29c9155
to
4efa1a7
Compare
…ine `/* */` comments
Code sample:
```php
/*
* Some text
*/
```
The tokenizer tokenizes this code as:
```
T_WHITESPACE T_COMMENT
T_COMMENT
T_COMMENT
```
In other words, the whitespace at the start of subsequent comment lines is tokenized as part of the `T_COMMENT`.
In effect, this meant that these lines would not throw the appropriate error, nor be fixed by this sniff.
This commit fixes that.
Includes unit tests.
Given this code: ```php wp_die( $api ); // Tab - Space - Tab - Tab ``` with tab width set to `4`, `wp_die()` would start in column 13. The sniff was currently fixing this to: ```php wp_die( $api ); // Tab - Tab - Tab - Space ``` which changed the start column to 14 and changed the "space hidden before a tab" to precision alignment. This commit fixes that and is a further iteration building onto the improvements in 1404. The above code will now be fixed as: ```php wp_die( $api ); // Tab - Tab - Tab ``` Notes: * As the tabs in whitespace at the start of `T_INLINE_HTML` and `T_COMMENT` tokens is not replaced by spaces in the `content` by the tokenizer, this has to be done within the sniff to determine what the correct length of the whitespace should be. * Basing the correction of the space-based length of the whitespace allows for fixing with higher precision. * Incidentally, this also fixes one of the metrics being recorded incorrectly. For in-depth details of the effect on the metrics of this fix, please see: https://gist.github.com/jrfnl/5e2d75894c8e60a8f314b9fcb0ad3f62 * The `tabWidth` is now set in the unit test file.
jrfnl
force-pushed
the
feature/disallowspaceindent-multi-line-comments
branch
from
4efa1a7
to
eb3c55f
Compare
|
Rebased for merge conflicts & code style... |
|
I never even noticed that the unit test for this was wrong with that mixed space/tab indent. Thanks a lot for these changes. |
|
You're welcome. Thanks for merging this. |
|
@gsherwood Greg, if you have a chance, it'd be great if you could also have a look at #1607 which basically fixes the same thing for the comments for the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Allow the sniff to fix space indents for multi-line
/* */commentsGiven this code sample (all lines indented with spaces):
The tokenizer tokenizes this code as:
In other words, the whitespace at the start of subsequent comment lines is tokenized as part of the
T_COMMENT.In effect, this meant that these lines would not throw the appropriate error, nor be fixed by this sniff.
This commit fixes that.
Includes unit tests.
Fix the case of the moving space
This is one of the issues I came across during reviews related to the WP core code style fix effort - WordPress/WordPress-Coding-Standards#977
Given this code:
with tab width set to
4,wp_die()would start in column 13.The sniff was currently fixing this to:
which changed the start column to 14 and changed the "space hidden before a tab" to precision alignment.
This commit fixes that and is a further iteration building onto the improvements in #1404 and reverts the change in the fixes for line 22 and 24.
The above code will now be fixed as:
Notes:
* As the tabs in whitespace at the start of
T_INLINE_HTMLandT_COMMENTtokens is not replaced by spaces in thecontentby the tokenizer, this has to be done within the sniff to determine what the correct length of the whitespace should be.* Basing the correction on the space-based length of the whitespace allows for fixing with higher precision.
* Incidentally, this also fixes one of the metrics being recorded incorrectly. For in-depth details of the effect on the metrics of this fix, please see: https://gist.github.com/jrfnl/5e2d75894c8e60a8f314b9fcb0ad3f62
* The
tabWidthis now set in the unit test file.It goes without saying, that for the fixes and the metrics to be accurate, the sniff has to be run with a tab width set.