@acfatah/eslint-preset 1.0.2 → 1.1.0

package/README.md

@@ -5,13 +5,19 @@
     <img
       alt="Code Style"
       src="https://antfu.me/badge-code-style.svg"></a>
+  <a href="https://www.npmjs.com/package/@acfatah/eslint-preset">
+    <img
+      alt="NPM Version"
+      src="https://img.shields.io/npm/v/%40acfatah%2Feslint-preset"></a>
   <a href="https://github.com/antfu/eslint-config">
     <img
       alt="GitHub last commit (by committer)"
       src="https://img.shields.io/github/last-commit/acfatah/eslint-preset?display_timestamp=committer&style=flat-square"></a>
 </p>
 
-An opinionated ESLint configuration preset for TypeScript projects, based on [`antfu/eslint-config`][1].
+An opinionated ESLint configuration preset for TypeScript projects, based on
+[`antfu/eslint-config`][1]. I use this preset across my personal and professional
+projects to maintain a consistent code style and quality.
 
 Additional rules included are:
 
@@ -27,18 +33,32 @@ To install the config, run:
 bun add --dev @acfatah/eslint-preset
 ```
 
-Add `eslint.config.ts` file with the following content,
+Add `eslint.config.ts` file with the following content. `config` is just a wrapper
+to the `antfu` factory function. See [antfu Customization][antfu-factory-fuction]
+section for more details.
 
 ```typescript
+import { config } from '@acfatah/eslint-preset'
 import { markdown, preset, vue } from '@acfatah/eslint-preset/rules'
-import antfu from '@antfu/eslint-config'
 
