playing with settings

Author: francoismassart

docs/rules/my-rule.md

@@ -16,9 +16,14 @@ Examples would normally go here.
 
 <!-- begin auto-generated rule options list -->
 
-| Name       | Description           | Type    | Choices           | Default  |
-| :--------- | :-------------------- | :------ | :---------------- | :------- |
-| `someBool` | someBool description. | Boolean |                   | `true`   |
-| `someEnum` | someEnum description. | String  | `always`, `never` | `always` |
+| Name                 | Description                                                          | Type     | Choices           | Default                |
+| :------------------- | :------------------------------------------------------------------- | :------- | :---------------- | :--------------------- |
+| `callees`            | List of function names to validate classnames                        | String[] |                   | [`ctl`]                |
+| `cssConfigPath`      | Path to the Tailwind CSS configuration file (*.css)                  | String   |                   | `default-path/app.css` |
+| `removeDuplicates`   | Remove duplicated classnames                                         | Boolean  |                   | `true`                 |
+| `skipClassAttribute` | If you only want to lint the classnames inside one of the `callees`. | Boolean  |                   | `false`                |
+| `someBool`           | someBool description.                                                | Boolean  |                   | `true`                 |
+| `someEnum`           | someEnum description.                                                | String   | `always`, `never` | `always`               |
+| `tags`               | List of tags to be detected in template literals                     | String[] |                   | [`tw`]                 |
 
 <!-- end auto-generated rule options list -->

src/rules/my-rule.spec.ts

@@ -19,6 +19,13 @@ ruleTester.run(RULE_NAME, myRule, {
     {
       // a code snippet that should pass the linter
       code: `const x = 5;`,
+      options: [
+        {
+          callees: ["ctl2"],
+          someBool: true,
+          someEnum: "always",
+        },
+      ],
     },
     {
       code: `let y = 'abc123';`,

src/rules/my-rule.ts

@@ -2,6 +2,12 @@ import { RuleCreator } from "@typescript-eslint/utils/eslint-utils";
 
 import { PluginSharedSettings } from "../types";
 import urlCreator from "../url-creator";
+import {
+  DEFAULTS,
+  parsePluginSettings,
+  type PluginSettings,
+  sharedSettingsSchema,
+} from "../utils/parse-plugin-settings";
 
 export { ESLintUtils } from "@typescript-eslint/utils";
 
@@ -10,13 +16,18 @@ export const RULE_NAME = "my-rule";
 // Message IDs don't need to be prefixed, I just find it easier to keep track of them this way
 type MessageIds = "issue:var" | "fix:let" | "fix:const";
 
-// The options that the rule can take
-type Options = [
-  {
-    someBool: boolean;
-    someEnum: string;
-  }
-];
+/**
+ * The extra options that the rule can accept.
+ * These options are merged with the shared settings.
+ * The typing is not used by `eslint-doc-generator` which uses the `schema` property in the rule's metadata.
+ * Yet, it is useful for the IDE to provide autocompletion and type checking.
+ */
+export type RuleOptions = {
+  someBool: boolean;
+  someEnum: string;
+} & PluginSettings;
+
+type Options = [RuleOptions];
 
 // The Rule creator returns a function that is used to create a well-typed ESLint rule
 // The parameter passed into RuleCreator is a URL generator function.
@@ -34,10 +45,12 @@ export const myRule = createRule<Options, MessageIds>({
       "fix:let": "Replace this `var` declaration with `let`",
       "fix:const": "Replace this `var` declaration with `const`",
     },
+    // Schema is also parsed by `eslint-doc-generator`
     schema: [
       {
         type: "object",
         properties: {
+          ...sharedSettingsSchema,
           someBool: {
             description: "someBool description.",
             type: "boolean",
@@ -62,21 +75,35 @@ export const myRule = createRule<Options, MessageIds>({
    * - If some configuration is provided as the second argument, it is ignored, not merged
    * - In other words, the `defaultOptions` is only used when the rule is used without configuration
    */
-  defaultOptions: [{ someBool: false, someEnum: "always" }],
+  defaultOptions: [
+    {
+      ...DEFAULTS,
+      someBool: false,
+      someEnum: "always",
+    },
+  ],
   create: (context, options) => {
     return {
       VariableDeclaration: (node) => {
         if (node.kind === "var") {
           // Reading inline configuration
-          console.log("\n", "Options:", "\n", options[0]);
-
+          console.log(
+            "\n",
+            new Date(),
+            "\n",
+            "Options (rule):",
+            "\n",
+            options[0]
+          );
           // Shared settings
           const sharedSettings = (context.settings?.tailwindcss || {
             stylesheet: "",
             functions: [],
           }) as PluginSharedSettings;
-          console.log("\n", "sharedSettings:", "\n", sharedSettings);
+          console.log("\n", "sharedSettings (rule):", "\n", sharedSettings);
 
+          const merged: PluginSettings = parsePluginSettings(context.settings);
+          console.log("\n", "merged (rule):", "\n", merged);
           const rangeStart = node.range[0];
           const range: readonly [number, number] = [
             rangeStart,