@mouse_484/eslint-config 4.3.3 → 4.4.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mouse_484/eslint-config",
   "type": "module",
-  "version": "4.3.3",
+  "version": "4.4.1",
   "author": "mouse_484",
   "license": "MIT",
   "homepage": "https://github.com/mouse484/config/tree/main/packages/eslint",
@@ -23,7 +23,7 @@
   },
   "dependencies": {
     "@antfu/eslint-config": "^4.14.1",
-    "eslint-plugin-readable-tailwind": "2.1.2",
+    "eslint-plugin-better-tailwindcss": "^3.1.0",
     "package-manager-detector": "^1.3.0"
   },
   "devDependencies": {

package/scripts/typegen.js

@@ -1,9 +1,9 @@
 import fs from 'node:fs/promises'
-import eslintPluginReadableTailwind from 'eslint-plugin-readable-tailwind'
+import eslintPluginBetterTailwindcss from 'eslint-plugin-better-tailwindcss'
 import { pluginsToRulesDTS } from 'eslint-typegen/core'
 
 const dts = await pluginsToRulesDTS({
-  'readable-tailwind': eslintPluginReadableTailwind,
+  tailwind: eslintPluginBetterTailwindcss,
 })
 
 await fs.writeFile('./src/lib/rules.gen.d.ts', dts)

package/src/configs/tailwind.js

@@ -1,4 +1,4 @@
-import eslintPluginReadableTailwind from 'eslint-plugin-readable-tailwind'
+import eslintPluginBetterTailwindcss from 'eslint-plugin-better-tailwindcss'
 import { createConfigs } from '../lib/factory.js'
 
 export default createConfigs({
@@ -7,18 +7,26 @@ export default createConfigs({
   configs: [
     (meta) => {
       return {
-        name: 'readable-tailwind',
+        name: 'tailwind',
         plugins: {
-          'readable-tailwind': eslintPluginReadableTailwind,
+          tailwind: eslintPluginBetterTailwindcss,
         },
         rules: {
-          ...eslintPluginReadableTailwind.configs.warning.rules,
-          'readable-tailwind/multiline': ['warn', {
+          // stylistic
+          'tailwind/multiline': ['warn', {
             group: 'newLine',
           }],
+          'tailwind/no-unnecessary-whitespace': 'warn',
+          'tailwind/sort-classes': 'warn',
+          'tailwind/no-duplicate-classes': 'error',
+          'tailwind/enforce-consistent-variable-syntax': 'error',
+          // correctness
+          'tailwind/no-unregistered-classes': 'error',
+          'tailwind/no-conflicting-classes': 'error',
+          'tailwind/no-restricted-classes': 'off',
         },
         settings: {
-          'readable-tailwind': {
+          tailwind: {
             entryPoint: meta?.entryPoint,
           },
         },

package/src/configs/unicorn.js

@@ -1,3 +1,4 @@
+import { CASES } from '../const/cases.js'
 import { GLOB_MARKDOWN_CODE_BLOCK, GLOB_README } from '../const/glob.js'
 import { createConfigs } from '../lib/factory.js'
 
@@ -32,5 +33,18 @@ export default createConfigs({
         'unicorn/prevent-abbreviations': 'off',
       },
     },
+    {
+      name: 'react-components',
+      withOptions: ['react'],
+      files: [
+        `**/src/components/**/*.{j,t}sx`,
+      ],
+      rules: {
+        'unicorn/filename-case': [
+          'error',
+          { case: CASES.PascalCase },
+        ],
+      },
+    },
   ],
 })

package/src/lib/rules.gen.d.ts

@@ -9,31 +9,128 @@ declare module 'eslint' {
 }
 
 export interface RuleOptions {
+  /**
+   * Enforce consistent syntax for css variables.
+   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-consistent-variable-syntax.md
+   */
+  'tailwind/enforce-consistent-variable-syntax'?: Linter.RuleEntry<TailwindEnforceConsistentVariableSyntax>
   /**
    * Enforce consistent line wrapping for tailwind classes.
-   * @see https://github.com/schoero/eslint-plugin-readable-tailwind/blob/main/docs/rules/multiline.md
+   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/multiline.md
    */
-  'readable-tailwind/multiline'?: Linter.RuleEntry<ReadableTailwindMultiline>
+  'tailwind/multiline'?: Linter.RuleEntry<TailwindMultiline>
+  /**
+   * Disallow classes that produce conflicting styles.
+   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-conflicting-classes.md
+   */
+  'tailwind/no-conflicting-classes'?: Linter.RuleEntry<TailwindNoConflictingClasses>
   /**
    * Disallow duplicate class names in tailwind classes.
-   * @see https://github.com/schoero/eslint-plugin-readable-tailwind/blob/main/docs/rules/no-duplicate-classes.md
+   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-duplicate-classes.md
+   */
+  'tailwind/no-duplicate-classes'?: Linter.RuleEntry<TailwindNoDuplicateClasses>
+  /**
+   * Disallow restricted classes.
+   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-restricted-classes.md
    */
-  'readable-tailwind/no-duplicate-classes'?: Linter.RuleEntry<ReadableTailwindNoDuplicateClasses>
+  'tailwind/no-restricted-classes'?: Linter.RuleEntry<TailwindNoRestrictedClasses>
   /**
    * Disallow unnecessary whitespace in tailwind classes.
-   * @see https://github.com/schoero/eslint-plugin-readable-tailwind/blob/main/docs/rules/no-unnecessary-whitespace.md
+   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-unnecessary-whitespace.md
+   */
+  'tailwind/no-unnecessary-whitespace'?: Linter.RuleEntry<TailwindNoUnnecessaryWhitespace>
+  /**
+   * Disallow any css classes that are not registered in tailwindcss.
+   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-unregistered-classes.md
    */
-  'readable-tailwind/no-unnecessary-whitespace'?: Linter.RuleEntry<ReadableTailwindNoUnnecessaryWhitespace>
+  'tailwind/no-unregistered-classes'?: Linter.RuleEntry<TailwindNoUnregisteredClasses>
   /**
    * Enforce a consistent order for tailwind classes.
-   * @see https://github.com/schoero/eslint-plugin-readable-tailwind/blob/main/docs/rules/sort-classes.md
+   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/sort-classes.md
    */
-  'readable-tailwind/sort-classes'?: Linter.RuleEntry<ReadableTailwindSortClasses>
+  'tailwind/sort-classes'?: Linter.RuleEntry<TailwindSortClasses>
 }
 
 /* ======= Declarations ======= */
-// ----- readable-tailwind/multiline -----
-type ReadableTailwindMultiline = []|[{
+// ----- tailwind/enforce-consistent-variable-syntax -----
+type TailwindEnforceConsistentVariableSyntax = []|[{
+  
+  callees?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+  
+  attributes?: (string | []|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]])[]
+  
+  variables?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+  
+  tags?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+  
+  syntax?: ("arbitrary" | "parentheses")
+}]
+// ----- tailwind/multiline -----
+type TailwindMultiline = []|[{
   
   callees?: ([]|[string]|[string, string] | []|[string]|[string, ({
     
@@ -119,8 +216,162 @@ type ReadableTailwindMultiline = []|[{
   
   printWidth?: number
 }]
-// ----- readable-tailwind/no-duplicate-classes -----
-type ReadableTailwindNoDuplicateClasses = []|[{
+// ----- tailwind/no-conflicting-classes -----
+type TailwindNoConflictingClasses = []|[{
+  
+  callees?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+  
+  attributes?: (string | []|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]])[]
+  
+  variables?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+  
+  tags?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+  
+  entryPoint?: string
+  
+  tailwindConfig?: string
+}]
+// ----- tailwind/no-duplicate-classes -----
+type TailwindNoDuplicateClasses = []|[{
+  
+  callees?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+  
+  attributes?: (string | []|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]])[]
+  
+  variables?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+  
+  tags?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+}]
+// ----- tailwind/no-restricted-classes -----
+type TailwindNoRestrictedClasses = []|[{
   
   callees?: ([]|[string]|[string, string] | []|[string]|[string, ({
     
@@ -193,9 +444,10 @@ type ReadableTailwindNoDuplicateClasses = []|[{
     pathPattern?: string
     [k: string]: unknown | undefined
   })[]] | string)[]
+  restrict?: string[]
 }]
-// ----- readable-tailwind/no-unnecessary-whitespace -----
-type ReadableTailwindNoUnnecessaryWhitespace = []|[{
+// ----- tailwind/no-unnecessary-whitespace -----
+type TailwindNoUnnecessaryWhitespace = []|[{
   
   allowMultiline?: boolean
   
@@ -271,8 +523,8 @@ type ReadableTailwindNoUnnecessaryWhitespace = []|[{
     [k: string]: unknown | undefined
   })[]] | string)[]
 }]
-// ----- readable-tailwind/sort-classes -----
-type ReadableTailwindSortClasses = []|[{
+// ----- tailwind/no-unregistered-classes -----
+type TailwindNoUnregisteredClasses = []|[{
   
   callees?: ([]|[string]|[string, string] | []|[string]|[string, ({
     
@@ -348,7 +600,88 @@ type ReadableTailwindSortClasses = []|[{
   
   entryPoint?: string
   
-  order?: ("asc" | "desc" | "official" | "improved")
+  tailwindConfig?: string
+  
+  ignore?: string[]
+}]
+// ----- tailwind/sort-classes -----
+type TailwindSortClasses = []|[{
+  
+  callees?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+  
+  attributes?: (string | []|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]])[]
+  
+  variables?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+  
+  tags?: ([]|[string]|[string, string] | []|[string]|[string, ({
+    
+    match?: "strings"
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectKeys"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  } | {
+    
+    match?: "objectValues"
+    
+    pathPattern?: string
+    [k: string]: unknown | undefined
+  })[]] | string)[]
+  
+  entryPoint?: string
   
   tailwindConfig?: string
+  
+  order?: ("asc" | "desc" | "official" | "improved")
 }]