@stylelint-types/stylelint-scss 6.11.0 → 7.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 (2) hide show
  1. package/lib/index.d.ts +74 -119
  2. package/package.json +21 -16
package/lib/index.d.ts CHANGED
@@ -1,12 +1,9 @@
1
- import { RuleConfig, LiteralUnion, CSSPropertiesMap, AtRules, RegExpLike } from 'stylelint-define-config';
1
+ import { RuleConfig, LiteralUnion, RegExpLike, CSSPropertiesMap, Arrayable, AtRules } from 'stylelint-define-config';
2
2
 
3
3
  type AtEachKeyValueSingleLineOptions = RuleConfig<true>
4
4
 
5
5
  type AtElseClosingBraceNewlineAfterOptions = RuleConfig<
6
- 'always-last-in-chain',
7
- {
8
- disableFix?: boolean
9
- }
6
+ 'always-last-in-chain'
10
7
  >
11
8
 
12
9
  type AtElseEmptyLineBeforeOptions = RuleConfig<
@@ -23,8 +20,9 @@ type AtExtendNoMissingPlaceholderOptions = RuleConfig<
23
20
 
24
21
  type AtFunctionNamedArgumentsOptions = RuleConfig<
25
22
  'always' | 'never',
23
+ [],
26
24
  {
27
- ignore?: ('single-argument')[]
25
+ ignore?: LiteralUnion<'single-argument'>[]
28
26
  /**
29
27
  * ["/regex/", "string"]
30
28
  */
@@ -36,7 +34,10 @@ type AtFunctionParenthesesSpaceBeforeOptions = RuleConfig<
36
34
  'always' | 'never'
37
35
  >
38
36
 
39
- type AtFunctionPatternOptions = RuleConfig<string | RegExp>
37
+ type AtFunctionPatternOptions = RuleConfig<
38
+ RegExpLike,
39
+ [functionName: string, pattern: RegExpLike]
40
+ >
40
41
 
41
42
  type AtIfClosingBraceNewlineAfterOptions = RuleConfig<
42
43
  'always-last-in-chain'
@@ -50,26 +51,14 @@ type AtIfNoNullOptions = RuleConfig<
50
51
  (LiteralUnion<'css' | 'less' | 'scss'> | RegExp)[]
51
52
  >
52
53
 
53
- type AtImportNoPartialLeadingUnderscoreOptions = RuleConfig<true>
54
-
55
- type AtImportPartialExtensionOptions = RuleConfig<
56
- 'always' | 'never'
57
- >
58
-
59
54
  type AtImportPartialExtensionAllowedListOptions = RuleConfig<
60
55
  (LiteralUnion<'css' | 'scss' | 'sass'> | RegExp)[]
61
56
  >
62
57
 
63
- type AtImportPartialExtensionBlacklistOptions = RuleConfig<true>
64
-
65
58
  type AtImportPartialExtensionDisallowedListOptions = RuleConfig<
66
59
  (LiteralUnion<'css' | 'scss' | 'sass'> | RegExp)[]
67
60
  >
68
61
 
69
- type AtImportPartialExtensionWhitelistOptions = RuleConfig<
70
- (LiteralUnion<'css' | 'less' | 'scss'> | RegExp)[]
71
- >
72
-
73
62
  type AtMixinArgumentlessCallParenthesesOptions = RuleConfig<
74
63
  'always' | 'never'
75
64
  >
@@ -85,7 +74,8 @@ type AtMixinParenthesesSpaceBeforeOptions = RuleConfig<
85
74
  >
86
75
 
87
76
  type AtMixinPatternOptions = RuleConfig<
88
- string | RegExp
77
+ RegExpLike,
78
+ [mixinName: string, pattern: RegExpLike]
89
79
  >
90
80
 
91
81
  type AtRootNoRedundantOptions = RuleConfig<true>
@@ -94,8 +84,9 @@ type AtRuleConditionalNoParenthesesOptions = RuleConfig<true>
94
84
 
95
85
  type AtRuleNoUnknownOptions = RuleConfig<
96
86
  true,
87
+ [],
97
88
  {
98
- ignoreAtRules?: (string | RegExp)[]
89
+ ignoreAtRules?: RegExpLike[]
99
90
  }
100
91
  >
101
92
 
@@ -117,6 +108,7 @@ type DeclarationNestedPropertiesNoDividedGroupsOptions = RuleConfig<true>
117
108
 
118
109
  type DeclarationPropertyValueNoUnknownOptions = RuleConfig<
119
110
  true,
111
+ [],
120
112
  {
121
113
  /**
122
114
  * Ignore the specified property and value pairs.
@@ -126,7 +118,7 @@ type DeclarationPropertyValueNoUnknownOptions = RuleConfig<
126
118
  *
127
119
  * For example, `"/.+/"` matches any strings.
128
120
  */
129
- ignoreProperties?: Record<CSSPropertiesMap, (string | RegExp)[] | string | RegExp>
121
+ ignoreProperties?: Record<CSSPropertiesMap, Arrayable<RegExpLike>>
130
122
  /**
131
123
  * Extend or alter the properties syntax dictionary.
132
124
  * [CSS Value Definition Syntax](https://github.com/csstree/csstree/blob/master/docs/definition-syntax.md) is used to define a value's syntax.
@@ -161,46 +153,36 @@ type DollarVariableColonSpaceBeforeOptions = RuleConfig<
161
153
 
162
154
  type DollarVariableDefaultOptions = RuleConfig<
163
155
  true,
156
+ [],
164
157
  {
165
- ignore?: ('local')[]
158
+ ignore?: LiteralUnion<'local'>[]
166
159
  }
167
160
  >
168
161
 
169
- type DollarVariableEmptyLineAfterExcept = 'last-nested' | 'before-comment' | 'before-dollar-variable'
170
-
171
- type DollarVariableEmptyLineAfterIgnore = 'before-comment' | 'inside-single-line-block'
172
-
173
- interface DollarVariableEmptyLineAfterSecondaryOptions {
174
- except?: DollarVariableEmptyLineAfterExcept[]
175
- ignore?: DollarVariableEmptyLineAfterIgnore[]
176
- disableFix?: boolean
177
- }
178
-
179
162
  type DollarVariableEmptyLineAfterOptions = RuleConfig<
180
163
  'always' | 'never',
181
- DollarVariableEmptyLineAfterSecondaryOptions
164
+ [],
165
+ {
166
+ except?: LiteralUnion<'last-nested' | 'before-comment' | 'before-dollar-variable'>[]
167
+ ignore?: LiteralUnion<'before-comment' | 'inside-single-line-block'>[]
168
+ }
182
169
  >
183
170
 
184
- type DollarVariableEmptyLineBeforeExcept = 'first-nested' | 'after-comment' | 'after-dollar-variable'
185
-
186
- type DollarVariableEmptyLineBeforeIgnore = 'after-comment' | 'inside-single-line-block' | 'after-dollar-variable'
187
-
188
- interface DollarVariableEmptyLineBeforeSecondaryOptions {
189
- except?: DollarVariableEmptyLineBeforeExcept[]
190
- ignore?: DollarVariableEmptyLineBeforeIgnore[]
191
- disableFix?: boolean
192
- }
193
-
194
171
  type DollarVariableEmptyLineBeforeOptions = RuleConfig<
195
172
  'always' | 'never',
196
- DollarVariableEmptyLineBeforeSecondaryOptions
173
+ [],
174
+ {
175
+ except?: LiteralUnion<'first-nested' | 'after-comment' | 'after-dollar-variable'>[]
176
+ ignore?: LiteralUnion<'after-comment' | 'inside-single-line-block' | 'after-dollar-variable'>[]
177
+ }
197
178
  >
198
179
 
199
180
  type DollarVariableFirstInBlockOptions = RuleConfig<
200
181
  true,
182
+ [],
201
183
  {
202
- expect?: ('root' | 'at-rule' | 'function' | 'mixin' | 'if-else' | 'loops')[]
203
- ignore?: ('comments' | 'imports')[]
184
+ expect?: LiteralUnion<'root' | 'at-rule' | 'function' | 'mixin' | 'if-else' | 'loops'>[]
185
+ ignore?: LiteralUnion<'comments' | 'imports'>[]
204
186
  }
205
187
  >
206
188
 
@@ -209,24 +191,27 @@ type DollarVariableNoMissingInterpolationOptions = RuleConfig<true>
209
191
  type DollarVariableNoNamespacedAssignmentOptions = RuleConfig<true>
210
192
 
211
193
  type DollarVariablePatternOptions = RuleConfig<
212
- string | RegExp,
194
+ RegExpLike,
195
+ [variableName: string, pattern: RegExpLike],
213
196
  {
214
- ignore?: 'local' | 'global'
197
+ ignore?: LiteralUnion<'local' | 'global'>
215
198
  }
216
199
  >
217
200
 
218
201
  type DoubleSlashCommentEmptyLineBeforeOptions = RuleConfig<
219
202
  'always' | 'never',
203
+ [],
220
204
  {
221
- except?: ('first-nested' | 'inside-block')[]
222
- ignore?: ('between-comments' | 'stylelint-commands' | 'inside-block')[]
205
+ except?: LiteralUnion<'first-nested' | 'inside-block'>[]
206
+ ignore?: LiteralUnion<'between-comments' | 'stylelint-commands' | 'inside-block'>[]
223
207
  }
224
208
  >
225
209
 
226
210
  type DoubleSlashCommentInlineOptions = RuleConfig<
227
211
  'always' | 'never',
212
+ [],
228
213
  {
229
- ignore?: ('stylelint-commands')[]
214
+ ignore?: LiteralUnion<'stylelint-commands'>[]
230
215
  }
231
216
  >
232
217
 
@@ -241,13 +226,14 @@ type FunctionColorChannelOptions = RuleConfig<true>
241
226
  type FunctionColorRelativeOptions = RuleConfig<true>
242
227
 
243
228
  type FunctionDisallowedListOptions = RuleConfig<
244
- string | RegExp | (string | RegExp)[]
229
+ Arrayable<RegExpLike>
245
230
  >
246
231
 
247
232
  type FunctionNoUnknownOptions = RuleConfig<
248
233
  true,
234
+ [],
249
235
  {
250
- ignoreFunctions: (string | RegExp)[]
236
+ ignoreFunctions: RegExpLike[]
251
237
  }
252
238
  >
253
239
 
@@ -258,7 +244,7 @@ type FunctionUnquoteNoUnquotedStringsInsideOptions = RuleConfig<true>
258
244
  type LoadNoPartialLeadingUnderscoreOptions = RuleConfig<true>
259
245
 
260
246
  type LoadPartialExtensionOptions = RuleConfig<
261
- LiteralUnion<'always' | 'never'>
247
+ 'always' | 'never'
262
248
  >
263
249
 
264
250
  type MapKeysQuotesOptions = RuleConfig<
@@ -267,8 +253,9 @@ type MapKeysQuotesOptions = RuleConfig<
267
253
 
268
254
  type MediaFeatureValueDollarVariableOptions = RuleConfig<
269
255
  'always' | 'never',
256
+ [],
270
257
  {
271
- ignore?: ('keywords')[]
258
+ ignore?: LiteralUnion<'keywords'>[]
272
259
  }
273
260
  >
274
261
 
@@ -276,8 +263,9 @@ type NoDollarVariablesOptions = RuleConfig<true>
276
263
 
277
264
  type NoDuplicateDollarVariablesOptions = RuleConfig<
278
265
  true,
266
+ [],
279
267
  {
280
- ignoreInside?: ('at-rule' | 'nested-at-rule')[]
268
+ ignoreInside?: LiteralUnion<'at-rule' | 'nested-at-rule'>[]
281
269
  }
282
270
  >
283
271
 
@@ -298,21 +286,23 @@ type OperatorNoUnspacedOptions = RuleConfig<true>
298
286
  type PartialNoImportOptions = RuleConfig<true>
299
287
 
300
288
  type PercentPlaceholderPatternOptions = RuleConfig<
301
- string | RegExp
289
+ RegExpLike,
290
+ [placeholderName: string, pattern: RegExpLike]
302
291
  >
303
292
 
304
293
  type PropertyNoUnknownOptions = RuleConfig<
305
294
  true,
295
+ [],
306
296
  {
307
- ignoreProperties?: (string | RegExp)[]
297
+ ignoreProperties?: RegExpLike[]
308
298
  /**
309
299
  * Skips checking properties of the given selectors against this rule.
310
300
  */
311
- ignoreSelectors?: (string | RegExp)[]
301
+ ignoreSelectors?: RegExpLike[]
312
302
  /**
313
303
  * Ignores properties nested within specified at-rules.
314
304
  */
315
- ignoreAtRules?: (AtRules | RegExpLike)[]
305
+ ignoreAtRules?: (AtRules | RegExp)[]
316
306
  /**
317
307
  * If `true`, this rule will check vendor-prefixed properties.
318
308
  * @default false
@@ -321,14 +311,23 @@ type PropertyNoUnknownOptions = RuleConfig<
321
311
  }
322
312
  >
323
313
 
314
+ type SelectorClassPatternOptions = RuleConfig<
315
+ RegExpLike,
316
+ [],
317
+ {
318
+ resolveNestedSelectors?: boolean
319
+ }
320
+ >
321
+
324
322
  type SelectorNestCombinatorsOptions = RuleConfig<
325
323
  'always' | 'never'
326
324
  >
327
325
 
328
326
  type SelectorNoRedundantNestingSelectorOptions = RuleConfig<
329
327
  true,
328
+ [],
330
329
  {
331
- ignoreKeywords?: (string | RegExp)[]
330
+ ignoreKeywords?: RegExpLike[]
332
331
  }
333
332
  >
334
333
 
@@ -441,60 +440,6 @@ interface RuleOptions {
441
440
  * @see [at-if-no-null](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/at-if-no-null)
442
441
  */
443
442
  'scss/at-if-no-null': AtIfNoNullOptions;
444
- /**
445
- * @deprecated Use `load-partial-extension` instead, and will be removed in '7.0'.
446
- *
447
- * Require or disallow extension in `@import` commands.
448
- *
449
- * The rule ignores [cases](https://sass-lang.com/documentation/at-rules/import) when Sass considers an `@import` command just a plain CSS import:
450
- * - If the file’s extension is `.css`.
451
- * - If the filename begins with `http://` (or any other protocol).
452
- * - If the filename is a `url()`.
453
- * - If the `@import` has any media queries.
454
- *
455
- * @see [at-import-partial-extension](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/at-import-partial-extension)
456
- */
457
- 'scss/at-import-partial-extension': AtImportPartialExtensionOptions;
458
- /**
459
- * Disallow leading underscore in partial names in `@import`.
460
- *
461
- * The rule ignores [cases](https://sass-lang.com/documentation/at-rules/import) when Sass considers an `@import` command just a plain CSS import:
462
- * - If the file’s extension is `.css`.
463
- * - If the filename begins with `http://` (or any other protocol).
464
- * - If the filename is a `url()`.
465
- * - If the `@import` has any media queries.
466
- *
467
- * @see [at-import-no-partial-leading-underscore](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/at-import-no-partial-leading-underscore)
468
- */
469
- 'scss/at-import-no-partial-leading-underscore': AtImportNoPartialLeadingUnderscoreOptions;
470
- /**
471
- * @deprecated Use `at-import-partial-extension-disallowed-list` instead, and will be removed in '7.0'.
472
- *
473
- * Specify a blacklist of disallowed file extensions for partial names in `@import` commands.
474
- *
475
- * The rule ignores [cases](https://sass-lang.com/documentation/at-rules/import) when Sass considers an `@import` command just a plain CSS import:
476
- * - If the file’s extension is `.css`.
477
- * - If the filename begins with `http://` (or any other protocol).
478
- * - If the filename is a `url()`.
479
- * - If the `@import` has any media queries.
480
- *
481
- * @see [at-import-partial-extension-blacklist](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/at-import-partial-extension-blacklist)
482
- */
483
- 'scss/at-import-partial-extension-blacklist': AtImportPartialExtensionBlacklistOptions;
484
- /**
485
- * @deprecated Use `at-import-partial-extension-allowed-list` instead, and will be removed in '7.0'.
486
- *
487
- * Specify a whitelist of allowed file extensions for partial names in `@import` commands.
488
- *
489
- * The rule ignores [cases](https://sass-lang.com/documentation/at-rules/import) when Sass considers an `@import` command just a plain CSS import:
490
- * - If the file’s extension is `.css`.
491
- * - If the filename begins with `http://` (or any other protocol).
492
- * - If the filename is a `url()`.
493
- * - If the `@import` has any media queries.
494
- *
495
- * @see [at-import-partial-extension-whitelist](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/at-import-partial-extension-whitelist)
496
- */
497
- 'scss/at-import-partial-extension-whitelist': AtImportPartialExtensionWhitelistOptions;
498
443
  /**
499
444
  * Specify a whitelist of allowed file extensions for partial names in `@import` commands.
500
445
  *
@@ -739,10 +684,14 @@ interface RuleOptions {
739
684
  */
740
685
  'scss/dollar-variable-empty-line-before': DollarVariableEmptyLineBeforeOptions;
741
686
  /**
742
- * Disallow Sass variables that are used without interpolation with CSS features that use custom identifiers.
687
+ * This rule flags four situations in which Sass variables require interpolation:
743
688
  *
744
- * Sass variables that contain a custom identifier as a string always require interpolation when used.
745
- * Some CSS [at-rules](https://css-tricks.com/the-at-rules-of-css/) require variable interpolation even when the custom identifier value is not a string.
689
+ * - String-valued variables with custom identifier properties,
690
+ * - Variables in custom identifier at-rules,
691
+ * - Variables in `@supports` conditions, and
692
+ * - Variables in CSS custom properties.
693
+ *
694
+ * **Note**: For scenarios 1 and 3 regarding string-valued variables, this rule can only check variables that are defined in the same file where they are used, since it needs to determine if the variable's value is a string. Scenarios 2 and 4 check all variables regardless of where they are defined.
746
695
  *
747
696
  * @see [dollar-variable-no-missing-interpolation](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/dollar-variable-no-missing-interpolation)
748
697
  */
@@ -1042,6 +991,12 @@ interface RuleOptions {
1042
991
  * @see [percent-placeholder-pattern](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/percent-placeholder-pattern)
1043
992
  */
1044
993
  'scss/percent-placeholder-pattern': PercentPlaceholderPatternOptions;
994
+ /**
995
+ * Specify a pattern for class selectors.
996
+ *
997
+ * @see [selector-class-pattern](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/selector-class-pattern/)
998
+ */
999
+ 'scss/selector-class-pattern': SelectorClassPatternOptions;
1045
1000
  /**
1046
1001
  * Require or disallow nesting of combinators in selectors
1047
1002
  *
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@stylelint-types/stylelint-scss",
3
3
  "type": "module",
4
- "version": "6.11.0",
4
+ "version": "7.0.0",
5
5
  "description": "TypeScript definitions for stylelint-define-config",
6
6
  "author": "pengzhanbo <volodymyr@foxmail.com> (https://github.com/pengzhanbo)",
7
7
  "license": "MIT",
@@ -25,7 +25,8 @@
25
25
  ],
26
26
  "exports": {
27
27
  ".": {
28
- "types": "./lib/index.d.ts"
28
+ "types": "./lib/index.d.ts",
29
+ "import": "./lib/index.js"
29
30
  },
30
31
  "./types": {
31
32
  "types": "./lib/types.d.ts"
@@ -36,13 +37,13 @@
36
37
  "lib"
37
38
  ],
38
39
  "engines": {
39
- "node": ">=18.0.0",
40
+ "node": ">=20.19.0",
40
41
  "npm": ">=9.0.0",
41
- "pnpm": ">=8.0.0"
42
+ "pnpm": ">=9.0.0"
42
43
  },
43
44
  "peerDependencies": {
44
- "stylelint": ">=16.0.0",
45
- "stylelint-define-config": ">=1.0.0"
45
+ "stylelint": ">=17",
46
+ "stylelint-define-config": ">=17"
46
47
  },
47
48
  "peerDependenciesMeta": {
48
49
  "stylelint": {
@@ -50,21 +51,25 @@
50
51
  }
51
52
  },
52
53
  "devDependencies": {
53
- "@pengzhanbo/eslint-config": "^1.29.0",
54
- "bumpp": "^10.1.0",
54
+ "@pengzhanbo/eslint-config": "^1.45.0",
55
+ "bumpp": "^10.4.0",
55
56
  "conventional-changelog-cli": "^5.0.0",
56
- "eslint": "^9.24.0",
57
- "stylelint": "^16.18.0",
58
- "stylelint-define-config": "^16.18.0",
59
- "stylelint-scss": "^6.11.1",
60
- "tsup": "^8.4.0",
61
- "typescript": "^5.8.3"
57
+ "eslint": "^9.39.2",
58
+ "stylelint": "^17.0.0",
59
+ "stylelint-define-config": "^17.0.0",
60
+ "stylelint-scss": "^7.0.0",
61
+ "tsup": "^8.5.1",
62
+ "typescript": "^5.9.3"
63
+ },
64
+ "publishConfig": {
65
+ "access": "public",
66
+ "provenance": true
62
67
  },
63
68
  "scripts": {
64
69
  "lint": "eslint .",
65
70
  "build": "tsup",
66
- "prepublish": "pnpm lint && pnpm build",
71
+ "release:publish": "pnpm publish",
67
72
  "release:changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
68
- "release": "bumpp package.json --execute=\"pnpm release:changelog\" --commit --all --push --tag && pnpm publish --access public"
73
+ "release": "bumpp package.json --execute=\"pnpm release:changelog\" --commit --all --push --tag"
69
74
  }
70
75
  }