@justeattakeaway/stylelint-config-pie 0.9.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +77 -4
  3. package/index.js +3 -1
  4. package/package.json +10 -2
  5. package/rules/style.js +69 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # Changelog
2
2
 
3
+ ## 2.0.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [Added] - optional stylistic stylelint ruleset ([#2753](https://github.com/justeattakeaway/pie/pull/2753)) by [@ashleynolan](https://github.com/ashleynolan)
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [[`31249c6`](https://github.com/justeattakeaway/pie/commit/31249c613e473c60d534551c7d6f2d768ad0d892)]:
12
+ - @justeattakeaway/pie-css@1.0.0
13
+
14
+ ## 1.0.0
15
+
16
+ ### Patch Changes
17
+
18
+ - [Fixed] - add tokens packages as peerDependencies ([#2732](https://github.com/justeattakeaway/pie/pull/2732)) by [@raoufswe](https://github.com/raoufswe)
19
+
20
+ - Updated dependencies [[`76e0750`](https://github.com/justeattakeaway/pie/commit/76e0750169bb9894b95548e9acee09a8ab339f5c)]:
21
+ - @justeattakeaway/pie-css@0.32.0
22
+
3
23
  ## 0.9.2
4
24
 
5
25
  ### Patch Changes
package/README.md CHANGED
@@ -21,11 +21,12 @@ npm install @justeattakeaway/stylelint-config-pie --save-dev
21
21
 
22
22
  ### Rules
23
23
 
24
- Currently there are 3 different sets of rules:
24
+ Currently there are 4 different sets of rules:
25
25
 
26
26
  1. `base` - the base rules that we'd advise all projects use and extend as needed.
27
27
  2. `strict` - a smaller collection of _optional_ opinionated rules.
28
28
  3. `ordering` - an even smaller collection of _optional_ rules that specify the ordering of CSS Variables.
29
+ 4. `style` - an _optional_ stylistic ruleset powered by `@stylistic/stylelint-plugin`.
29
30
 
30
31
  ### In your projects
31
32
 
@@ -45,14 +46,15 @@ The easiest way to do this is by adding the following section to your package.js
45
46
  }
46
47
  ```
47
48
 
48
- You may only want to use a specific ruleset such as `base`, `strict` or `ordering`. If so, simply point to the ones you'd like to use:
49
+ You may only want to use specific rulesets such as `base`, `strict`, `ordering` or `style`. If so, simply point to the ones you'd like to use:
49
50
 
50
51
  ```json
51
52
  "stylelint": {
52
53
  "extends": [
53
54
  "@justeattakeaway/stylelint-config-pie/base",
54
55
  "@justeattakeaway/stylelint-config-pie/strict",
55
- "@justeattakeaway/stylelint-config-pie/ordering"
56
+ "@justeattakeaway/stylelint-config-pie/ordering",
57
+ "@justeattakeaway/stylelint-config-pie/style"
56
58
  ]
57
59
  }
58
60
  ```
@@ -215,4 +217,75 @@ A built-in plugin that validates PIE design token usage (`--dt-` prefixed custom
215
217
  - [order/order](https://github.com/hudochenkov/stylelint-order/blob/master/rules/order/README.md)
216
218
  - [order/properties-order](https://github.com/hudochenkov/stylelint-order/blob/master/rules/properties-order/README.md)
217
219
 
218
- ## [Changelog](CHANGELOG.md)
220
+ ### Style
221
+
222
+ Stylistic rules (e.g. indentation, casing) were moved out of the core Stylelint package to instead be optionally included via plugins from Stylelint v15. We use the [`@stylistic/stylelint-plugin`](https://github.com/stylelint-stylistic/stylelint-stylistic) to allow these stylistic rules to be optionally included in your rulesets.
223
+
224
+ Configured rules:
225
+
226
+ - [@stylistic/at-rule-name-case](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/at-rule-name-case/README.md)
227
+ - [@stylistic/at-rule-name-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/at-rule-name-space-after/README.md)
228
+ - [@stylistic/at-rule-semicolon-newline-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/at-rule-semicolon-newline-after/README.md)
229
+ - [@stylistic/block-closing-brace-empty-line-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/block-closing-brace-empty-line-before/README.md)
230
+ - [@stylistic/block-closing-brace-newline-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/block-closing-brace-newline-after/README.md)
231
+ - [@stylistic/block-closing-brace-newline-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/block-closing-brace-newline-before/README.md)
232
+ - [@stylistic/block-closing-brace-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/block-closing-brace-space-before/README.md)
233
+ - [@stylistic/block-opening-brace-newline-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/block-opening-brace-newline-after/README.md)
234
+ - [@stylistic/block-opening-brace-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/block-opening-brace-space-after/README.md)
235
+ - [@stylistic/block-opening-brace-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/block-opening-brace-space-before/README.md)
236
+ - [@stylistic/color-hex-case](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/color-hex-case/README.md)
237
+ - [@stylistic/declaration-bang-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/declaration-bang-space-after/README.md)
238
+ - [@stylistic/declaration-bang-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/declaration-bang-space-before/README.md)
239
+ - [@stylistic/declaration-block-semicolon-newline-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/declaration-block-semicolon-newline-after/README.md)
240
+ - [@stylistic/declaration-block-semicolon-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/declaration-block-semicolon-space-after/README.md)
241
+ - [@stylistic/declaration-block-semicolon-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/declaration-block-semicolon-space-before/README.md)
242
+ - [@stylistic/declaration-block-trailing-semicolon](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/declaration-block-trailing-semicolon/README.md)
243
+ - [@stylistic/declaration-colon-newline-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/declaration-colon-newline-after/README.md)
244
+ - [@stylistic/declaration-colon-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/declaration-colon-space-after/README.md)
245
+ - [@stylistic/declaration-colon-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/declaration-colon-space-before/README.md)
246
+ - [@stylistic/function-comma-newline-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/function-comma-newline-after/README.md)
247
+ - [@stylistic/function-comma-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/function-comma-space-after/README.md)
248
+ - [@stylistic/function-comma-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/function-comma-space-before/README.md)
249
+ - [@stylistic/function-max-empty-lines](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/function-max-empty-lines/README.md)
250
+ - [@stylistic/function-parentheses-newline-inside](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/function-parentheses-newline-inside/README.md)
251
+ - [@stylistic/function-parentheses-space-inside](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/function-parentheses-space-inside/README.md)
252
+ - [@stylistic/function-whitespace-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/function-whitespace-after/README.md)
253
+ - [@stylistic/indentation](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/indentation/README.md)
254
+ - [@stylistic/max-empty-lines](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/max-empty-lines/README.md)
255
+ - [@stylistic/max-line-length](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/max-line-length/README.md)
256
+ - [@stylistic/media-feature-colon-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/media-feature-colon-space-after/README.md)
257
+ - [@stylistic/media-feature-colon-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/media-feature-colon-space-before/README.md)
258
+ - [@stylistic/media-feature-name-case](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/media-feature-name-case/README.md)
259
+ - [@stylistic/media-feature-parentheses-space-inside](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/media-feature-parentheses-space-inside/README.md)
260
+ - [@stylistic/media-feature-range-operator-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/media-feature-range-operator-space-after/README.md)
261
+ - [@stylistic/media-feature-range-operator-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/media-feature-range-operator-space-before/README.md)
262
+ - [@stylistic/media-query-list-comma-newline-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/media-query-list-comma-newline-after/README.md)
263
+ - [@stylistic/media-query-list-comma-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/media-query-list-comma-space-after/README.md)
264
+ - [@stylistic/media-query-list-comma-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/media-query-list-comma-space-before/README.md)
265
+ - [@stylistic/no-empty-first-line](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/no-empty-first-line/README.md)
266
+ - [@stylistic/no-eol-whitespace](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/no-eol-whitespace/README.md)
267
+ - [@stylistic/no-extra-semicolons](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/no-extra-semicolons/README.md)
268
+ - [@stylistic/no-missing-end-of-source-newline](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/no-missing-end-of-source-newline/README.md)
269
+ - [@stylistic/number-leading-zero](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/number-leading-zero/README.md)
270
+ - [@stylistic/number-no-trailing-zeros](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/number-no-trailing-zeros/README.md)
271
+ - [@stylistic/property-case](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/property-case/README.md)
272
+ - [@stylistic/selector-attribute-brackets-space-inside](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-attribute-brackets-space-inside/README.md)
273
+ - [@stylistic/selector-attribute-operator-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-attribute-operator-space-after/README.md)
274
+ - [@stylistic/selector-attribute-operator-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-attribute-operator-space-before/README.md)
275
+ - [@stylistic/selector-combinator-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-combinator-space-after/README.md)
276
+ - [@stylistic/selector-combinator-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-combinator-space-before/README.md)
277
+ - [@stylistic/selector-descendant-combinator-no-non-space](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-descendant-combinator-no-non-space/README.md)
278
+ - [@stylistic/selector-list-comma-newline-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-list-comma-newline-after/README.md)
279
+ - [@stylistic/selector-list-comma-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-list-comma-space-before/README.md)
280
+ - [@stylistic/selector-max-empty-lines](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-max-empty-lines/README.md)
281
+ - [@stylistic/selector-pseudo-class-case](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-pseudo-class-case/README.md)
282
+ - [@stylistic/selector-pseudo-class-parentheses-space-inside](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-pseudo-class-parentheses-space-inside/README.md)
283
+ - [@stylistic/selector-pseudo-element-case](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/selector-pseudo-element-case/README.md)
284
+ - [@stylistic/string-quotes](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/string-quotes/README.md)
285
+ - [@stylistic/unit-case](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/unit-case/README.md)
286
+ - [@stylistic/value-list-comma-newline-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/value-list-comma-newline-after/README.md)
287
+ - [@stylistic/value-list-comma-space-after](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/value-list-comma-space-after/README.md)
288
+ - [@stylistic/value-list-comma-space-before](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/value-list-comma-space-before/README.md)
289
+ - [@stylistic/value-list-max-empty-lines](https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/lib/rules/value-list-max-empty-lines/README.md)
290
+
291
+ ## [Changelog](CHANGELOG.md)
package/index.js CHANGED
@@ -2,11 +2,13 @@
2
2
  import baseRules from './rules/base.js';
3
3
  import strictRules from './rules/strict.js';
4
4
  import orderingRules from './rules/ordering.js';
5
+ import styleRules from './rules/style.js';
5
6
 
6
7
  export default {
7
8
  extends: [
8
9
  baseRules,
9
10
  strictRules,
10
- orderingRules
11
+ orderingRules,
12
+ styleRules
11
13
  ],
12
14
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@justeattakeaway/stylelint-config-pie",
3
- "version": "0.9.2",
3
+ "version": "2.0.0",
4
4
  "description": "Shareable Stylelint config for use with any front-end web projects across JET.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -20,13 +20,21 @@
20
20
  ".": "./index.js",
21
21
  "./base": "./rules/base.js",
22
22
  "./strict": "./rules/strict.js",
23
- "./ordering": "./rules/ordering.js"
23
+ "./ordering": "./rules/ordering.js",
24
+ "./style": "./rules/style.js"
24
25
  },
25
26
  "peerDependencies": {
27
+ "@justeat/pie-design-tokens": "*",
28
+ "@justeattakeaway/pie-css": "*",
26
29
  "stylelint": "16.x",
27
30
  "stylelint-config-standard-scss": "13.x",
28
31
  "stylelint-order": "6.x"
29
32
  },
33
+ "peerDependenciesMeta": {
34
+ "@justeattakeaway/pie-css": {
35
+ "optional": true
36
+ }
37
+ },
30
38
  "dependencies": {
31
39
  "@justeattakeaway/stylelint-no-logical-props-shorthands": "0.3.0"
32
40
  },
package/rules/style.js ADDED
@@ -0,0 +1,69 @@
1
+ export default {
2
+ plugins: ['@stylistic/stylelint-plugin'],
3
+ rules: {
4
+ '@stylistic/at-rule-name-case': 'lower',
5
+ '@stylistic/at-rule-name-space-after': 'always-single-line',
6
+ '@stylistic/at-rule-semicolon-newline-after': 'always',
7
+ '@stylistic/block-closing-brace-empty-line-before': 'never',
8
+ '@stylistic/block-closing-brace-newline-after': ['always', { ignoreAtRules: ['if', 'else'] }],
9
+ '@stylistic/block-closing-brace-newline-before': 'always-multi-line',
10
+ '@stylistic/block-closing-brace-space-before': 'always-single-line',
11
+ '@stylistic/block-opening-brace-newline-after': 'always-multi-line',
12
+ '@stylistic/block-opening-brace-space-after': 'always-single-line',
13
+ '@stylistic/block-opening-brace-space-before': 'always',
14
+ '@stylistic/color-hex-case': 'lower',
15
+ '@stylistic/declaration-bang-space-after': 'never',
16
+ '@stylistic/declaration-bang-space-before': 'always',
17
+ '@stylistic/declaration-block-semicolon-newline-after': 'always-multi-line',
18
+ '@stylistic/declaration-block-semicolon-space-after': 'always-single-line',
19
+ '@stylistic/declaration-block-semicolon-space-before': 'never',
20
+ '@stylistic/declaration-block-trailing-semicolon': 'always',
21
+ '@stylistic/declaration-colon-newline-after': 'always-multi-line',
22
+ '@stylistic/declaration-colon-space-after': 'always-single-line',
23
+ '@stylistic/declaration-colon-space-before': 'never',
24
+ '@stylistic/function-comma-newline-after': 'always-multi-line',
25
+ '@stylistic/function-comma-space-after': 'always-single-line',
26
+ '@stylistic/function-comma-space-before': 'never',
27
+ '@stylistic/function-max-empty-lines': 0,
28
+ '@stylistic/function-parentheses-newline-inside': 'always-multi-line',
29
+ '@stylistic/function-parentheses-space-inside': 'never-single-line',
30
+ '@stylistic/function-whitespace-after': 'always',
31
+ '@stylistic/indentation': 4,
32
+ '@stylistic/max-empty-lines': 2,
33
+ '@stylistic/max-line-length': null,
34
+ '@stylistic/media-feature-colon-space-after': 'always',
35
+ '@stylistic/media-feature-colon-space-before': 'never',
36
+ '@stylistic/media-feature-name-case': 'lower',
37
+ '@stylistic/media-feature-parentheses-space-inside': 'never',
38
+ '@stylistic/media-feature-range-operator-space-after': 'always',
39
+ '@stylistic/media-feature-range-operator-space-before': 'always',
40
+ '@stylistic/media-query-list-comma-newline-after': 'always-multi-line',
41
+ '@stylistic/media-query-list-comma-space-after': 'always-single-line',
42
+ '@stylistic/media-query-list-comma-space-before': 'never',
43
+ '@stylistic/no-empty-first-line': true,
44
+ '@stylistic/no-eol-whitespace': true,
45
+ '@stylistic/no-extra-semicolons': true,
46
+ '@stylistic/no-missing-end-of-source-newline': true,
47
+ '@stylistic/number-leading-zero': 'always',
48
+ '@stylistic/number-no-trailing-zeros': true,
49
+ '@stylistic/property-case': 'lower',
50
+ '@stylistic/selector-attribute-brackets-space-inside': 'never',
51
+ '@stylistic/selector-attribute-operator-space-after': 'never',
52
+ '@stylistic/selector-attribute-operator-space-before': 'never',
53
+ '@stylistic/selector-combinator-space-after': 'always',
54
+ '@stylistic/selector-combinator-space-before': 'always',
55
+ '@stylistic/selector-descendant-combinator-no-non-space': true,
56
+ '@stylistic/selector-list-comma-newline-after': 'always',
57
+ '@stylistic/selector-list-comma-space-before': 'never',
58
+ '@stylistic/selector-max-empty-lines': 0,
59
+ '@stylistic/selector-pseudo-class-case': 'lower',
60
+ '@stylistic/selector-pseudo-class-parentheses-space-inside': 'never',
61
+ '@stylistic/selector-pseudo-element-case': 'lower',
62
+ '@stylistic/string-quotes': 'single',
63
+ '@stylistic/unit-case': 'lower',
64
+ '@stylistic/value-list-comma-newline-after': 'always-multi-line',
65
+ '@stylistic/value-list-comma-space-after': 'always-single-line',
66
+ '@stylistic/value-list-comma-space-before': 'never',
67
+ '@stylistic/value-list-max-empty-lines': 0,
68
+ },
69
+ };