This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
quotemark-rule: single/double options can be at any index in arg list #3114
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
ajafff
reviewed
Aug 14, 2017
src/rules/quotemarkRule.ts
Outdated
| @@ -141,3 +133,21 @@ function walk(ctx: Lint.WalkContext<Options>) { | |||
| ts.forEachChild(node, cb); | |||
| }); | |||
| } | |||
|
|
|||
| function hasSingleDoublePreference(args: any[]): boolean { | |||
| for (const arg of args) { | |||
There was a problem hiding this comment.
you can simply return getQuotemarkPreference(args) !== undefined;
src/rules/quotemarkRule.ts
Outdated
| @@ -75,18 +73,12 @@ export class Rule extends Lint.Rules.AbstractRule { | |||
| } | |||
|
|
|||
| public isEnabled(): boolean { | |||
| return super.isEnabled() && (this.ruleArguments[0] === OPTION_SINGLE || this.ruleArguments[0] === OPTION_DOUBLE); | |||
| return super.isEnabled() && hasSingleDoublePreference(this.ruleArguments); | |||
There was a problem hiding this comment.
If we remove this method, the rule will default to double quotes? I think that's more reasonable than just doing nothing.
There was a problem hiding this comment.
I totally agree and yes removing that call will set default to double quotes.
| } | ||
|
|
||
| public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] { | ||
| const args = this.ruleArguments; | ||
| if (args.length > 0) { | ||
| if (args[0] !== OPTION_SINGLE && args[0] !== OPTION_DOUBLE) { | ||
| showWarningOnce(`Warning: First argument to 'quotemark' rule should be "${OPTION_SINGLE}" or "${OPTION_DOUBLE}"`); |
There was a problem hiding this comment.
It's funny that this code would show the correct warning, but was never executed because the rule was disabled.
src/rules/quotemarkRule.ts
Outdated
| function getQuotemarkPreference(args: any[]): string | undefined { | ||
| for (const arg of args) { | ||
| if (arg === OPTION_SINGLE || arg === OPTION_DOUBLE) { | ||
| return (arg === OPTION_SINGLE) ? OPTION_SINGLE : OPTION_DOUBLE; |
src/rules/quotemarkRule.ts
Outdated
| @@ -1,6 +1,6 @@ | |||
| /** | |||
| * @license | |||
| * Copyright 2013 Palantir Technologies, Inc. | |||
| * Copyright 2017 Palantir Technologies, Inc. | |||
There was a problem hiding this comment.
I think this one should stay unchanged
ajafff
approved these changes
Aug 15, 2017
adidahiya
approved these changes
Aug 17, 2017
HyphnKnight
pushed a commit
to HyphnKnight/tslint
that referenced
this pull request
Apr 9, 2018
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.
Added a couple util functions to quotemark rule. Checks argument list for OPTION_SINGLE or OPTION_DOUBLE in such a way that argument order doesn't matter. Currently, isEnabled() will return false if no single/double option is specified. Maybe defaulting to double quotes makes more sense?