@phaicom/eslint-config 0.1.4 → 0.2.1

package/README.md

@@ -1,27 +1,116 @@
 # `@phaicom/eslint-config`
 
-phaicom's ESLint configuration.
+Personal ESLint configuration preset.
 
-- 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).
+✨ Features:
+- Built on [antfu/eslint-config](https://github.com/antfu/eslint-config)
+- Enforces curly brackets for all blocks
+- Custom rule sets for unicorn, stylistic, and Vue
+- Tailwind support with [eslint-plugin-readable-tailwind](https://github.com/schoero/eslint-plugin-readable-tailwind)
 
-## Usage with tailwind
-Start by install **eslint-plugin-readable-tailwind**
+## Usage
 
+1. Install the package:
 ```bash
-pnpm install -D eslint-plugin-readable-tailwind@beta
+pnpm i -D @phaicom/eslint-config
 ```
 
-And set the **tailwind** flag to true.
+2. Create `eslint.config.mjs` in your project root:
+```js
+// eslint.config.mjs
+import configs from '@phaicom/eslint-config'
+
+export default configs()
+```
+
+3. Configure VS Code:
+  - Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+  - Add the following settings to `.vscode/settings.json`:
+
+```jsonc
+{
+  // Disable the default formatter, use eslint instead
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+
+  // Auto fix
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never"
+  },
+
+  // Silent the stylistic rules in you IDE, but still auto fix them
+  "eslint.rules.customizations": [
+    { "rule": "style/*", "severity": "off", "fixable": true },
+    { "rule": "format/*", "severity": "off", "fixable": true },
+    { "rule": "*-indent", "severity": "off", "fixable": true },
+    { "rule": "*-spacing", "severity": "off", "fixable": true },
+    { "rule": "*-spaces", "severity": "off", "fixable": true },
+    { "rule": "*-order", "severity": "off", "fixable": true },
+    { "rule": "*-dangle", "severity": "off", "fixable": true },
+    { "rule": "*-newline", "severity": "off", "fixable": true },
+    { "rule": "*quotes", "severity": "off", "fixable": true },
+    { "rule": "*semi", "severity": "off", "fixable": true }
+  ],
+
+  // Enable eslint for all supported languages
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "jsonc",
+    "yaml",
+    "toml",
+    "xml",
+    "gql",
+    "graphql",
+    "astro",
+    "svelte",
+    "css",
+    "less",
+    "scss",
+    "pcss",
+    "postcss"
+  ]
+}
+```
+
+## Disable base rules
+You can disable the base rules by setting `phaicom: false`:
 
 ```js
-import phaicom from '@phaicom/eslint-config'
+// eslint.config.mjs
+import configs from '@phaicom/eslint-config'
 
-export default phaicom({
+export default configs({
+  phaicom: false,
+})
+```
+
+## Tailwind Support
+To enable Tailwind support and enforce consistent class ordering:
+
+1. Install the required plugin:
+```bash
+pnpm i -D eslint-plugin-readable-tailwind@beta
+```
+
+2. Enable Tailwind support in your config:
+```js
+// eslint.config.mjs
+import configs from '@phaicom/eslint-config'
+
+export default configs({
   tailwind: true,
 })
 ```
-The rest of the config you can refer to https://github.com/antfu/eslint-config
+
+This will enforce consistent ordering of Tailwind classes for better readability.
+## Additional Configurations
+
+For other configuration options like TypeScript, Vue, React, Prettier, and more, please refer to [antfu/eslint-config](https://github.com/antfu/eslint-config).

package/dist/index.d.ts

@@ -4,7 +4,11 @@ type EslintConfigReturn = ReturnType<typeof antfu>;
 type UserConfigParams = Parameters<typeof antfu>[1];
 interface OptionsConfig extends OptionsConfig$1, TypedFlatConfigItem {
     /**
-     *
+     * Used phaicom's base rules:
+     * @default true
+     */
+    phaicom?: boolean;
+    /**
      * Used recommended rules:
      * @see https://github.com/schoero/eslint-plugin-readable-tailwind
      * @default false

package/dist/index.js

@@ -1,9 +1,8 @@
 // src/index.ts
 import antfu from "@antfu/eslint-config";
-import pluginReadableTailwind from "eslint-plugin-readable-tailwind";
 
-// src/base.ts
-var baseConfig = {
+// src/configs/base.ts
+var base = {
   name: "phaicom/base",
   rules: {
     "curly": ["error", "all"],
@@ -36,7 +35,7 @@ var baseConfig = {
     "node/prefer-global/process": "off"
   }
 };
-var vueConfig = {
+var vue = {
   name: "phaicom/vue",
   rules: {
     // vue rule customizations
@@ -48,41 +47,44 @@ var vueConfig = {
     "vue/singleline-html-element-content-newline": "off"
   }
 };
+var phaicom = { base, vue };
+var base_default = phaicom;
 
-// 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({
+// src/configs/tailwind.ts
+import { interopDefault } from "@antfu/eslint-config";
+async function tailwind() {
+  const [
+    pluginTailwind
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-readable-tailwind"))
+  ]);
+  return [
+    {
       name: "phaicom/tailwind",
-      files,
       plugins: {
-        "readable-tailwind": pluginReadableTailwind
+        "readable-tailwind": pluginTailwind
       },
       rules: {
         // enable all recommended rules to error
-        ...pluginReadableTailwind.configs.error.rules
+        ...pluginTailwind.configs.error.rules
       }
-    });
-  }
-  const userConfigs = [
-    baseConfig,
-    ...options.vue ? [vueConfig] : []
+    }
   ];
-  options.unicorn = true;
-  return antfu(options, ...userConfigs, ...configs);
+}
+
+// src/index.ts
+var eslintConfig = ({ phaicom: enablePhaicom = true, tailwind: enableTailwind = false, ...options }, ...configs) => {
+  if (enableTailwind) {
+    configs.push(tailwind());
+  }
+  if (enablePhaicom) {
+    options.unicorn = true;
+    configs.push(base_default.base);
+    if (options.vue) {
+      configs.push(base_default.vue);
+    }
+  }
+  return antfu(options, ...configs);
 };
 var index_default = eslintConfig;
 export {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@phaicom/eslint-config",
   "type": "module",
-  "version": "0.1.4",
+  "version": "0.2.1",
   "description": "Phaicom's config based on @antfu/eslint-config",
   "author": "Reawpai Chunsoi <reawpai.chunsoi@gmail.com> (https://github.com/phaicom)",
   "license": "MIT",