Skip to content

Commit 0d6e568

Browse files
firefoxicfirefoxic
committed
Improve syntax of rules
1 parent ef3dafc commit 0d6e568

File tree

87 files changed

+128
-104
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+128
-104
lines changed

Diff for: ‎docs/developer-guide/rules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ function rule(primary, secondary) {
164164

165165
rule.primaryOptionArray = true;
166166

167-
module.exports = rule;
167+
export rule;
168168
```
169169

170170
There is one caveat here: If your rule accepts a primary option array, it cannot also accept a primary option object. Whenever possible, if you want your rule to accept a primary option array, you should make an array the only possibility, instead of allowing for various data structures.

Diff for: ‎lib/index.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import { createPlugin } from "stylelint"
1+
import stylelint from "stylelint"
22

33
import rules from "./rules/index.js"
44

55
const prefix = `codeguide`
66

7-
const rulesPlugins = Object.keys(rules).map((ruleName) => createPlugin(`${prefix}/${ruleName}`, rules[ruleName]))
7+
const rulesPlugins = Object.keys(rules).map((ruleName) => stylelint.createPlugin(`${prefix}/${ruleName}`, rules[ruleName]))
88

99
export default rulesPlugins

Diff for: ‎lib/reference/selectors.js

+30-6
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,16 @@ export const mixedCaseSvgTypeSelectors = new Set([
7575
])
7676

7777
// These are the ones that can have single-colon notation
78-
export const levelOneAndTwoPseudoElements = new Set([`before`, `after`, `first-line`, `first-letter`])
78+
export const levelOneAndTwoPseudoElements = new Set([
79+
`before`,
80+
`after`,
81+
`first-line`,
82+
`first-letter`,
83+
])
7984

80-
export const shadowTreePseudoElements = new Set([`part`])
85+
export const shadowTreePseudoElements = new Set([
86+
`part`,
87+
])
8188

8289
export const webkitScrollbarPseudoElements = new Set([
8390
`-webkit-resizer`,
@@ -191,13 +198,30 @@ export const aNPlusBNotationPseudoClasses = new Set([
191198
`nth-of-type`,
192199
])
193200

194-
export const aNPlusBOfSNotationPseudoClasses = new Set([`nth-child`, `nth-last-child`])
201+
export const aNPlusBOfSNotationPseudoClasses = new Set([
202+
`nth-child`,
203+
`nth-last-child`,
204+
])
195205

196-
export const atRulePagePseudoClasses = new Set([`first`, `right`, `left`, `blank`])
206+
export const atRulePagePseudoClasses = new Set([
207+
`first`,
208+
`right`,
209+
`left`,
210+
`blank`,
211+
])
197212

198-
export const linguisticPseudoClasses = new Set([`dir`, `lang`])
213+
export const linguisticPseudoClasses = new Set([
214+
`dir`,
215+
`lang`,
216+
])
199217

200-
export const logicalCombinationsPseudoClasses = new Set([`has`, `is`, `matches`, `not`, `where`])
218+
export const logicalCombinationsPseudoClasses = new Set([
219+
`has`,
220+
`is`,
221+
`matches`,
222+
`not`,
223+
`where`,
224+
])
201225

202226
const vendorSpecificPseudoClasses = new Set([
203227
`-khtml-drag`,

Diff for: ‎lib/rules/at-rule-name-case/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export const messages = ruleMessages(ruleName, {
1010
})
1111

1212
export const meta = {
13-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/at-rule-name-case/README.md`,
13+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1414
fixable: true,
1515
}
1616

Diff for: ‎lib/rules/at-rule-name-newline-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export const messages = ruleMessages(ruleName, {
1010
})
1111

1212
export const meta = {
13-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/at-rule-name-newline-after/README.md`,
13+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1414
}
1515

1616
/** @type {import('stylelint').Rule} */

Diff for: ‎lib/rules/at-rule-name-space-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export const messages = ruleMessages(ruleName, {
1010
})
1111

1212
export const meta = {
13-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/at-rule-name-space-after/README.md`,
13+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1414
fixable: true,
1515
}
1616

Diff for: ‎lib/rules/at-rule-semicolon-newline-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export const messages = ruleMessages(ruleName, {
1414
})
1515

