@octohash/eslint-config 0.1.0 → 0.1.2

package/README.md

@@ -4,6 +4,88 @@
 [![JSDocs][jsdocs-src]][jsdocs-href]
 [![License][license-src]][license-href]
 
+A comprehensive ESLint configuration package optimized for **application development**, built on top of [@antfu/eslint-config](https://github.com/antfu/eslint-config). This configuration provides a robust foundation for modern web applications with built-in support for Vue, TypeScript, and **Tailwind CSS v4**.
+
+Since the target is web application development, CSS and HTML formatting are enabled by default.
+
+## Installation
+
+```bash
+pnpm add -D @octohash/eslint-config
+```
+
+## Usage
+
+### Basic Setup
+
+Create an `eslint.config.js` file in your project root:
+
+```javascript
+import { defineConfig } from '@octohash/eslint-config'
+
+export default defineConfig()
+```
+
+### With Custom Options
+
+```javascript
+import { defineConfig } from '@octohash/eslint-config'
+
+export default defineConfig(
+  {
+    vue: true,
+    formatters: {
+      css: true,
+      html: true,
+    },
+  },
+  {
+    files: ['**/*.test.ts'],
+    rules: {
+      'no-unused-vars': 'off',
+    },
+  }
+)
+```
+
+### Tailwind CSS v4 Setup
+
+1. Install Tailwind CSS v4:
+```bash
+pnpm add tailwindcss@4
+```
+
+2. Create your CSS file with v4 syntax:
+```css
+@import 'tailwindcss';
+
+/* Your custom styles */
+```
+
+3. The ESLint configuration will automatically detect and validate your Tailwind CSS usage.
+
+## Migration from @antfu/eslint-config
+
+If you're currently using `@antfu/eslint-config` directly, you can easily migrate:
+
+**Before:**
+```javascript
+import antfu from '@antfu/eslint-config'
+
+export default antfu()
+```
+
+**After:**
+```javascript
+import { defineConfig } from '@octohash/eslint-config'
+
+export default defineConfig()
+```
+
+## License
+
+[MIT](./LICENSE) License © [jinghaihan](https://github.com/jinghaihan)
+
 <!-- Badges -->
 
 [npm-version-src]: https://img.shields.io/npm/v/@octohash/eslint-config?style=flat&colorA=080f12&colorB=1fa669

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _antfu_eslint_config0 from "@antfu/eslint-config";
 import { Awaitable, OptionsConfig, TypedFlatConfigItem } from "@antfu/eslint-config";
-import * as eslint_flat_config_utils2 from "eslint-flat-config-utils";
+import * as eslint_flat_config_utils0 from "eslint-flat-config-utils";
 import { FlatConfigComposer } from "eslint-flat-config-utils";
 import { Linter } from "eslint";
 
@@ -10,6 +10,6 @@ type AntfuOptions = OptionsConfig & Omit<TypedFlatConfigItem, 'files'>;
 type UserConfig = Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<any, any> | Linter.Config[]>[];
 //#endregion
 //#region src/index.d.ts
-declare function defineConfig(options?: Options, ...userConfigs: UserConfig): eslint_flat_config_utils2.FlatConfigComposer<_antfu_eslint_config0.TypedFlatConfigItem, _antfu_eslint_config0.ConfigNames>;
+declare function defineConfig(options?: Options, ...userConfigs: UserConfig): eslint_flat_config_utils0.FlatConfigComposer<_antfu_eslint_config0.TypedFlatConfigItem, _antfu_eslint_config0.ConfigNames>;
 //#endregion
 export { defineConfig };

package/dist/index.js

@@ -8,11 +8,12 @@ import { join } from "pathe";
 //#region src/tailwindcss.ts
 function tailwindCSS(dir) {
 	const installed = isPackageExists("tailwindcss");
-	if (!installed) return;
-	dir = dir ?? process.cwd();
+	if (!installed) return [];
+	const config = findTailwindImportCSS(dir ?? process.cwd());
+	if (!config) return [];
 	return {
 		...tailwindPlugin.configs["flat/recommended"],
-		settings: { tailwindcss: { config: findTailwindImportCSS(dir) } }
+		settings: { tailwindcss: { config } }
 	};
 }
 function findTailwindImportCSS(dir) {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@octohash/eslint-config",
   "type": "module",
-  "version": "0.1.0",
-  "description": "ESLint configuration based on @antfu/eslint-config, optimized for application development. Includes built-in support for Vue, TypeScript, and Tailwind CSS",
+  "version": "0.1.2",
+  "description": "ESLint configuration based on @antfu/eslint-config, includes built-in support for Tailwind CSS v4.",
   "author": "jinghaihan",
   "license": "MIT",
   "homepage": "https://github.com/jinghaihan/eslint-config#readme",
@@ -32,27 +32,28 @@
     "dist"
   ],
   "dependencies": {
-    "@antfu/eslint-config": "^4.16.2",
+    "@antfu/eslint-config": "^5.0.0",
     "eslint-plugin-format": "^1.0.1",
-    "eslint-plugin-tailwindcss": "npm:@hyoban/eslint-plugin-tailwindcss@4.0.0-alpha.13",
+    "eslint-plugin-tailwindcss": "^4.0.0-beta.0",
     "local-pkg": "^1.1.1",
     "pathe": "^2.0.3"
   },
   "devDependencies": {
     "@octohash/tsconfig": "^0.1.0",
-    "@types/node": "^24.0.12",
-    "bumpp": "^10.2.0",
-    "czg": "^1.11.2",
-    "eslint": "^9.30.1",
-    "eslint-flat-config-utils": "^2.1.0",
+    "@types/eslint-plugin-tailwindcss": "^3.17.0",
+    "@types/node": "^24.1.0",
+    "bumpp": "^10.2.1",
+    "czg": "^1.12.0",
+    "eslint": "^9.32.0",
+    "eslint-flat-config-utils": "^2.1.1",
     "lint-staged": "^16.1.2",
-    "pncat": "^0.2.6",
+    "pncat": "^0.4.0",
     "simple-git-hooks": "^2.13.0",
     "taze": "^19.1.0",
-    "tsdown": "^0.12.9",
+    "tsdown": "^0.13.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
-    "@octohash/eslint-config": "0.1.0"
+    "@octohash/eslint-config": "0.1.2"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged"