feat: sync to 3.1.1

pengzhanbo · pengzhanbo · commit e780fed49e20 · 2024-12-31T01:07:48.000+08:00
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ module.exports = defineConfig({
 })
 ```
 
-![](./static/demo.png)
+![demo](./static/demo.png)
 
 ## Credits
 
diff --git a/lib/rules/at-rule-name-case.d.ts b/lib/rules/at-rule-name-case.d.ts
@@ -1,5 +1,8 @@
 import type { RuleConfig } from 'stylelint-define-config'
 
 export type AtRuleNameCaseOptions = RuleConfig<
-  'lower' | 'upper'
+  'lower' | 'upper',
+  {
+    message?: string | ((name: string, expectedName: string) => string)
+  }
 >
diff --git a/lib/rules/color-hex-case.d.ts b/lib/rules/color-hex-case.d.ts
@@ -1,5 +1,8 @@
 import type { RuleConfig } from 'stylelint-define-config'
 
 export type ColorHexCaseOptions = RuleConfig<
-  'lower' | 'upper'
+  'lower' | 'upper',
+  {
+    message?: string | ((value: string, expected: string) => string)
+  }
 >
diff --git a/lib/rules/function-max-empty-lines.d.ts b/lib/rules/function-max-empty-lines.d.ts
@@ -1,3 +1,5 @@
 import type { RuleConfig } from 'stylelint-define-config'
 
-export type FunctionMaxEmptyLinesOptions = RuleConfig<number>
+export type FunctionMaxEmptyLinesOptions = RuleConfig<number, {
+  message?: string | ((primary: number) => string)
+}>
diff --git a/lib/rules/indentation.d.ts b/lib/rules/indentation.d.ts
@@ -8,5 +8,6 @@ export type IndentationOptions = RuleConfig<
     indentClosingBrace?: boolean
     except?: ('block' | 'param' | 'value')[]
     ignore?: ('inside-parens' | 'param' | 'value')[]
+    message?: string | ((expectation: string) => string)
   }
 >
diff --git a/lib/rules/linebreaks.d.ts b/lib/rules/linebreaks.d.ts
@@ -1,5 +1,8 @@
 import type { RuleConfig } from 'stylelint-define-config'
 
 export type LinebreaksOptions = RuleConfig<
-  'unix' | 'windows'
+  number,
+  {
+    message?: string | ((emptyLines: string) => string)
+  }
 >
diff --git a/lib/rules/max-line-length.d.ts b/lib/rules/max-line-length.d.ts
@@ -5,5 +5,6 @@ export type MaxLineLengthOptions = RuleConfig<
   {
     ignore?: ('non-comments' | 'comments')[]
     ignorePattern?: RegExpLike[]
+    message?: string | ((lineLength: number) => string)
   }
 >
diff --git a/lib/rules/media-feature-name-case.d.ts b/lib/rules/media-feature-name-case.d.ts
@@ -1,5 +1,8 @@
 import type { RuleConfig } from 'stylelint-define-config'
 
 export type MediaFeatureNameCaseOptions = RuleConfig<
-  'lower' | 'upper'
+  'lower' | 'upper',
+  {
+    message?: string | ((name: string, expectedName: string) => string)
+  }
 >
diff --git a/lib/rules/named-grid-areas-alignment.d.ts b/lib/rules/named-grid-areas-alignment.d.ts
@@ -0,0 +1,7 @@
+import type { RuleConfig } from 'stylelint-define-config'
+
+export type NamedGridAreasAlignmentOptions = RuleConfig<true, {
+  gap?: number
+  alignQuotes?: boolean
+  message?: string | (() => string)
+}>
diff --git a/lib/rules/property-case.d.ts b/lib/rules/property-case.d.ts
@@ -1,5 +1,8 @@
 import type { RuleConfig } from 'stylelint-define-config'
 
 export type PropertyCaseOptions = RuleConfig<
-  'lower' | 'upper'
+  'lower' | 'upper',
+  {
+    message?: string | ((property: string, expectedProperty: string) => string)
+  }
 >
diff --git a/lib/rules/selector-descendant-combinator-no-non-space.d.ts b/lib/rules/selector-descendant-combinator-no-non-space.d.ts
@@ -1,3 +1,5 @@
 import type { RuleConfig } from 'stylelint-define-config'
 
-export type SelectorDescendantCombinatorNoNonSpaceOptions = RuleConfig<true>
+export type SelectorDescendantCombinatorNoNonSpaceOptions = RuleConfig<true, {
+  message?: string | ((value: string) => string)
+}>
diff --git a/lib/rules/selector-max-empty-lines.d.ts b/lib/rules/selector-max-empty-lines.d.ts
@@ -1,5 +1,8 @@
 import type { LiteralUnion, RuleConfig } from 'stylelint-define-config'
 
 export type SelectorMaxEmptyLinesOptions = RuleConfig<
-  LiteralUnion<0 | 1, number>
+  LiteralUnion<0 | 1, number>,
+  {
+    message?: string | ((max: number) => string)
+  }
 >
diff --git a/lib/rules/selector-pseudo-class-case.d.ts b/lib/rules/selector-pseudo-class-case.d.ts
@@ -1,5 +1,8 @@
 import type { RuleConfig } from 'stylelint-define-config'
 
 export type SelectorPseudoClassCaseOptions = RuleConfig<
-  'lower' | 'upper'
+  'lower' | 'upper',
+  {
+    message?: string | ((pseudoClass: string, expectedPseudoClass: string) => string)
+  }
 >
diff --git a/lib/rules/selector-pseudo-element-case.d.ts b/lib/rules/selector-pseudo-element-case.d.ts
@@ -1,5 +1,8 @@
 import type { RuleConfig } from 'stylelint-define-config'
 
 export type SelectorPseudoElementCaseOptions = RuleConfig<
-  'lower' | 'upper'
+  'lower' | 'upper',
+  {
+    message?: string | ((pseudoElement: string, expectedPseudoElement: string) => string)
+  }
 >
diff --git a/lib/rules/string-quotes.d.ts b/lib/rules/string-quotes.d.ts
@@ -4,5 +4,6 @@ export type StringQuotesOptions = RuleConfig<
   'single' | 'double',
   {
     avoidEscape?: boolean
+    message: string | ((quotes: string) => string)
   }
 >
diff --git a/lib/rules/unit-case.d.ts b/lib/rules/unit-case.d.ts
@@ -1,5 +1,8 @@
 import type { RuleConfig } from 'stylelint-define-config'
 
 export type UnitCaseOptions = RuleConfig<
-  'lower' | 'upper'
+  'lower' | 'upper',
+  {
+    message?: string | ((unit: string, expectedUnit: string) => string)
+  }
 >
diff --git a/lib/rules/value-list-max-empty-lines.d.ts b/lib/rules/value-list-max-empty-lines.d.ts
@@ -1,3 +1,5 @@
 import type { RuleConfig } from 'stylelint-define-config'
 
-export type ValueListMaxEmptyLinesOptions = RuleConfig<number>
+export type ValueListMaxEmptyLinesOptions = RuleConfig<number, {
+  message?: string | ((max: number) => string)
+}>
diff --git a/lib/types.d.ts b/lib/types.d.ts
@@ -1,9 +1,9 @@
+import type { AtRuleNameCaseOptions } from './rules/at-rule-name-case'
 import type { AtRuleNameNewlineAfterOptions } from './rules/at-rule-name-newline-after'
 import type { AtRuleNameSpaceAfterOptions } from './rules/at-rule-name-space-after'
-import type { AtRuleNameCaseOptions } from './rules/at-rule-name-case'
+import type { AtRuleSemicolonNewlineAfterOptions } from './rules/at-rule-semicolon-newline-after'
 import type { AtRuleSemicolonSpaceBeforeOptions } from './rules/at-rule-semicolon-space-before'
 import type { BlockClosingBraceEmptyLineBeforeOptions } from './rules/block-closing-brace-empty-line-before'
-import type { AtRuleSemicolonNewlineAfterOptions } from './rules/at-rule-semicolon-newline-after'
 import type { BlockClosingBraceNewlineAfterOptions } from './rules/block-closing-brace-newline-after'
 import type { BlockClosingBraceNewlineBeforeOptions } from './rules/block-closing-brace-newline-before'
 import type { BlockClosingBraceSpaceAfterOptions } from './rules/block-closing-brace-space-after'
@@ -20,11 +20,11 @@ import type { DeclarationBlockSemicolonNewlineBeforeOptions } from './rules/decl
 import type { DeclarationBlockSemicolonSpaceAfterOptions } from './rules/declaration-block-semicolon-space-after'
 import type { DeclarationBlockSemicolonSpaceBeforeOptions } from './rules/declaration-block-semicolon-space-before'
 import type { DeclarationBlockTrailingSemicolonOptions } from './rules/declaration-block-trailing-semicolon'
+import type { DeclarationColonNewlineAfterOptions } from './rules/declaration-colon-newline-after'
 import type { DeclarationColonSpaceAfterOptions } from './rules/declaration-colon-space-after'
 import type { DeclarationColonSpaceBeforeOptions } from './rules/declaration-colon-space-before'
 import type { FunctionCommaNewlineAfterOptions } from './rules/function-comma-newline-after'
 import type { FunctionCommaNewlineBeforeOptions } from './rules/function-comma-newline-before'
-import type { DeclarationColonNewlineAfterOptions } from './rules/declaration-colon-newline-after'
 import type { FunctionCommaSpaceAfterOptions } from './rules/function-comma-space-after'
 import type { FunctionCommaSpaceBeforeOptions } from './rules/function-comma-space-before'
 import type { FunctionMaxEmptyLinesOptions } from './rules/function-max-empty-lines'
@@ -45,14 +45,15 @@ import type { MediaQueryListCommaNewlineAfterOptions } from './rules/media-query
 import type { MediaQueryListCommaNewlineBeforeOptions } from './rules/media-query-list-comma-newline-before'
 import type { MediaQueryListCommaSpaceAfterOptions } from './rules/media-query-list-comma-space-after'
 import type { MediaQueryListCommaSpaceBeforeOptions } from './rules/media-query-list-comma-space-before'
+import type { NamedGridAreasAlignmentOptions } from './rules/named-grid-areas-alignment'
 import type { NoEmptyFirstLineOptions } from './rules/no-empty-first-line'
 import type { NoEolWhitespaceOptions } from './rules/no-eol-whitespace'
 import type { NoExtraSemicolonsOptions } from './rules/no-extra-semicolons'
 import type { NoMissingEndOfSourceNewlineOptions } from './rules/no-missing-end-of-source-newline'
 import type { NumberLeadingZeroOptions } from './rules/number-leading-zero'
 import type { NumberNoTrailingZerosOptions } from './rules/number-no-trailing-zeros'
-import type { SelectorAttributeBracketsSpaceInsideOptions } from './rules/selector-attribute-brackets-space-inside'
 import type { PropertyCaseOptions } from './rules/property-case'
+import type { SelectorAttributeBracketsSpaceInsideOptions } from './rules/selector-attribute-brackets-space-inside'
 import type { SelectorAttributeOperatorSpaceAfterOptions } from './rules/selector-attribute-operator-space-after'
 import type { SelectorAttributeOperatorSpaceBeforeOptions } from './rules/selector-attribute-operator-space-before'
 import type { SelectorCombinatorSpaceAfterOptions } from './rules/selector-combinator-space-after'
@@ -64,8 +65,8 @@ import type { SelectorListCommaSpaceAfterOptions } from './rules/selector-list-c
 import type { SelectorListCommaSpaceBeforeOptions } from './rules/selector-list-comma-space-before'
 import type { SelectorMaxEmptyLinesOptions } from './rules/selector-max-empty-lines'
 import type { SelectorPseudoClassCaseOptions } from './rules/selector-pseudo-class-case'
-import type { SelectorPseudoElementCaseOptions } from './rules/selector-pseudo-element-case'
 import type { SelectorPseudoClassParenthesesSpaceInsideOptions } from './rules/selector-pseudo-class-parentheses-space-inside'
+import type { SelectorPseudoElementCaseOptions } from './rules/selector-pseudo-element-case'
 import type { StringQuotesOptions } from './rules/string-quotes'
 import type { UnicodeBomOptions } from './rules/unicode-bom'
 import type { UnitCaseOptions } from './rules/unit-case'
@@ -415,6 +416,12 @@ export interface RuleOptions {
    */
   '@stylistic/media-query-list-comma-space-before': MediaQueryListCommaSpaceBeforeOptions
 
+  /**
+   * Require cell tokens (and optionally ending quotes) within grid-template-areas to be aligned.
+   *
+   * @see [value-list-max-empty-lines](https://github.com/stylelint-stylistic/stylelint-stylistic/tree/main/lib/rules/named-grid-areas-alignment)
+   */
+  '@stylistic/named-grid-areas-alignment': NamedGridAreasAlignmentOptions
   /**
    * Disallow empty first lines.
    *
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "@stylelint-types/stylelint-stylistic",
   "type": "module",
   "version": "3.0.1",
-  "packageManager": "pnpm@9.7.1",
+  "packageManager": "pnpm@9.15.2",
   "description": "TypeScript definitions for stylelint-define-config",
   "author": "pengzhanbo <volodymyr@foxmail.com> (https://github.com/pengzhanbo)",
   "license": "MIT",
@@ -57,13 +57,13 @@
     }
   },
   "devDependencies": {
-    "@pengzhanbo/eslint-config": "^1.12.0",
-    "@stylistic/stylelint-plugin": "^3.0.1",
-    "bumpp": "^9.5.1",
+    "@pengzhanbo/eslint-config": "^1.22.0",
+    "@stylistic/stylelint-plugin": "^3.1.1",
+    "bumpp": "^9.9.2",
     "conventional-changelog-cli": "^5.0.0",
-    "eslint": "^9.9.0",
-    "stylelint": "^16.8.2",
-    "stylelint-define-config": "^1.6.0",
-    "typescript": "^5.5.4"
+    "eslint": "^9.17.0",
+    "stylelint": "^16.12.0",
+    "stylelint-define-config": "^1.8.1",
+    "typescript": "^5.7.2"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`import type { RuleConfig } from 'stylelint-define-config'`
`2`	`2`
`3`	`3`	`export type AtRuleNameCaseOptions = RuleConfig<`
`4`		`- 'lower' \| 'upper'`
	`4`	`+ 'lower' \| 'upper',`
	`5`	`+ {`
	`6`	`+ message?: string \| ((name: string, expectedName: string) => string)`
	`7`	`+ }`
`5`	`8`	`>`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`import type { RuleConfig } from 'stylelint-define-config'`
`2`	`2`
`3`	`3`	`export type ColorHexCaseOptions = RuleConfig<`
`4`		`- 'lower' \| 'upper'`
	`4`	`+ 'lower' \| 'upper',`
	`5`	`+ {`
	`6`	`+ message?: string \| ((value: string, expected: string) => string)`
	`7`	`+ }`
`5`	`8`	`>`
Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@ export type IndentationOptions = RuleConfig<`
`8`	`8`	`indentClosingBrace?: boolean`
`9`	`9`	`except?: ('block' \| 'param' \| 'value')[]`
`10`	`10`	`ignore?: ('inside-parens' \| 'param' \| 'value')[]`
	`11`	`+ message?: string \| ((expectation: string) => string)`
