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

Add function-url-quotes autofix #6558

Merged
merged 10 commits into from Jan 11, 2023
Merged

Add function-url-quotes autofix #6558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4611534
draft: failing / poor approach
mattxwang Jan 5, 2023
e0624f1
Refactor to use `raws`-based utilities
mattxwang Jan 9, 2023
b0d86c7
adds changeset
mattxwang Jan 9, 2023
d1cea88
Improves test coverage; "fixes" case insensitivity and autofix
mattxwang Jan 9, 2023
3b7a7d0
minor changeset formatting
mattxwang Jan 9, 2023
511f882
Use `declarationValueIndex` instead of custom util
mattxwang Jan 10, 2023
47a9d8a
Reduce test duplication by adding `fix: true` to existing rules
mattxwang Jan 10, 2023
870e2d5
Split up `addQuotes` and `removeQuotes` into at-rule and declaration-…
mattxwang Jan 10, 2023
a25ca75
Adds documentation / metadata to indicate that the rule is now autofi…
mattxwang Jan 10, 2023
853d2ba
Merge branch 'main' into autofix-function-url-quotes
mattxwang Jan 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/rude-dryers-fry.md
View file
Open in desktop
@@ -0,0 +1,5 @@
---
"stylelint": minor
---

Added: `function-url-quotes` autofix
2 changes: 1 addition & 1 deletion docs/user-guide/rules.md
View file
Open in desktop
Expand Up @@ -238,7 +238,7 @@ Enforce naming conventions with these `pattern` rules.
Require or disallow quotes with these `quotes` rules.

- [`font-family-name-quotes`](../../lib/rules/font-family-name-quotes/README.md): Require or disallow quotes for font family names (Autofixable).
- [`function-url-quotes`](../../lib/rules/function-url-quotes/README.md): Require or disallow quotes for urls.
- [`function-url-quotes`](../../lib/rules/function-url-quotes/README.md): Require or disallow quotes for urls (Autofixable).
- [`selector-attribute-quotes`](../../lib/rules/selector-attribute-quotes/README.md): Require or disallow quotes for attribute values (Autofixable).