-export default antfu(
+export default config(
   {
     formatters: true,
 
+    // Type of the project. 'lib' for libraries, the default is 'app'
+    type: 'lib',
+
     // Specifically for Vue projects
     vue: true,
+
+    // Files and directories to ignore. Adjust accordingly.
+    ignores: [
+      '**/coverage/**',
+      '**/dist/**',
+      '**/logs/**',
+      'bun.lock',
+      'tsconfig.*',
+    ],
   },
 
   {
@@ -50,17 +70,6 @@ export default antfu(
       ...vue,
     },
   },
-
-  {
-    name: 'app/files-to-ignore',
-    ignores: [
-      '**/coverage/**',
-      '**/dist/**',
-      '**/logs/**',
-      'bun.lock',
-      'tsconfig.*',
-    ],
-  },
 )
 ```
 
@@ -103,6 +112,8 @@ Install the [VS Code ESLint extension][2].
 
 Add the following vscode configuration to `.vscode/settings.json`,
 
+File: `src/files/.vscode/settings.json`
+
 ```jsonc
 {
   // Disable the default formatter, use eslint instead
@@ -188,114 +199,10 @@ Add the following custom Tailwind CSS v4 functions and directives lines to the `
 }
 ```
 
-Then, add the following configurations to `.vscode/tailwindcss.json`.
+Then, copy `src/files/.vscode/tailwind.json` file to `.vscode/tailwind.json`.
 
-```jsonc
-{
-  "version": 1.1,
-  "atDirectives": [
-    {
-      "name": "@apply",
-      "description": "Inline any existing utility classes into custom CSS.",
-      "references": [
-        {
-          "name": "Tailwind Documentation",
-          "url": "https://tailwindcss.com/docs/functions-and-directives#apply-directive"
-        }
-      ]
-    },
-    {
-      "name": "@config",
-      "description": "Load legacy JavaScript-based configuration file (compatibility with v3.x).",
-      "references": [
-        {
-          "name": "Tailwind Documentation",
-          "url": "https://tailwindcss.com/docs/functions-and-directives#config-directive"
-        }
-      ]
-    },
-    {
-      "name": "@custom-variant",
-      "description": "Add a custom variant in the project.",
-      "references": [
-        {
-          "name": "Tailwind Documentation",
-          "url": "https://tailwindcss.com/docs/functions-and-directives#custom-variant-directive"
-        }
-      ]
-    },
-    {
-      "name": "@import",
-      "description": "Use the @import directive to inline import CSS files, including Tailwind itself.",
-      "references": [
-        {
-          "name": "Tailwind Documentation",
-          "url": "https://tailwindcss.com/docs/functions-and-directives#import-directive"
-        }
-      ]
-    },
-    {
-      "name": "@plugin",
-      "description": "Load legacy JavaScript-based plugin (compatibility with v3.x).",
-      "references": [
-        {
-          "name": "Tailwind Documentation",
-          "url": "https://tailwindcss.com/docs/upgrading-to-v4#plugins"
-        }
-      ]
-    },
-    {
-      "name": "@reference",
-      "description": "Import main stylesheet for reference without including styles, for use with frameworks like React, Svelte, etc.",
-      "references": [
-        {
-          "name": "Tailwind Documentation",
-          "url": "https://tailwindcss.com/docs/functions-and-directives#reference-directive"
-        }
-      ]
-    },
-    {
-      "name": "@source",
-      "description": "Specify source files not picked up by automatic content detection.",
-      "references": [
-        {
-          "name": "Tailwind Documentation",
-          "url": "https://tailwindcss.com/docs/functions-and-directives#source-directive"
-        }
-      ]
-    },
-    {
-      "name": "@theme",
-      "description": "Define custom design tokens like fonts, colors, breakpoints.",
-      "references": [
-        {
-          "name": "Tailwind Documentation",
-          "url": "https://tailwindcss.com/docs/functions-and-directives#theme-directive"
-        }
-      ]
-    },
-    {
-      "name": "@utility",
-      "description": "Add custom utilities that work with variants like hover, focus, lg.",
-      "references": [
-        {
-          "name": "Tailwind Documentation",
-          "url": "https://tailwindcss.com/docs/functions-and-directives#utility-directive"
-        }
-      ]
-    },
-    {
-      "name": "@variant",
-      "description": "Apply a Tailwind variant to styles in CSS.",
-      "references": [
-        {
-          "name": "Tailwind Documentation",
-          "url": "https://tailwindcss.com/docs/functions-and-directives#variant-directive"
-        }
-      ]
-    }
-  ]
-}
+```bash
+curl -s https://raw.githubusercontent.com/acfatah/eslint-preset/refs/heads/main/src/files/.vscode/tailwind.json -o .vscode/tailwind.json
 ```
 
 ## Acknowledgments
@@ -305,3 +212,4 @@ Then, add the following configurations to `.vscode/tailwindcss.json`.
 [1]: https://github.com/antfu/eslint-config
 [2]: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
 [3]: https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss
+[antfu-factory-fuction]: https://github.com/antfu/eslint-config?tab=readme-ov-file#customization

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 // Generated by dts-bundle-generator v9.5.1
 
+import { default as config } from '@antfu/eslint-config';
+
 /**
  * Eslint preset for Markdown files.
  *
@@ -73,4 +75,8 @@ export declare const vue: {
 	})[];
 };
 
+export {
+	config,
+};
+
 export {};

package/dist/index.mjs

@@ -15,7 +15,11 @@ var preset = {
   }],
   "style/padding-line-between-statements": [
     "error",
-    { blankLine: "always", prev: "*", next: "return" }
+    {
+      blankLine: "always",
+      prev: "*",
+      next: "return"
+    }
   ]
 };
 // src/rules/tailwind.ts
@@ -35,9 +39,12 @@ var vue = {
     allowAllPropertiesOnSameLine: true
   }]
 };
+// src/index.ts
+import { default as default2 } from "@antfu/eslint-config";
 export {
   vue,
   tailwind,
   preset,
-  markdown
+  markdown,
+  default2 as config
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@acfatah/eslint-preset",
   "type": "module",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Eslint config preset.",
   "author": "Achmad F. Ibrahim <acfatah@gmail.com>",
   "license": "MIT",
@@ -37,7 +37,7 @@
     "format": "bunx --bun eslint --fix",
     "typecheck": "tsc --noEmit",
     "release": "bunx --bun bumpp --execute=\"bun install\"",
-    "publish": "bun run build && npm publish --access public"
+    "publish": "npm publish --access public"
   },
   "dependencies": {
     "@antfu/eslint-config": "^6.7.1",