@acfatah/eslint-preset 1.3.1 → 1.3.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Achmad F. Ibrahim
+
+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

@@ -5,11 +5,13 @@
     <img
       alt="Code Style"
       src="https://antfu.me/badge-code-style.svg"></a>
+  <a href="./LICENSE">
+    <img alt="GitHub" src="https://img.shields.io/github/license/acfatah/eslint-preset?style=flat-square"></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">
+  <a href="https://github.com/acfatah/eslint-preset/commits/main">
     <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>
@@ -27,19 +29,24 @@ Additional rules included are:
 
 ## Installation
 
-To install the config, run:
+To install ESLint and this preset with Bun, run:
 
 ```bash
-bun add --dev @acfatah/eslint-preset
+bun add --dev eslint @acfatah/eslint-preset
 ```
 
+This preset declares `eslint`, `@antfu/eslint-config`, `@eslint/markdown`,
+`eslint-plugin-better-tailwindcss`, `eslint-plugin-format`, and
+`eslint-plugin-vue` as peer dependencies. Modern package managers, including
+Bun, will install these peers automatically when you add the preset, so you do
+not need to list each plugin manually in your `package.json`.
+
 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 { config, markdown, preset, vue } from '@acfatah/eslint-preset'
 
 export default config(
   {
@@ -56,8 +63,8 @@ export default config(
       '**/coverage/**',
       '**/dist/**',
       '**/logs/**',
+      '**/tsconfig.*',
       'bun.lock',
-      'tsconfig.*',
     ],
   },
 
@@ -70,6 +77,9 @@ export default config(
     rules: {
       ...preset,
 
+      // Optional markdown rules
+      ...markdown,
+
       // Specifically for Vue projects
       ...vue,
     },
@@ -82,10 +92,9 @@ export default config(
 Add the following configurations respectively.
 
 ```typescript
-import { betterTailwindcssPlugin, tailwind } from '@acfatah/eslint-preset'
-import antfu from '@antfu/eslint-config'
+import { betterTailwindcssPlugin, config, tailwind } from '@acfatah/eslint-preset'
 
-export default antfu(
+export default config(
   {
     // other configs...
   },
@@ -116,6 +125,24 @@ export default antfu(
 )
 ```
 
+## Inspect Example Configs
+
+You can inspect the fully resolved configs shipped in this repo. These commands
+run from the project root and run the [ESLint config inspector][4] against the
+templates used.
+
+### Default TypeScript preset
+
+```bash
+bun inspect:default
+```
+
+### Vue + Tailwind preset
+
+```bash
+bun inspect:vue-tailwind
+```
+
 ## VS Code Support
 
 Install the [VS Code ESLint extension][2].
@@ -222,4 +249,5 @@ curl -s https://raw.githubusercontent.com/acfatah/eslint-preset/refs/heads/main/
 [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
+[4]: https://github.com/eslint/config-inspector
 [antfu-factory-fuction]: https://github.com/antfu/eslint-config?tab=readme-ov-file#customization

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@acfatah/eslint-preset",
   "type": "module",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "description": "Eslint config preset.",
   "author": "Achmad F. Ibrahim <acfatah@gmail.com>",
   "license": "MIT",
@@ -30,28 +30,36 @@
     "node": "^20.19.0 || >=22.12.0"
   },
   "scripts": {
-    "build": "bun --version > .bun-version && bun install && bun run script/build.ts",
+    "build": "bun --version > .bun-version && bun install && bun run scripts/build.ts",
     "lint": "bunx --bun eslint",
     "lint:staged": "bunx --bun eslint --pass-on-no-patterns --no-warn-ignored $(git diff --relative --cached --name-only --diff-filter=d)",
     "lint:commit-message": "bunx --bun commitlint --edit",
+    "inspect:default": "cd templates/default && bunx --bun eslint --inspect-config",
+    "inspect:vue-tailwind": "cd templates/vue-tailwind && bunx --bun eslint --inspect-config",
     "format": "bunx --bun eslint --fix",
     "typecheck": "tsc --noEmit",
     "release": "bun run build && bunx --bun bumpp"
   },
-  "dependencies": {
+  "peerDependencies": {
     "@antfu/eslint-config": "^6.7.1",
     "@eslint/markdown": "^7.5.1",
+    "eslint": "^9.39.2",
     "eslint-plugin-better-tailwindcss": "^3.8.0",
     "eslint-plugin-format": "^1.1.0",
     "eslint-plugin-vue": "^10.6.2"
   },
   "devDependencies": {
+    "@antfu/eslint-config": "^6.7.3",
     "@commitlint/cli": "^20.2.0",
     "@commitlint/config-conventional": "^20.2.0",
+    "@eslint/markdown": "^7.5.1",
     "@types/bun": "^1.3.5",
     "bumpp": "^10.3.2",
     "bun-plugin-dts": "^0.3.0",
     "eslint": "^9.39.2",
+    "eslint-plugin-better-tailwindcss": "^3.8.0",
+    "eslint-plugin-format": "^1.1.0",
+    "eslint-plugin-vue": "^10.6.2",
     "simple-git-hooks": "^2.13.1"
   },
   "simple-git-hooks": {