### Redundant
Expand Down
2 changes: 2 additions & 0 deletions lib/rules/function-url-quotes/README.md
View file
Open in desktop
Expand Up @@ -9,6 +9,8 @@ a { background: url("x.jpg") }
* These quotes */
```

The [`fix` option](../../../docs/user-guide/usage/options.md#fix) can automatically fix most of the problems reported by this rule.

## Options

`string`: `"always"|"never"`
Expand Down
42 changes: 42 additions & 0 deletions lib/rules/function-url-quotes/__tests__/index.js
View file
Open in desktop
Expand Up @@ -5,6 +5,7 @@ const { messages, ruleName } = require('..');
testRule({
ruleName,
config: ['always'],
fix: true,

accept: [
{
Expand Down Expand Up @@ -180,6 +181,7 @@ testRule({
reject: [
{
code: '@import url(foo.css);',
fixed: '@import url("foo.css");',
message: messages.expected('url'),
line: 1,
column: 13,
Expand All @@ -188,6 +190,7 @@ testRule({
},
{
code: '@import url( foo.css );',
fixed: '@import url( "foo.css" );',
message: messages.expected('url'),
line: 1,
column: 14,
Expand All @@ -196,6 +199,7 @@ testRule({
},
{
code: '@document url-prefix(http://www.w3.org/Style);',
fixed: '@document url-prefix("http://www.w3.org/Style");',
message: messages.expected('url-prefix'),
line: 1,
column: 22,
Expand All @@ -204,6 +208,7 @@ testRule({
},
{
code: '@document url-prefix( http://www.w3.org/Style );',
fixed: '@document url-prefix( "http://www.w3.org/Style" );',
message: messages.expected('url-prefix'),
line: 1,
column: 23,
Expand All @@ -212,6 +217,7 @@ testRule({
},
{
code: "@font-face { font-family: 'foo'; src: url(foo.ttf); }",
fixed: '@font-face { font-family: \'foo\'; src: url("foo.ttf"); }',
message: messages.expected('url'),
line: 1,
column: 43,
Expand All @@ -220,6 +226,7 @@ testRule({
},
{
code: "@font-face { font-family: 'foo'; src: url( foo.ttf ); }",
fixed: '@font-face { font-family: \'foo\'; src: url( "foo.ttf" ); }',
message: messages.expected('url'),
line: 1,
column: 44,
Expand All @@ -228,6 +235,7 @@ testRule({
},
{
code: 'a { cursor: url(foo.png); }',
fixed: 'a { cursor: url("foo.png"); }',
message: messages.expected('url'),
line: 1,
column: 17,
Expand All @@ -236,6 +244,7 @@ testRule({
},
{
code: 'a { background-image: url(foo.css), url("bar.css"), url("baz.css"); }',
fixed: 'a { background-image: url("foo.css"), url("bar.css"), url("baz.css"); }',
message: messages.expected('url'),
line: 1,
column: 27,
Expand All @@ -244,6 +253,7 @@ testRule({
},
{
code: 'a { background-image: url( foo.css ), url("bar.css"), url("baz.css"); }',
fixed: 'a { background-image: url( "foo.css" ), url("bar.css"), url("baz.css"); }',
message: messages.expected('url'),
line: 1,
column: 28,
Expand All @@ -252,6 +262,7 @@ testRule({
},
{
code: 'a { background-image: url("foo.css"), url(bar.css), url("baz.css"); }',
fixed: 'a { background-image: url("foo.css"), url("bar.css"), url("baz.css"); }',
message: messages.expected('url'),
line: 1,
column: 43,
Expand All @@ -260,6 +271,7 @@ testRule({
},
{
code: 'a { background-image: url("foo.css"), url( bar.css ), url("baz.css"); }',
fixed: 'a { background-image: url("foo.css"), url( "bar.css" ), url("baz.css"); }',
message: messages.expected('url'),
line: 1,
column: 44,
Expand All @@ -268,6 +280,7 @@ testRule({
},
{
code: 'a { background-image: url("foo.css"), url("bar.css"), url(baz.css); }',
fixed: 'a { background-image: url("foo.css"), url("bar.css"), url("baz.css"); }',
message: messages.expected('url'),
line: 1,
column: 59,
Expand All @@ -276,6 +289,7 @@ testRule({
},
{
code: 'a { background-image: url("foo.css"), url("bar.css"), url( baz.css ); }',
fixed: 'a { background-image: url("foo.css"), url("bar.css"), url( "baz.css" ); }',
message: messages.expected('url'),
line: 1,
column: 60,
Expand All @@ -288,6 +302,7 @@ testRule({
testRule({
ruleName,
config: ['never'],
fix: true,

accept: [
{
Expand Down Expand Up @@ -397,6 +412,7 @@ testRule({
reject: [
{
code: '@import url("foo.css");',
fixed: '@import url(foo.css);',
message: messages.rejected('url'),
line: 1,
column: 13,
Expand All @@ -405,6 +421,7 @@ testRule({
},
{
code: '@import uRl("foo.css");',
fixed: '@import uRl(foo.css);',
message: messages.rejected('url'),
line: 1,
column: 13,
Expand All @@ -413,6 +430,7 @@ testRule({
},
{
code: '@import URL("foo.css");',
fixed: '@import URL(foo.css);',
message: messages.rejected('url'),
line: 1,
column: 13,
Expand All @@ -421,6 +439,7 @@ testRule({
},
{
code: '@import url( "foo.css" );',
fixed: '@import url( foo.css );',
message: messages.rejected('url'),
line: 1,
column: 14,
Expand All @@ -429,6 +448,7 @@ testRule({
},
{
code: "@import url('foo.css');",
fixed: '@import url(foo.css);',
message: messages.rejected('url'),
line: 1,
column: 13,
Expand All @@ -437,6 +457,7 @@ testRule({
},
{
code: "@import url( 'foo.css' );",
fixed: '@import url( foo.css );',
message: messages.rejected('url'),
line: 1,
column: 14,
Expand All @@ -445,6 +466,7 @@ testRule({
},
{
code: '@document url("http://www.w3.org/");',
fixed: '@document url(http://www.w3.org/);',
message: messages.rejected('url'),
line: 1,
column: 15,
Expand All @@ -453,6 +475,7 @@ testRule({
},
{
code: '@document url( "http://www.w3.org/" );',
fixed: '@document url( http://www.w3.org/ );',
message: messages.rejected('url'),
line: 1,
column: 16,
Expand All @@ -461,6 +484,7 @@ testRule({
},
{
code: "@document url-prefix('http://www.w3.org/Style');",
fixed: '@document url-prefix(http://www.w3.org/Style);',
message: messages.rejected('url-prefix'),
line: 1,
column: 22,
Expand All @@ -469,6 +493,7 @@ testRule({
},
{
code: "@document url-prefix( 'http://www.w3.org/Style' );",
fixed: '@document url-prefix( http://www.w3.org/Style );',
message: messages.rejected('url-prefix'),
line: 1,
column: 23,
Expand All @@ -477,6 +502,7 @@ testRule({
},
{
code: '@document domain("mozilla.org");',
fixed: '@document domain(mozilla.org);',
message: messages.rejected('domain'),
line: 1,
column: 18,
Expand All @@ -485,6 +511,7 @@ testRule({
},
{
code: '@document domain( "mozilla.org" );',
fixed: '@document domain( mozilla.org );',
message: messages.rejected('domain'),
line: 1,
column: 19,
Expand All @@ -493,6 +520,7 @@ testRule({
},
{
code: "@font-face { font-family: foo; src: url('foo.ttf'); }",
fixed: '@font-face { font-family: foo; src: url(foo.ttf); }',
message: messages.rejected('url'),
line: 1,
column: 41,
Expand All @@ -501,6 +529,7 @@ testRule({
},
{
code: "@font-face { font-family: foo; src: url( 'foo.ttf' ); }",
fixed: '@font-face { font-family: foo; src: url( foo.ttf ); }',
message: messages.rejected('url'),
line: 1,
column: 42,
Expand All @@ -509,6 +538,7 @@ testRule({
},
{
code: 'a { background: url("foo.css"); }',
fixed: 'a { background: url(foo.css); }',
message: messages.rejected('url'),
line: 1,
column: 21,
Expand All @@ -517,6 +547,7 @@ testRule({
},
{
code: 'a { background: uRl("foo.css"); }',
fixed: 'a { background: uRl(foo.css); }',
message: messages.rejected('url'),
line: 1,
column: 21,
Expand All @@ -525,6 +556,7 @@ testRule({
},
{
code: 'a { background: URL("foo.css"); }',
fixed: 'a { background: URL(foo.css); }',
message: messages.rejected('url'),
line: 1,
column: 21,
Expand All @@ -533,6 +565,7 @@ testRule({
},
{
code: 'a { background: url( "foo.css" ); }',
fixed: 'a { background: url( foo.css ); }',
message: messages.rejected('url'),
line: 1,
column: 22,
Expand All @@ -541,6 +574,7 @@ testRule({
},
{
code: 'a { background: url( "foo.css" ); }',
fixed: 'a { background: url( foo.css ); }',
message: messages.rejected('url'),
line: 1,
column: 23,
Expand All @@ -549,6 +583,7 @@ testRule({
},
{
code: 'a { cursor: url("foo.png"); }',
fixed: 'a { cursor: url(foo.png); }',
message: messages.rejected('url'),
line: 1,
column: 17,
Expand All @@ -557,6 +592,7 @@ testRule({
},
{
code: "a { background-image: url('foo.css'), url(bar.css), url(baz.css); }",
fixed: 'a { background-image: url(foo.css), url(bar.css), url(baz.css); }',
message: messages.rejected('url'),
line: 1,
column: 27,
Expand All @@ -565,6 +601,7 @@ testRule({
},
{
code: "a { background-image: url( 'foo.css' ), url(bar.css), url(baz.css); }",
fixed: 'a { background-image: url( foo.css ), url(bar.css), url(baz.css); }',
message: messages.rejected('url'),
line: 1,
column: 28,
Expand All @@ -573,6 +610,7 @@ testRule({
},
{
code: "a { background-image: url(foo.css), url('bar.css'), url(baz.css); }",
fixed: 'a { background-image: url(foo.css), url(bar.css), url(baz.css); }',
message: messages.rejected('url'),
line: 1,
column: 41,
Expand All @@ -581,6 +619,7 @@ testRule({
},
{
code: "a { background-image: url(foo.css), url( 'bar.css' ), url(baz.css); }",
fixed: 'a { background-image: url(foo.css), url( bar.css ), url(baz.css); }',
message: messages.rejected('url'),
line: 1,
column: 42,
Expand All @@ -589,6 +628,7 @@ testRule({
},
{
code: "a { background-image: url(foo.css), url(bar.css), url('baz.css'); }",
fixed: 'a { background-image: url(foo.css), url(bar.css), url(baz.css); }',
message: messages.rejected('url'),
line: 1,
column: 55,
Expand All @@ -597,6 +637,7 @@ testRule({
},
{
code: "a { background-image: url(foo.css), url(bar.css), url( 'baz.css' ); }",
fixed: 'a { background-image: url(foo.css), url(bar.css), url( baz.css ); }',
message: messages.rejected('url'),
line: 1,
column: 56,
Expand All @@ -605,6 +646,7 @@ testRule({
},
{
code: 'a { background: url("/images/my_image@2x.png") }',
fixed: 'a { background: url(/images/my_image@2x.png) }',
message: messages.rejected('url'),
line: 1,
column: 21,
Expand Down