1616
export const meta = {
17-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/at-rule-semicolon-newline-after/README.md`,
17+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1818
fixable: true,
1919
}
2020

Diff for: ‎lib/rules/at-rule-semicolon-space-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export const messages = ruleMessages(ruleName, {
1414
})
1515

1616
export const meta = {
17-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/at-rule-semicolon-space-before/README.md`,
17+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1818
}
1919

2020
/** @type {import('stylelint').Rule} */

Diff for: ‎lib/rules/block-closing-brace-empty-line-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const messages = ruleMessages(ruleName, {
1818
})
1919

2020
export const meta = {
21-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/block-closing-brace-empty-line-before/README.md`,
21+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2222
fixable: true,
2323
}
2424

Diff for: ‎lib/rules/block-closing-brace-newline-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export const messages = ruleMessages(ruleName, {
1919
})
2020

2121
export const meta = {
22-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/block-closing-brace-newline-after/README.md`,
22+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2323
fixable: true,
2424
}
2525

Diff for: ‎lib/rules/block-closing-brace-newline-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export const messages = ruleMessages(ruleName, {
1515
})
1616

1717
export const meta = {
18-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/block-closing-brace-newline-before/README.md`,
18+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1919
fixable: true,
2020
}
2121

Diff for: ‎lib/rules/block-closing-brace-space-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const messages = ruleMessages(ruleName, {
1818
})
1919

2020
export const meta = {
21-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/block-closing-brace-space-after/README.md`,
21+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2222
}
2323

2424
/** @type {import('stylelint').Rule} */

Diff for: ‎lib/rules/block-closing-brace-space-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const messages = ruleMessages(ruleName, {
1818
})
1919

2020
export const meta = {
21-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/block-closing-brace-space-before/README.md`,
21+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2222
fixable: true,
2323
}
2424

Diff for: ‎lib/rules/block-opening-brace-newline-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const messages = ruleMessages(ruleName, {
1818
})
1919

2020
export const meta = {
21-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/block-opening-brace-newline-after/README.md`,
21+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2222
fixable: true,
2323
}
2424

Diff for: ‎lib/rules/block-opening-brace-newline-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const messages = ruleMessages(ruleName, {
1818
})
1919

2020
export const meta = {
21-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/block-opening-brace-newline-before/README.md`,
21+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2222
fixable: true,
2323
}
2424

Diff for: ‎lib/rules/block-opening-brace-space-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export const messages = ruleMessages(ruleName, {
2020
})
2121

2222
export const meta = {
23-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/block-opening-brace-space-after/README.md`,
23+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2424
fixable: true,
2525
}
2626

Diff for: ‎lib/rules/block-opening-brace-space-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export const messages = ruleMessages(ruleName, {
2121
})
2222

2323
export const meta = {
24-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/block-opening-brace-space-before/README.md`,
24+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2525
fixable: true,
2626
}
2727

Diff for: ‎lib/rules/color-hex-case/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export const messages = ruleMessages(ruleName, {
1414
})
1515

1616
export const meta = {
17-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/color-hex-case/README.md`,
17+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1818
fixable: true,
1919
}
2020

Diff for: ‎lib/rules/declaration-bang-space-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export const messages = ruleMessages(ruleName, {
1414
})
1515

1616
export const meta = {
17-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/declaration-bang-space-after/README.md`,
17+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1818
fixable: true,
1919
}
2020

Diff for: ‎lib/rules/declaration-bang-space-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export const messages = ruleMessages(ruleName, {
1414
})
1515

1616
export const meta = {
17-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/declaration-bang-space-before/README.md`,
17+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1818
fixable: true,
1919
}
2020

Diff for: ‎lib/rules/declaration-block-semicolon-newline-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export const messages = ruleMessages(ruleName, {
1616
})
1717

1818
export const meta = {
19-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/declaration-block-semicolon-newline-after/README.md`,
19+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2020
fixable: true,
2121
}
2222

Diff for: ‎lib/rules/declaration-block-semicolon-newline-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export const messages = ruleMessages(ruleName, {
1515
})
1616

1717
export const meta = {
18-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/declaration-block-semicolon-newline-before/README.md`,
18+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1919
}
2020

2121
/** @type {import('stylelint').Rule} */

Diff for: ‎lib/rules/declaration-block-semicolon-space-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const messages = ruleMessages(ruleName, {
1818
})
1919