`11`	`12`	`}`
`12`	`13`	`>`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`import type { RuleConfig } from 'stylelint-define-config'`
`2`	`2`
`3`	`3`	`export type LinebreaksOptions = RuleConfig<`
`4`		`- 'unix' \| 'windows'`
	`4`	`+ number,`
	`5`	`+ {`
	`6`	`+ message?: string \| ((emptyLines: string) => string)`
	`7`	`+ }`
`5`	`8`	`>`
Original file line number	Diff line number	Diff line change
`@@ -5,5 +5,6 @@ export type MaxLineLengthOptions = RuleConfig<`
`5`	`5`	`{`
`6`	`6`	`ignore?: ('non-comments' \| 'comments')[]`
`7`	`7`	`ignorePattern?: RegExpLike[]`
	`8`	`+ message?: string \| ((lineLength: number) => string)`
`8`	`9`	`}`
`9`	`10`	`>`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`import type { RuleConfig } from 'stylelint-define-config'`
`2`	`2`
`3`	`3`	`export type MediaFeatureNameCaseOptions = RuleConfig<`
`4`		`- 'lower' \| 'upper'`
	`4`	`+ 'lower' \| 'upper',`
	`5`	`+ {`
	`6`	`+ message?: string \| ((name: string, expectedName: string) => string)`
	`7`	`+ }`
`5`	`8`	`>`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`import type { RuleConfig } from 'stylelint-define-config'`
`2`	`2`
`3`	`3`	`export type PropertyCaseOptions = RuleConfig<`
`4`		`- 'lower' \| 'upper'`
	`4`	`+ 'lower' \| 'upper',`
	`5`	`+ {`
	`6`	`+ message?: string \| ((property: string, expectedProperty: string) => string)`
	`7`	`+ }`
`5`	`8`	`>`