settings

Author: francoismassart

docs/rules/my-rule.md

@@ -22,7 +22,7 @@ Examples would normally go here.
 | `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`                 |
+| `someBool`           | someBool description.                                                | Boolean  |                   | `false`                |
 | `someEnum`           | someEnum description.                                                | String   | `always`, `never` | `always`               |
 | `tags`               | List of tags to be detected in template literals                     | String[] |                   | [`tw`]                 |
 

src/rules/my-rule.spec.ts

@@ -33,6 +33,16 @@ ruleTester.run(RULE_NAME, myRule, {
     {
       code: `<button onClick={() => { const name = 'John'; alert(name); }}>JSX</button>`,
     },
+    {
+      // a code snippet that should pass the linter
+      code: `var x = 5;`,
+      options: [
+        {
+          someBool: true,
+          someEnum: "always",
+        },
+      ],
+    },
   ],
   invalid: [
     {

src/rules/my-rule.ts

@@ -18,16 +18,26 @@ type MessageIds = "issue:var" | "fix:let" | "fix:const";
 
 /**
  * The extra options that the rule can accept.
- * These options are merged with the shared settings.
+ * These options get 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 = {
+type RuleOptions = {
   someBool: boolean;
   someEnum: string;
-} & PluginSettings;
+};
 
-type Options = [RuleOptions];
+export type MergedOptions = RuleOptions & PluginSettings;
+
+const RULE_DEFAULT: RuleOptions = {
+  someBool: false,
+  someEnum: "always",
+};
+
+// TODO which one ?
+// - type Options = [RuleOptions];
+// - type Options = [MergedOptions];
+type Options = [MergedOptions];
 
 // 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.
@@ -54,13 +64,13 @@ export const myRule = createRule<Options, MessageIds>({
           someBool: {
             description: "someBool description.",
             type: "boolean",
-            default: true,
+            default: RULE_DEFAULT.someBool,
           },
           someEnum: {
             description: "someEnum description.",
             type: "string",
             enum: ["always", "never"],
-            default: "always",
+            default: RULE_DEFAULT.someEnum,
           },
         },
         additionalProperties: false,
@@ -83,27 +93,29 @@ export const myRule = createRule<Options, MessageIds>({
     },
   ],
   create: (context, options) => {
+    // Reading inline configuration
+    console.log("\n", new Date(), "\n", "Options (rule):", "\n", options[0]);
+
+    // Shared settings
+    const sharedSettings = (context.settings?.tailwindcss ||
+      DEFAULTS) as PluginSharedSettings;
+    console.log("\n", "sharedSettings (rule):", "\n", sharedSettings);
+
+    // Merged settings
+    // const merged = parsePluginSettings(options[0]) as RuleOptions;
+    const merged = parsePluginSettings<RuleOptions>({
+      tailwindcss: options[0],
+    }) as RuleOptions;
+    console.log("\n", "merged (rule):", "\n", merged);
+
     return {
       VariableDeclaration: (node) => {
+        console.log("\n", "merged.someBool:", "\n", merged.someBool);
+        if (merged.someBool === true) {
+          console.log("someBool is true, processing VariableDeclaration");
+          return;
+        }
         if (node.kind === "var") {
-          // Reading inline configuration
-          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 (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,

src/utils/parse-plugin-settings.ts

@@ -66,14 +66,14 @@ export const sharedSettingsSchema: Record<keyof PluginSettings, JSONSchema4> = {
  * @param settings The shared settings from the ESLint configuration.
  * @returns The parsed plugin settings.
  */
-export function parsePluginSettings(
+export function parsePluginSettings<RuleOptions>(
   settings: SharedConfigurationSettings
-): PluginSettings {
-  const noConfig =
-    typeof settings.tailwindcss !== "object" || settings.tailwindcss === null;
+): PluginSettings & RuleOptions {
   const tailwindcssSettings = (
-    noConfig ? {} : settings.tailwindcss
-  ) as PluginSettings;
+    typeof settings.tailwindcss !== "object" || settings.tailwindcss === null
+      ? {}
+      : settings.tailwindcss
+  ) as PluginSettings & RuleOptions;
 
   return {
     ...DEFAULTS,