@phaicom/eslint-config 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-PRESENT Reawpai Chunsoi
+
+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,21 @@
+# `@phaicom/eslint-config`
+
+phaicom's ESLint configuration.
+
+- Based on [antfu/eslint-config](https://github.com/antfu/eslint-config).
+- Enable all unicorn config.
+- Forced to always use curly.
+- Modified rules including unicorn, stylistic, Vue, etc.
+- Integrated with [eslint-plugin-readable-tailwind](https://github.com/schoero/eslint-plugin-readable-tailwind).
+
+## Usage
+To enable Tailwind just set the **tailwind** flag to true.
+
+```js
+import phaicom from '@phaicom/eslint-config'
+
+export default phaicom({
+  tailwind: true,
+})
+```
+The rest of the config you can refer to https://github.com/antfu/eslint-config

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import antfu, { OptionsConfig as OptionsConfig$1, TypedFlatConfigItem } from '@antfu/eslint-config';
+
+type EslintConfigReturn = ReturnType<typeof antfu>;
+type UserConfigParams = Parameters<typeof antfu>[1];
+interface OptionsConfig extends OptionsConfig$1, TypedFlatConfigItem {
+    /**
+     *
+     * Used recommended rules:
+     * @see https://github.com/schoero/eslint-plugin-readable-tailwind
+     * @default false
+     */
+    tailwind?: boolean;
+}
+type EslintConfig = (options: OptionsConfig, ...configs: UserConfigParams[]) => EslintConfigReturn;
+
+declare const eslintConfig: EslintConfig;
+
+export { eslintConfig as default };

package/dist/index.js

@@ -0,0 +1,90 @@
+// src/index.ts
+import antfu from "@antfu/eslint-config";
+import pluginReadableTailwind from "eslint-plugin-readable-tailwind";
+
+// src/base.ts
+var baseConfig = {
+  name: "phaicom/base",
+  rules: {
+    "curly": ["error", "all"],
+    // style rule customizations
+    "style/arrow-parens": ["error", "always"],
+    "style/brace-style": ["error", "1tbs", { allowSingleLine: true }],
+    "style/quote-props": "off",
+    "style/function-call-spacing": ["error", "never"],
+    //  unicorn rule customizations
+    "unicorn/prevent-abbreviations": "off",
+    "unicorn/consistent-function-scoping": "off",
+    // ignore composable/hook based filenames, LICENSE, and README
+    "unicorn/filename-case": [
+      "error",
+      {
+        case: "kebabCase",
+        ignore: [
+          // This regex matches files that start with 'use' followed by an uppercase letter
+          // and then any sequence of characters, ending with '.ts'. Useful for React hooks.
+          String.raw`^use[A-Z].*\.ts$`,
+          "LICENSE",
+          "README",
+          "CHANGELOG"
+        ]
+      }
+    ],
+    // jsonc rule customizations
+    "jsonc/sort-keys": "off",
+    // node customizations
+    "node/prefer-global/process": "off"
+  }
+};
+var vueConfig = {
+  name: "phaicom/vue",
+  rules: {
+    // vue rule customizations
+    "vue/max-attributes-per-line": ["error", {
+      singleline: { max: 10 },
+      multiline: { max: 1 }
+    }],
+    "vue/multi-word-component-names": "warn",
+    "vue/singleline-html-element-content-newline": "off"
+  }
+};
+
+// src/index.ts
+var eslintConfig = ({ tailwind = false, ...options }, ...configs) => {
+  if (tailwind) {
+    const baseFiles = ["**/*.js"];
+    const frameworkExtensions = {
+      typescript: ["ts"],
+      react: ["jsx", options.typescript && "tsx"],
+      solid: ["jsx", options.typescript && "tsx"],
+      vue: ["vue"],
+      astro: ["astro"],
+      svelte: ["svelte"]
+    };
+    const files = [
+      ...baseFiles,
+      ...Object.entries(frameworkExtensions).filter(([framework]) => options[framework]).flatMap(([, exts]) => exts.filter(Boolean).map((ext) => `**/*.${ext}`))
+    ];
+    configs.unshift({
+      name: "phaicom/tailwind",
+      files,
+      plugins: {
+        "readable-tailwind": pluginReadableTailwind
+      },
+      rules: {
+        // enable all recommended rules to error
+        ...pluginReadableTailwind.configs.error.rules
+      }
+    });
+  }
+  const userConfigs = [
+    baseConfig,
+    ...options.vue ? [vueConfig] : []
+  ];
+  options.unicorn = true;
+  return antfu(options, ...userConfigs, ...configs);
+};
+var index_default = eslintConfig;
+export {
+  index_default as default
+};

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@phaicom/eslint-config",
+  "type": "module",
+  "version": "0.1.3",
+  "description": "Phaicom's config based on @antfu/eslint-config",
+  "author": "Reawpai Chunsoi <reawpai.chunsoi@gmail.com> (https://github.com/phaicom)",
+  "license": "MIT",
+  "homepage": "https://github.com/phaicom/eslint-config",
+  "keywords": [
+    "eslint-config"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "eslint-plugin-readable-tailwind": ">=2.0.0-beta.0"
+  },
+  "peerDependenciesMeta": {
+    "eslint-plugin-readable-tailwind": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@antfu/eslint-config": "^4.1.0",
+    "eslint": "^9.19.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.6.1",
+    "@commitlint/config-conventional": "^19.6.0",
+    "bumpp": "^10.0.1",
+    "eslint-plugin-format": "^1.0.1",
+    "lint-staged": "^15.4.3",
+    "simple-git-hooks": "^2.11.1",
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3",
+    "eslint-plugin-readable-tailwind": "2.0.0-beta.0"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "simple-git-hooks": {
+    "pre-commit": "npx lint-staged",
+    "commit-msg": "npx commitlint --edit ${1}"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  },
+  "scripts": {
+    "build": "tsup --clean --dts",
+    "stub": "tsup",
+    "dev": "npx @eslint/config-inspector --config eslint.config.ts",
+    "build:inspector": "pnpm run build && npx @eslint/config-inspector build",
+    "watch": "tsup --watch",
+    "release": "bumpp && pnpm publish --access=public",
+    "lint": "eslint . --cache",
+    "lint:fix": "eslint . --fix --cache",
+    "typecheck": "tsc --noEmit"
+  }
+}