docs: updating config parameter’s default

Author: francoismassart

README.md

@@ -40,6 +40,7 @@ You can can the same information on your favorite command line software as well.
 
 ## Latest changelog
 
+- feat: [support tailwind config in typescript](https://github.com/francoismassart/eslint-plugin-tailwindcss/pull/242) (by [quesabe](https://github.com/quesabe) 🙏)
 - feat: [add `ignoredKeys` in settings](https://github.com/francoismassart/eslint-plugin-tailwindcss/issues/232) used for `cva` or similar
 - fix: [callees with dot](https://github.com/francoismassart/eslint-plugin-tailwindcss/issues/227)
 - fix: [`no-custom-classname` doesn't work with hyphenated group names](https://github.com/francoismassart/eslint-plugin-tailwindcss/issues/226)
@@ -180,7 +181,7 @@ FYI, here are the `default` values:
     tailwindcss: {
       // These are the default values but feel free to customize
       callees: ["classnames", "clsx", "ctl"],
-      config: "tailwind.config.js",
+      config: "tailwind.config.js", // returned from `loadConfig()` utility if not provided
       cssFiles: [
         "**/*.css",
         "!**/node_modules",

docs/rules/classnames-order.md

@@ -45,9 +45,9 @@ You can specify which key(s) won't be parsed by the plugin using this setting.
 For example, `cva` has `compoundVariants` and `defaultVariants`.
 NB: As `compoundVariants` can have classnames inside its `class` property, you can also use a callee to make sure this inner part gets parsed while its parent is ignored.
 
-### `config` (default: `"tailwind.config.js"`)
+### `config` (default: generated by `tailwindcss/lib/lib/load-config`)
 
-By default the plugin will try to load the file `tailwind.config.js` at the root of your project.
+By default the plugin will try to load the file returned by the official `loadConfig()` utility.
 
 This allows the plugin to use your customized `colors`, `spacing`, `screens`...
 

docs/rules/enforces-negative-arbitrary-values.md

@@ -63,9 +63,9 @@ You can specify which key(s) won't be parsed by the plugin using this setting.
 For example, `cva` has `compoundVariants` and `defaultVariants`.
 NB: As `compoundVariants` can have classnames inside its `class` property, you can also use a callee to make sure this inner part gets parsed while its parent is ignored.
 
-### `config` (default: `"tailwind.config.js"`)
+### `config` (default: generated by `tailwindcss/lib/lib/load-config`)
 
-By default the plugin will try to load the file `tailwind.config.js` at the root of your project.
+By default the plugin will try to load the file returned by the official `loadConfig()` utility.
 
 This allows the plugin to use your customized `colors`, `spacing`, `screens`...
 

docs/rules/enforces-shorthand.md

@@ -55,9 +55,9 @@ You can specify which key(s) won't be parsed by the plugin using this setting.
 For example, `cva` has `compoundVariants` and `defaultVariants`.
 NB: As `compoundVariants` can have classnames inside its `class` property, you can also use a callee to make sure this inner part gets parsed while its parent is ignored.
 
-### `config` (default: `"tailwind.config.js"`)
+### `config` (default: generated by `tailwindcss/lib/lib/load-config`)
 
-By default the plugin will try to load the file `tailwind.config.js` at the root of your project.
+By default the plugin will try to load the file returned by the official `loadConfig()` utility.
 
 This allows the plugin to use your customized `colors`, `spacing`, `screens`...
 

docs/rules/migration-from-tailwind-2.md

@@ -100,9 +100,9 @@ You can specify which key(s) won't be parsed by the plugin using this setting.
 For example, `cva` has `compoundVariants` and `defaultVariants`.
 NB: As `compoundVariants` can have classnames inside its `class` property, you can also use a callee to make sure this inner part gets parsed while its parent is ignored.
 
-### `config` (default: `"tailwind.config.js"`)
+### `config` (default: generated by `tailwindcss/lib/lib/load-config`)
 
-By default the plugin will try to load the file `tailwind.config.js` at the root of your project.
+By default the plugin will try to load the file returned by the official `loadConfig()` utility.
 
 This allows the plugin to use your customized `colors`, `spacing`, `screens`...
 

docs/rules/no-arbitrary-value.md

@@ -45,9 +45,9 @@ You can specify which key(s) won't be parsed by the plugin using this setting.
 For example, `cva` has `compoundVariants` and `defaultVariants`.
 NB: As `compoundVariants` can have classnames inside its `class` property, you can also use a callee to make sure this inner part gets parsed while its parent is ignored.
 
-### `config` (default: `"tailwind.config.js"`)
+### `config` (default: generated by `tailwindcss/lib/lib/load-config`)
 
-By default the plugin will try to load the file `tailwind.config.js` at the root of your project.
+By default the plugin will try to load the file returned by the official `loadConfig()` utility.
 
 This allows the plugin to use your customized `colors`, `spacing`, `screens`...
 

docs/rules/no-contradicting-classname.md

@@ -45,9 +45,9 @@ You can specify which key(s) won't be parsed by the plugin using this setting.
 For example, `cva` has `compoundVariants` and `defaultVariants`.
 NB: As `compoundVariants` can have classnames inside its `class` property, you can also use a callee to make sure this inner part gets parsed while its parent is ignored.
 
-### `config` (default: `"tailwind.config.js"`)
+### `config` (default: generated by `tailwindcss/lib/lib/load-config`)
 
-By default the plugin will try to load the file `tailwind.config.js` at the root of your project.
+By default the plugin will try to load the file returned by the official `loadConfig()` utility.
 
 This allows the plugin to use your customized `colors`, `spacing`, `screens`...
 

docs/rules/no-custom-classname.md

@@ -47,9 +47,9 @@ You can specify which key(s) won't be parsed by the plugin using this setting.
 For example, `cva` has `compoundVariants` and `defaultVariants`.
 NB: As `compoundVariants` can have classnames inside its `class` property, you can also use a callee to make sure this inner part gets parsed while its parent is ignored.
 
-### `config` (default: `"tailwind.config.js"`)
+### `config` (default: generated by `tailwindcss/lib/lib/load-config`)
 
-By default the plugin will try to load the file `tailwind.config.js` at the root of your project.
+By default the plugin will try to load the file returned by the official `loadConfig()` utility.
 
 This allows the plugin to use your customized `colors`, `spacing`, `screens`...
 

lib/rules/classnames-order.js

@@ -50,7 +50,7 @@ module.exports = {
             uniqueItems: true,
           },
           config: {
-            // default: 'tailwind.config.js',
+            // returned from `loadConfig()` utility
             type: ['string', 'object'],
           },
           removeDuplicates: {

lib/rules/enforces-negative-arbitrary-values.js

@@ -46,7 +46,7 @@ module.exports = {
             uniqueItems: true,
           },
           config: {
-            // default: 'tailwind.config.js',
+            // returned from `loadConfig()` utility
             type: ['string', 'object'],
           },
           tags: {