Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Added rule to enforce quotes type #475

Merged
merged 4 commits into from
Apr 12, 2021
Merged

feat: Added rule to enforce quotes type #475

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e10796b
feat: new quotes rule
Apr 8, 2021
dab6416
Merge branch 'master' into quotes
angelica-bocanegra Apr 8, 2021
c32ce1a
chore: change error messaging to specifying string literals
Apr 11, 2021
6a82c1c
Merge branch 'quotes' of https://github.com/angelica-bocanegra/eslint…
Apr 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .README/rules/quotes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
### `quotes`

Enforces single quotes or double quotes.
Enforces single quotes or double quotes around string literals.

#### Options

The rule has string options of:

* `"double"` (default) requires double quotes around strings.
* `"single"` requires single quotes around strings.
* `"double"` (default) requires double quotes around string literals.
* `"single"` requires single quotes around string literals.

<!-- assertions quotes -->
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2840,44 +2840,44 @@ type Foo = { a: Foo, b: Bar }
<a name="eslint-plugin-flowtype-rules-quotes"></a>
### <code>quotes</code>

Enforces single quotes or double quotes.
Enforces single quotes or double quotes around string literals.

<a name="eslint-plugin-flowtype-rules-quotes-options-3"></a>
#### Options

The rule has string options of:

* `"double"` (default) requires double quotes around strings.
* `"single"` requires single quotes around strings.
* `"double"` (default) requires double quotes around string literals.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm I wonder why is default double? Guess same as regular quotes rule?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep keeping it standard

* `"single"` requires single quotes around string literals.

The following patterns are considered problems:

```js
type T = 'hi'
// Message: Strings must use double quote.
// Message: String literals must use double quote.

// Options: ["double"]
type T = { test: 'hello' | 'test' }
// Message: Strings must use double quote.
// Message: Strings must use double quote.
// Message: String literals must use double quote.
// Message: String literals must use double quote.

// Options: ["double"]
type T = { test: "hello" | 'test', t: 'hello' }
// Message: Strings must use double quote.
// Message: Strings must use double quote.
// Message: String literals must use double quote.
// Message: String literals must use double quote.

// Options: ["single"]
type T = "hi"
// Message: Strings must use single quote.
// Message: String literals must use single quote.

// Options: ["single"]
type T = { test: "hello" | "test" }
// Message: Strings must use single quote.
// Message: Strings must use single quote.
// Message: String literals must use single quote.
// Message: String literals must use single quote.

// Options: ["single"]
type T = { test: "hello" | 'test', t: 'hello' }
// Message: Strings must use single quote.
// Message: String literals must use single quote.
```

The following patterns are not considered problems:
Expand Down
4 changes: 2 additions & 2 deletions src/rules/quotes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const create = (context) => {
fixer.replaceTextRange([node.range[1] - 1, node.range[1]], '"'),
];
},
message: 'Strings must use double quote.',
message: 'String literals must use double quote.',
node,
});
} else if (!double && sourceCode.text[node.range[0]] !== '\'') {
Expand All @@ -36,7 +36,7 @@ const create = (context) => {
fixer.replaceTextRange([node.range[1] - 1, node.range[1]], '\''),
];
},
message: 'Strings must use single quote.',
message: 'String literals must use single quote.',
node,
});
}
Expand Down
18 changes: 9 additions & 9 deletions tests/rules/assertions/quotes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export default {
code: 'type T = \'hi\'',
errors: [
{
message: 'Strings must use double quote.',
message: 'String literals must use double quote.',
},
],
output: 'type T = "hi"',
Expand All @@ -13,10 +13,10 @@ export default {
code: 'type T = { test: \'hello\' | \'test\' }',
errors: [
{
message: 'Strings must use double quote.',
message: 'String literals must use double quote.',
},
{
message: 'Strings must use double quote.',
message: 'String literals must use double quote.',
},
],
options: ['double'],
Expand All @@ -26,10 +26,10 @@ export default {
code: 'type T = { test: "hello" | \'test\', t: \'hello\' }',
errors: [
{
message: 'Strings must use double quote.',
message: 'String literals must use double quote.',
},
{
message: 'Strings must use double quote.',
message: 'String literals must use double quote.',
},
],
options: ['double'],
Expand All @@ -39,7 +39,7 @@ export default {
code: 'type T = "hi"',
errors: [
{
message: 'Strings must use single quote.',
message: 'String literals must use single quote.',
},
],
options: ['single'],
Expand All @@ -49,10 +49,10 @@ export default {
code: 'type T = { test: "hello" | "test" }',
errors: [
{
message: 'Strings must use single quote.',
message: 'String literals must use single quote.',
},
{
message: 'Strings must use single quote.',
message: 'String literals must use single quote.',
},
],
options: ['single'],
Expand All @@ -62,7 +62,7 @@ export default {
code: 'type T = { test: "hello" | \'test\', t: \'hello\' }',
errors: [
{
message: 'Strings must use single quote.',
message: 'String literals must use single quote.',
},
],
options: ['single'],
Expand Down