This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
Rewrite and fix EnableDisableRulesWalker #2062
Merged
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
andy-hanson
reviewed
Jan 18, 2017
| constructor(sourceFile: ts.SourceFile, options: IOptions, rules: {[name: string]: any}) { | ||
| super(sourceFile, options); | ||
| export class EnableDisableRulesWalker { | ||
| private enableDisableRuleMap: {[rulename: string]: IEnableDisablePosition[]}; |
There was a problem hiding this comment.
I wanted to change that, but there are many exported functions that expect this to be an object. So this would require a larger rewrite.
andy-hanson
reviewed
Jan 18, 2017
|
|
||
| return ruleStateMap[ruleStateMap.length - 1].isEnabled; | ||
| private handleComment(commentText: string, pos: TokenPosition) { | ||
| const match = /^\s*tslint:/.exec(commentText); |
There was a problem hiding this comment.
How about /^\s*tslint:((enable|disable)(-(line|next-line))?)/ and use the capture groups?
andy-hanson
reviewed
Jan 18, 2017
|
|
||
| constructor(sourceFile: ts.SourceFile, options: IOptions, rules: {[name: string]: any}) { | ||
| super(sourceFile, options); | ||
| export class EnableDisableRulesWalker { |
There was a problem hiding this comment.
Since there's no walk() this could use a name change.
There was a problem hiding this comment.
Sounds reasonable. Open for suggestions
|
Also, I don't think anyone is using this class so I don't think it's breaking |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PR checklist
What changes did you make?
enable-lineanddisable-lineswitched from the start of the line only to the end of the comment. That is correct for single line comments, but multiline comments can be followed by other statements.enable-next-lineanddisable-next-lineswitched from the start of the comment instead of the start of the next line./*tslint:disable foo bar*/removedbar*/resulting in swiching onlyfoo/*tslint:disable foo*/removedfoo*/resulting in switching all rules/*tslint:disable:foo*/tried to switch rulefoo*/, which does not exist -> nothing changedIs there anything you'd like reviewers to focus on?
Don't know if this is a breaking change, because it used to be this way for a while, although not documented.
Furthermore this changes the API of
EnableDisableRulesWalkerwhich is no longer a subclass ofRuleWalker. This class is exported by the package, so it could be used by others. Don't know if care or if we even want to support this, because technically everyRulecould be used from outside the project.If we consider this an implementation detail, we should remove the export in
index.tsfor the next major version. This should also be done for all other "internal" functions and classes.