This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
Use --fix instead of -t applyFixes #1697
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
1efd92d to
c9511d1
Compare
adidahiya
suggested changes
Nov 8, 2016
| @@ -47,5 +47,5 @@ export interface IFormatterMetadata { | |||
| export type ConsumerType = "human" | "machine"; | |||
|
|
|||
| export interface IFormatter { | |||
| format(failures: RuleFailure[]): string; | |||
| format(failures: RuleFailure[], fixes?: RuleFailure[]): string; | |||
There was a problem hiding this comment.
is the idea that fixes are only supplied to this method if --fix is enabled in the CLI? can you leave a comment explaining that?
| @@ -50,6 +50,9 @@ let processed = optimist | |||
| alias: "exclude", | |||
| describe: "exclude globs from path expansion", | |||
| }, | |||
| fix: { | |||
| describe: "Fixes some linting errors (may overwrite linted files)", | |||
There was a problem hiding this comment.
"some" isn't great language -- can you just use the same description you have on L159
| this.failures.push(ruleFailure); | ||
| } | ||
| // make a 2nd pass if there were any fixes because the positions may be off | ||
| if (!this.options.fix || this.fixes.length > 0) { |
There was a problem hiding this comment.
the first part of this conditional expression looks unintuitive to me -- don't you want to only continue if this.options.fix is true?
There was a problem hiding this comment.
You want to run the linter at least once if fix is false. Will try to clarify
|
@adidahiya made changes |
|
heads up @alexeagle |
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
--fixinstead of-t applyFixes#1684What changes did you make?
When fixes are applied, they are applied first. If a rule triggers a fix, the AST is reloaded to prevent one fix from overwriting another fix. When all fixes are complete, the sourceFile is linted again if there were fixes. That way, we don't show errors that are already fixed and the positions will be correct.
here's what it looks like when using the prose formatter (the only formatter to output that there are fixes) when there is 1 issue fix and 1 remaining issue that can't be fixed: