feat: add rule desc

Author: pengzhanbo

src/config/customSyntax.d.ts

@@ -1,5 +1,20 @@
 import type { LiteralUnion } from '../utils'
 
+/**
+ * This is a special exported interface for other packages to declare
+ * additional types that should bail out for stylelint postcss custom syntax. For example
+ * `stylelint-scss` can declare it like so in its `d.ts`:
+ *
+ * ```ts
+ * declare module 'stylelint-define-config' {
+ *   export interface CustomSyntax {
+ *     'postcss-scss': void;
+ *
+ *     // ... more syntax
+ *   }
+ * }
+ * ```
+ */
 export interface CustomSyntax {}
 
 export type KnownCustomSyntax = LiteralUnion<

src/config/extends.d.ts

@@ -1,18 +1,27 @@
 import type { LiteralUnion } from '../utils'
 
+/**
+ * This is a special exported interface for other packages to declare
+ * additional types that should bail out for stylelint extends. For example
+ * `stylelint-scss` can declare it like so in its `d.ts`:
+ *
+ * ```ts
+ * declare module 'stylelint-define-config' {
+ *   export interface CustomExtends {
+ *     'stylelint-config-standard-scss': void;
+ *
+ *     // ... more extends
+ *   }
+ * }
+ * ```
+ */
 export interface CustomExtends {}
 
 export type KnownExtends = LiteralUnion<
   | 'stylelint-config-standard'
   | 'stylelint-config-standard-scss'
-  | 'stylelint-config-recess-order'
-  | 'stylelint-config-rational-order'
   | 'stylelint-config-prettier'
   | 'stylelint-config-prettier-scss'
   | 'stylelint-config-recommended-vue'
-  | 'stylelint-config-sass-guidelines'
-  | 'stylelint-config-primer'
-  | 'stylelint-config-wikimedia'
-  | 'stylelint-config-wordpress'
   | keyof CustomExtends
 >

src/config/index.d.ts

@@ -8,6 +8,8 @@ export interface PluginFunctions {
   [pluginName: string]: Rule
 }
 
+export type Extends = KnownExtends | StylelintConfig
+
 /**
  * specify what subset of files to apply a configuration to.
  */
@@ -70,6 +72,13 @@ export interface StylelintConfig {
 
   /**
    * Pattern of files to ignore (in addition to those in `.stylelintignore` ).
+   * @see [Configure ignorePatterns](https://stylelint.io/user-guide/configure#ignorefiles)
+   * @example
+   * ```json
+   * {
+   *   "ignorePatterns": ["**\/*.js"]
+   * }
+   * ```
    */
   ignorePatterns?: string
 
@@ -83,7 +92,18 @@ export interface StylelintConfig {
   ignoreDisables?: boolean
 
   /**
-   * You can set what configuration comments like `\/* stylelint-disable *\/` start with.This can be useful if you use multiple instances of Stylelint with different configurations.
+   * You can set what configuration comments like `\/* stylelint-disable *\/` start with.
+   * This can be useful if you use multiple instances of Stylelint with different configurations.
+   *
+   * For example, to have an instance of Stylelint disable rules with \/* stylelint-foo-instance-disable *\/ instead of the default \/* stylelint-disable *\/:
+   *
+   * @see [configuration comment](https://stylelint.io/user-guide/configure#configurationcomment)
+   * @example
+   * ```json
+   * {
+   *   "configurationComment": "stylelint-foo-instance"
+   * }
+   * ```
    */
   configurationComment?: string
 
@@ -139,12 +159,18 @@ export interface StylelintConfig {
    * }
    * ```
    */
-  extends?: KnownExtends | KnownExtends[]
+  extends?: Extends | Extends[]
   /**
    * Plugins are custom rules or sets of custom rules built to support methodologies,
    * toolsets, non-standard CSS features, or very specific use cases.
    *
    * @see [Configure plugins](https://stylelint.io/user-guide/configure#plugins)
+   * @example
+   * ```json
+   * {
+   *   "plugins": ["stylelint-scss"],
+   * }
+   * ```
    */
   plugins?: Plugins
 

src/config/plugins.d.ts

@@ -3,7 +3,7 @@ import type { LiteralUnion } from '../utils'
 
 /**
  * This is a special exported interface for other packages to declare
- * additional plugins that should bail out for eslint plugins. For example
+ * additional plugins that should bail out for stylelint plugins. For example
  * `'stylelint-scss'` can declare it like so in its `d.ts`:
  *
  * ```ts
@@ -18,7 +18,7 @@ export interface CustomPlugins {}
 
 type KnownPlugins = LiteralUnion<
   | 'stylelint-order' | 'stylelint-scss' | 'stylelint-stylistic' | 'stylelint-stylus'
-  | 'stylelint-suitcss' | 'stylelint-react-native' | 'stylelint-selector-bem-pattern'
+  | 'stylelint-suitcss' | 'stylelint-react-native' | 'stylelint-codeguide'
   | keyof CustomPlugins
 >
 

src/rules/index.d.ts

@@ -3,7 +3,7 @@ import type { StyleLintRules } from './stylelint'
 
 /**
  * This is a special exported interface for other packages to declare
- * additional types that should bail out for eslint rules. For example
+ * additional types that should bail out for stylelint rules. For example
  * `stylelint-scss` can declare it like so in its `d.ts`:
  *
  * ```ts

src/rules/rule-config.d.ts

@@ -28,6 +28,11 @@ export interface SecondaryOptions {
   message?: string | ((...args: any[]) => string)
 }
 
+/**
+ * declaration rule config.
+ *
+ * `RuleConfig<PrimaryOptions, SecondaryOptions>`
+ */
 export type RuleConfig<T, S extends Record<string, any> = Record<string, any>>
   = null
   | undefined