2020
export const meta = {
21-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/declaration-block-semicolon-space-after/README.md`,
21+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2222
fixable: true,
2323
}
2424

Diff for: ‎lib/rules/declaration-block-semicolon-space-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export const messages = ruleMessages(ruleName, {
1919
})
2020

2121
export const meta = {
22-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/declaration-block-semicolon-space-before/README.md`,
22+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2323
fixable: true,
2424
}
2525

Diff for: ‎lib/rules/declaration-block-trailing-semicolon/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export const messages = ruleMessages(ruleName, {
1313
})
1414

1515
export const meta = {
16-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/declaration-block-trailing-semicolon/README.md`,
16+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1717
fixable: true,
1818
}
1919

Diff for: ‎lib/rules/declaration-colon-newline-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export const messages = ruleMessages(ruleName, {
1313
})
1414

1515
export const meta = {
16-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/declaration-colon-newline-after/README.md`,
16+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1717
fixable: true,
1818
}
1919

Diff for: ‎lib/rules/declaration-colon-space-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export const messages = ruleMessages(ruleName, {
1313
})
1414

1515
export const meta = {
16-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/declaration-colon-space-after/README.md`,
16+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1717
fixable: true,
1818
}
1919

Diff for: ‎lib/rules/declaration-colon-space-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export const messages = ruleMessages(ruleName, {
1212
})
1313

1414
export const meta = {
15-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/declaration-colon-space-before/README.md`,
15+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1616
fixable: true,
1717
}
1818

Diff for: ‎lib/rules/function-comma-newline-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export const messages = ruleMessages(ruleName, {
1313
})
1414

1515
export const meta = {
16-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/function-comma-newline-after/README.md`,
16+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1717
fixable: true,
1818
}
1919

Diff for: ‎lib/rules/function-comma-newline-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export const messages = ruleMessages(ruleName, {
1313
})
1414

1515
export const meta = {
16-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/function-comma-newline-before/README.md`,
16+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1717
fixable: true,
1818
}
1919

Diff for: ‎lib/rules/function-comma-space-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export const messages = ruleMessages(ruleName, {
1414
})
1515

1616
export const meta = {
17-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/function-comma-space-after/README.md`,
17+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1818
fixable: true,
1919
}
2020

Diff for: ‎lib/rules/function-comma-space-before/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export const messages = ruleMessages(ruleName, {
1414
})
1515

1616
export const meta = {
17-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/function-comma-space-before/README.md`,
17+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1818
fixable: true,
1919
}
2020

Diff for: ‎lib/rules/function-max-empty-lines/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export const messages = ruleMessages(ruleName, {
1414
})
1515

1616
export const meta = {
17-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/function-max-empty-lines/README.md`,
17+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1818
fixable: true,
1919
}
2020

Diff for: ‎lib/rules/function-parentheses-newline-inside/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export const messages = ruleMessages(ruleName, {
2121
})
2222

2323
export const meta = {
24-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/function-parentheses-newline-inside/README.md`,
24+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2525
fixable: true,
2626
}
2727

Diff for: ‎lib/rules/function-parentheses-space-inside/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export const messages = ruleMessages(ruleName, {
2323
})
2424

2525
export const meta = {
26-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/function-parentheses-space-inside/README.md`,
26+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2727
fixable: true,
2828
}
2929

Diff for: ‎lib/rules/function-whitespace-after/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export const messages = ruleMessages(ruleName, {
1717
})
1818

1919
export const meta = {
20-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/function-whitespace-after/README.md`,
20+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
2121
fixable: true,
2222
}
2323

Diff for: ‎lib/rules/indentation/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export const messages = ruleMessages(ruleName, {
1515
})
1616

1717
export const meta = {
18-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/indentation/README.md`,
18+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1919
fixable: true,
2020
}
2121

Diff for: ‎lib/rules/linebreaks/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export const messages = ruleMessages(ruleName, {
1111
})
1212

1313
export const meta = {
14-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/linebreaks/README.md`,
14+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1515
fixable: true,
1616
}
1717

Diff for: ‎lib/rules/max-empty-lines/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export const messages = ruleMessages(ruleName, {
1313
})
1414

1515
export const meta = {
16-
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/max-empty-lines/README.md`,
16+
url: `https://github.com/firefoxic/stylelint-codeguide/blob/main/lib/rules/${ruleName}/README.md`,
1717
fixable: true,
1818
}
1919

0 commit comments

Comments
 (0)