@octohash/eslint-config 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jing Haihan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,18 @@
+# @octohash/eslint-config
+
+[![npm version][npm-version-src]][npm-version-href]
+[![JSDocs][jsdocs-src]][jsdocs-href]
+[![License][license-src]][license-href]
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@octohash/eslint-config?style=flat&colorA=080f12&colorB=1fa669
+[npm-version-href]: https://npmjs.com/package/@octohash/eslint-config
+[npm-downloads-src]: https://img.shields.io/npm/dm/@octohash/eslint-config?style=flat&colorA=080f12&colorB=1fa669
+[npm-downloads-href]: https://npmjs.com/package/@octohash/eslint-config
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/@octohash/eslint-config?style=flat&colorA=080f12&colorB=1fa669&label=minzip
+[bundle-href]: https://bundlephobia.com/result?p=@octohash/eslint-config
+[license-src]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat&colorA=080f12&colorB=1fa669
+[license-href]: https://github.com/jinghaihan/@octohash/eslint-config/LICENSE
+[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
+[jsdocs-href]: https://www.jsdocs.io/package/@octohash/eslint-config

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+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 { FlatConfigComposer } from "eslint-flat-config-utils";
+import { Linter } from "eslint";
+
+//#region src/types.d.ts
+type Options = AntfuOptions & {};
+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>;
+//#endregion
+export { defineConfig };

package/dist/index.js

@@ -0,0 +1,51 @@
+import antfu from "@antfu/eslint-config";
+import { readFileSync, readdirSync } from "node:fs";
+import process from "node:process";
+import tailwindPlugin from "eslint-plugin-tailwindcss";
+import { isPackageExists } from "local-pkg";
+import { join } from "pathe";
+
+//#region src/tailwindcss.ts
+function tailwindCSS(dir) {
+	const installed = isPackageExists("tailwindcss");
+	if (!installed) return;
+	dir = dir ?? process.cwd();
+	return {
+		...tailwindPlugin.configs["flat/recommended"],
+		settings: { tailwindcss: { config: findTailwindImportCSS(dir) } }
+	};
+}
+function findTailwindImportCSS(dir) {
+	const entries = readdirSync(dir, { withFileTypes: true });
+	for (const entry of entries) {
+		const fullPath = join(dir, entry.name);
+		if (entry.isDirectory()) {
+			const found = findTailwindImportCSS(fullPath);
+			if (found) return found;
+		} else if (entry.isFile() && entry.name.endsWith(".css")) {
+			const lines = readFileSync(fullPath, "utf8").split(/\r?\n/);
+			for (const line of lines) if (line.trim().startsWith("@import \"tailwindcss")) return fullPath;
+		}
+	}
+	return null;
+}
+
+//#endregion
+//#region src/index.ts
+function defineConfig(options, ...userConfigs) {
+	return antfu(mergeOptions(options), tailwindCSS(), ...userConfigs);
+}
+function mergeOptions(options) {
+	return {
+		...options,
+		stylistic: true,
+		formatters: {
+			css: true,
+			html: true,
+			...typeof options?.formatters === "object" ? options.formatters : {}
+		}
+	};
+}
+
+//#endregion
+export { defineConfig };

package/package.json

@@ -0,0 +1,75 @@
+{
+  "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",
+  "author": "jinghaihan",
+  "license": "MIT",
+  "homepage": "https://github.com/jinghaihan/eslint-config#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jinghaihan/eslint-config.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jinghaihan/eslint-config/issues"
+  },
+  "keywords": [
+    "eslint",
+    "eslint-config",
+    "linter"
+  ],
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@antfu/eslint-config": "^4.16.2",
+    "eslint-plugin-format": "^1.0.1",
+    "eslint-plugin-tailwindcss": "npm:@hyoban/eslint-plugin-tailwindcss@4.0.0-alpha.13",
+    "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",
+    "lint-staged": "^16.1.2",
+    "pncat": "^0.2.6",
+    "simple-git-hooks": "^2.13.0",
+    "taze": "^19.1.0",
+    "tsdown": "^0.12.9",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4",
+    "@octohash/eslint-config": "0.1.0"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  },
+  "scripts": {
+    "build": "tsdown --clean --dts",
+    "typecheck": "tsc",
+    "test": "vitest",
+    "lint": "eslint",
+    "commit": "czg",
+    "deps": "taze major -I",
+    "release": "bumpp && pnpm publish --no-git-checks",
+    "catalog": "pncat",
+    "bootstrap": "pnpm install",
+    "preinstall": "npx only-allow pnpm"
+  }
+}