@oliver139/eslint-config 7.0.2 → 7.1.0

package/README.md

@@ -1,10 +1,12 @@
 # Oliver's ESLint Config
 
+[![npm](https://img.shields.io/npm/v/@oliver139/eslint-config?color=010101&style=for-the-badge)](https://npmjs.com/package/@oliver139/eslint-config)
+
 My options of [@antfu/eslint-config](https://github.com/antfu/eslint-config).
 
 The 3rd version of my eslint config preset, which uses overrides to customize instead, so to simplify each time updating it.
 
-[![npm](https://img.shields.io/npm/v/@oliver139/eslint-config?color=010101&style=for-the-badge)](https://npmjs.com/package/@oliver139/eslint-config)
+Tailwind linting is supported using [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss)
 
 ## Install
 
@@ -18,5 +20,18 @@ npm install -D eslint @oliver139/eslint-config@7 @antfu/eslint-config
 import antfu from '@antfu/eslint-config'
 import { options } from '@oliver139/eslint-config'
 
-export default antfu(...options())
+export default antfu(...options({
+  tailwind: {
+    // tailwindcss 4: the path to the entry file of the css based tailwind config (eg: `src/global.css`)
+    entryPoint: 'src/global.css',
+    // tailwindcss 3: the path to the tailwind config file (eg: `tailwind.config.js`)
+    tailwindConfig: 'tailwind.config.js',
+    // File to be watched, below is the default value
+    files: ['**/*.vue', '**/*.html'],
+    // To overrides rules:
+    overrides: {
+      'better-tailwindcss/enforce-logical-properties': 'error',
+    }
+  },
+}))
 ```

package/dist/index.d.mts

@@ -1,8 +1,28 @@
 import antfu from "@antfu/eslint-config";
+import { Linter } from "eslint";
 
+//#region src/options/tailwind.d.ts
+type TailwindRules = 'enforce-consistent-line-wrapping' | 'enforce-consistent-class-order' | 'enforce-consistent-variant-order' | 'enforce-consistent-variable-syntax' | 'enforce-consistent-important-position' | 'enforce-shorthand-classes' | 'enforce-logical-properties' | 'enforce-canonical-classes' | 'no-duplicate-classes' | 'no-deprecated-classes' | 'no-unnecessary-whitespace' | 'no-unknown-classes' | 'no-conflicting-classes' | 'no-restricted-classes';
+interface BaseOptions {
+  files?: Linter.Config['files'];
+  overrides?: Partial<Record<TailwindRules, Linter.RuleEntry>>;
+}
+interface TailwindOptionsV3 extends BaseOptions {
+  tailwindConfig: string;
+  entryPoint?: never;
+}
+interface TailwindOptionsV4 extends BaseOptions {
+  entryPoint: string;
+  tailwindConfig?: never;
+}
+type TailwindOptions = TailwindOptionsV3 | TailwindOptionsV4;
+//#endregion
 //#region src/options/index.d.ts
-type Options = NonNullable<Parameters<typeof antfu>[0]>;
+type AntfuFirstPara = Parameters<typeof antfu>[0];
+type Options = NonNullable<AntfuFirstPara> & {
+  tailwind?: false | TailwindOptions;
+};
 type UserConfig = Parameters<typeof antfu>[1];
 declare function options(options?: Options, ...userConfigs: UserConfig[]): [Options, ...UserConfig[]];
 //#endregion
-export { Options, UserConfig, options };
+export { AntfuFirstPara, Options, UserConfig, options };

package/dist/index.mjs

@@ -1 +1 @@
-function e(e,t=`warn`){let{overrides:n}=typeof e==`object`?e:{};return{overrides:{"antfu/no-top-level-await":`warn`,"max-nested-callbacks":[`warn`,{max:4}],"no-alert":`off`,"no-console":`off`,"no-useless-return":`warn`,"no-unused-vars":t,"unused-imports/no-unused-imports":`warn`,"unused-imports/no-unused-vars":[`warn`,{args:`after-used`,argsIgnorePattern:`^_`,ignoreRestSiblings:!0,vars:`all`,varsIgnorePattern:`^props$|^_`}],...n}}}function t(e){let{overrides:t}=typeof e==`object`?e:{};return{overrides:{"perfectionist/sort-imports":[`error`,{groups:[`type-import`,[`type-parent`,`type-sibling`,`type-index`,`type-internal`],`value-builtin`,`value-external`,`value-internal`,[`value-parent`,`value-sibling`,`value-index`],`side-effect`,`ts-equals-import`,`unknown`],newlinesBetween:`ignore`,newlinesInside:`ignore`,order:`asc`,partitionByComment:!0,partitionByNewLine:!0,type:`natural`}],...t}}}function n(e){if(e===!1)return!1;let t=typeof e==`object`?e:{};return{...t,overrides:{"antfu/curly":`off`,"antfu/if-newline":`off`,curly:[`error`,`multi-line`,`consistent`],"style/brace-style":[`error`,`1tbs`,{allowSingleLine:!1}],"style/member-delimiter-style":[`error`,{multiline:{delimiter:`none`,requireLast:!1},multilineDetection:`brackets`,overrides:{interface:{multiline:{delimiter:`none`,requireLast:!1}}},singleline:{delimiter:`comma`}}],"style/quote-props":[`error`,`as-needed`],...t.overrides}}}function r(e){let{overrides:t}=typeof e==`object`?e:{};return{overrides:{"ts/no-empty-function":`warn`,...t}}}function i(e){if(e===!1)return!1;let{overrides:t,...n}=typeof e==`object`?e:{};return{...n,overrides:{"vue/component-api-style":[`error`,[`script-setup`,`composition`]],"vue/block-order":[`error`,{order:[`template`,`script`,`style`]}],"vue/brace-style":[`error`,`1tbs`,{allowSingleLine:!1}],"vue/html-button-has-type":`error`,"vue/max-attributes-per-line":[`warn`,{multiline:1,singleline:4}],"vue/no-console":`error`,"vue/no-unused-refs":`warn`,"vue/no-unused-vars":`warn`,"vue/quote-props":[`error`,`as-needed`],"vue/singleline-html-element-content-newline":`off`,...t}}}function a(a={},...o){let{javascript:s,typescript:c,pnpm:l,vue:u,stylistic:d,perfectionist:f,...p}=a;return[{javascript:e(s),typescript:r(c),vue:i(u),stylistic:n(d),perfectionist:t(f),...p},...o]}export{a as options};
+import e from"eslint-plugin-better-tailwindcss";function t(e,t=`warn`){let{overrides:n}=typeof e==`object`?e:{};return{overrides:{"antfu/no-top-level-await":`warn`,"max-nested-callbacks":[`warn`,{max:4}],"no-alert":`off`,"no-console":`off`,"no-useless-return":`warn`,"no-unused-vars":t,"unused-imports/no-unused-imports":`warn`,"unused-imports/no-unused-vars":[`warn`,{args:`after-used`,argsIgnorePattern:`^_`,ignoreRestSiblings:!0,vars:`all`,varsIgnorePattern:`^props$|^_`}],...n}}}function n(e){let{overrides:t}=typeof e==`object`?e:{};return{overrides:{"perfectionist/sort-imports":[`error`,{groups:[`type-import`,[`type-parent`,`type-sibling`,`type-index`,`type-internal`],`value-builtin`,`value-external`,`value-internal`,[`value-parent`,`value-sibling`,`value-index`],`side-effect`,`ts-equals-import`,`unknown`],newlinesBetween:`ignore`,newlinesInside:`ignore`,order:`asc`,partitionByComment:!0,partitionByNewLine:!0,type:`natural`}],...t}}}function r(e){if(e===!1)return!1;let t=typeof e==`object`?e:{};return{...t,overrides:{"antfu/curly":`off`,"antfu/if-newline":`off`,curly:[`error`,`multi-line`,`consistent`],"style/brace-style":[`error`,`1tbs`,{allowSingleLine:!1}],"style/member-delimiter-style":[`error`,{multiline:{delimiter:`none`,requireLast:!1},multilineDetection:`brackets`,overrides:{interface:{multiline:{delimiter:`none`,requireLast:!1}}},singleline:{delimiter:`comma`}}],"style/quote-props":[`error`,`as-needed`],...t.overrides}}}function i(e){return e.tailwindConfig!==void 0}function a(e){return e.entryPoint!==void 0}function o(t){let n=typeof t==`object`?t:{};return[{name:`oli/tailwindcss/setup`,plugins:e.configs.recommended.plugins,settings:{"better-tailwindcss":{...i(n)?{tailwindConfig:n.tailwindConfig}:{},...a(n)?{entryPoint:n.entryPoint}:{}}}},{name:`oli/tailwindcss/rules`,files:n.files??[`**/*.vue`,`**/*.html`],rules:{"better-tailwindcss/enforce-consistent-line-wrapping":`warn`,"better-tailwindcss/enforce-consistent-class-order":`warn`,"better-tailwindcss/enforce-consistent-variant-order":`warn`,"better-tailwindcss/enforce-consistent-variable-syntax":`warn`,"better-tailwindcss/enforce-consistent-important-position":`warn`,"better-tailwindcss/enforce-shorthand-classes":`warn`,"better-tailwindcss/enforce-canonical-classes":`warn`,"better-tailwindcss/no-duplicate-classes":`warn`,"better-tailwindcss/no-deprecated-classes":`warn`,"better-tailwindcss/no-unnecessary-whitespace":`warn`,"better-tailwindcss/no-conflicting-classes":`error`,...n.overrides}}]}function s(e){let{overrides:t}=typeof e==`object`?e:{};return{overrides:{"ts/no-empty-function":`warn`,...t}}}function c(e){if(e===!1)return!1;let{overrides:t,...n}=typeof e==`object`?e:{};return{...n,overrides:{"vue/component-api-style":[`error`,[`script-setup`,`composition`]],"vue/block-order":[`error`,{order:[`template`,`script`,`style`]}],"vue/brace-style":[`error`,`1tbs`,{allowSingleLine:!1}],"vue/html-button-has-type":`error`,"vue/max-attributes-per-line":[`warn`,{multiline:1,singleline:4}],"vue/no-console":`error`,"vue/no-unused-refs":`warn`,"vue/no-unused-vars":`warn`,"vue/quote-props":[`error`,`as-needed`],"vue/singleline-html-element-content-newline":`off`,...t}}}function l(e={},...i){let{javascript:a,typescript:l,pnpm:u,vue:d,stylistic:f,perfectionist:p,...m}=e,h=e.tailwind?o(e.tailwind):[];return console.log(`🚀 ~ index.ts:26 ~ options ~ tailwind:`,e.tailwind),[{javascript:t(a),typescript:s(l),vue:c(d),stylistic:r(f),perfectionist:n(p),...m},...h,...i]}export{l as options};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oliver139/eslint-config",
   "type": "module",
-  "version": "7.0.2",
+  "version": "7.1.0",
   "description": " Oliver's ESLint config preset powered by @antfu/eslint-config",
   "author": "Oliver Mak <oliver139.working@gmail.com> (https://github.com/oliver139)",
   "license": "MIT",
@@ -29,7 +29,8 @@
   },
   "dependencies": {
     "@antfu/eslint-config": "^8.3.0",
-    "eslint": "^10.3.0"
+    "eslint": "^10.3.0",
+    "eslint-plugin-better-tailwindcss": "^4.5.0"
   },
   "devDependencies": {
     "@antfu/ni": "latest",