@ntnyq/eslint-config 5.9.0 → 6.0.0-beta.1

package/README.md

@@ -1,34 +1,37 @@
 # @ntnyq/eslint-config
 
-> ESLint config for JavaScript, TypeScript, Vue, JSON, Markdown, YAML, TOML, SVG and etc.
+> 🎨 ESLint config for JavaScript, TypeScript, Vue, JSON, Markdown, YAML, TOML, SVG and etc.
 
 [![CI](https://github.com/ntnyq/eslint-config/workflows/CI/badge.svg)](https://github.com/ntnyq/eslint-config/actions)
 [![NPM VERSION](https://img.shields.io/npm/v/@ntnyq/eslint-config/latest.svg)](https://www.npmjs.com/package/@ntnyq/eslint-config/v/latest)
+[![NPM NEXT VERSION](https://img.shields.io/npm/v/@ntnyq/eslint-config/next.svg)](https://www.npmjs.com/package/@ntnyq/eslint-config/v/next)
 [![NPM DOWNLOADS](https://img.shields.io/npm/dy/@ntnyq/eslint-config)](https://www.npmjs.com/package/@ntnyq/eslint-config)
 [![LICENSE](https://img.shields.io/github/license/ntnyq/eslint-config.svg)](https://github.com/ntnyq/eslint-config/blob/main/LICENSE)
 
 > [!IMPORTANT]
-> Feel free to create and maintain your own fork if you think this is too much opinionated.
+> Feel free to create and maintain your own fork if you think this is too opinionated.
 
-## Requirement
+## 📋 Requirements
 
-- NodeJS v20.11.0+
-- ESLint v9.20.0+
+- Node.js ^20.19.0 || ^22.13.0 || >=24
+- ESLint ^9.38.0
 
 > [!TIP]
-> For NodeJS v18 support, please use [v4](https://github.com/ntnyq/eslint-config/tree/v4)
+> For Node.js v18 support, please use [v4](https://github.com/ntnyq/eslint-config/tree/v4).
+>
+> For Node.js versions below 20.19.0, please use [v5](https://github.com/ntnyq/eslint-config/tree/v5).
 
-## Features
+## ✨ Features
 
-- Designed to work alongside with [Prettier](https://prettier.io) and [TypeScript](https://www.typescriptlang.org/)
-- Opinionable: single quote, no semi, trailing comma, etc
-- Respect `.gitignore` via [eslint-config-flat-gitignore](https://github.com/antfu/eslint-config-flat-gitignore)
-- Out-of-box support for TypeScript, Vue, JSON, Markdown, YAML, TOML, SVG and etc
-- Strict but provides useful rules to guard your codebase
-- Custom ESLint commands for [eslint-plugin-command](https://github.com/antfu/eslint-plugin-command)
-- [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files) for ESLint v9.20.0+
+- ✅ Designed to work alongside [Prettier](https://prettier.io) and [TypeScript](https://www.typescriptlang.org/)
+- 🎯 Opinionated: single quote, no semi, trailing comma, etc
+- 🪄 Respect `.gitignore` via [eslint-config-flat-gitignore](https://github.com/antfu/eslint-config-flat-gitignore)
+- 📦 Out-of-the-box support for TypeScript, Vue, JSON, Markdown, YAML, TOML, SVG, Astro, Svelte, etc
+- 🛡️ Strict but provides useful rules to guard your codebase
+- 🔧 Custom ESLint commands for [eslint-plugin-command](https://github.com/antfu/eslint-plugin-command)
+- 🎪 [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files) for ESLint v9.38.0+
 
-## Install
+## 📦 Install
 
 ```shell
 npm i eslint typescript @ntnyq/eslint-config -D
@@ -46,9 +49,9 @@ pnpm add eslint typescript @ntnyq/eslint-config -D
 bun add eslint typescript @ntnyq/eslint-config -D
 ```
 
-## Usage
+## 🚀 Usage
 
-Highly recommended using **`eslint.config.mjs`** as the config file :
+Highly recommend using **`eslint.config.mjs`** as the config file:
 
 ```js
 // @ts-check
@@ -81,7 +84,7 @@ export default defineESLintConfig(
 )
 ```
 
-Add scripts `lint` in `package.json`:
+Add a `lint` script to `package.json`:
 
 ```json
 {
@@ -93,15 +96,15 @@ Add scripts `lint` in `package.json`:
 ```
 
 <details>
-<summary>💼 Intergrated with Prettier, VSCode, husky and nano-staged</summary>
+<summary>💼 Integration: Prettier, VS Code, husky and nano-staged</summary>
 
 <br>
 
-## Prettier config
+## 🎨 Prettier config
 
 > Feel free to use your own prettier config.
 
-Install `prettier` and setup your prettier config:
+Install `prettier` and set up your Prettier config:
 
 ```shell
 npm i prettier @ntnyq/prettier-config -D
@@ -146,7 +149,7 @@ export default defineConfig({
 })
 ```
 
-## VSCode Config
+## 💻 VSCode config
 
 ```json
 {
@@ -176,7 +179,7 @@ export default defineConfig({
 }
 ```
 
-## Lint changed files only
+## 🎯 Lint changed files only
 
 ### 1. Add dependencies
 
@@ -206,18 +209,25 @@ echo "nano-staged" > .husky/pre-commit
 
 </details>
 
-## View what rules are enabled
+## 🔍 View what rules are enabled
 
 Please check [eslint-config-inspector](https://eslint-config-inspector.ntnyq.com/) powered by [@eslint/config-inspector](https://github.com/eslint/config-inspector).
 
-## Advanced config
+## ⚙️ Advanced config
 
-Check for detail in:
+For details, see:
 
 - [./src/types/config.ts](https://github.com/ntnyq/eslint-config/blob/main/src/types/config.ts)
 - [./src/core.ts](https://github.com/ntnyq/eslint-config/blob/main/src/core.ts)
 
-### Config interface
+## ⚙️ Advanced config
+
+For details, see:
+
+- [./src/types/config.ts](https://github.com/ntnyq/eslint-config/blob/main/src/types/config.ts)
+- [./src/core.ts](https://github.com/ntnyq/eslint-config/blob/main/src/core.ts)
+
+### 📝 Config interface
 
 ```ts
 export interface ConfigOptions {
@@ -228,7 +238,6 @@ export interface ConfigOptions {
 
   /**
    * Configs enabled by default
-   * @pg
    */
   command?: ConfigCommandOptions
   eslintComments?: ConfigESLintCommentsOptions
@@ -237,7 +246,7 @@ export interface ConfigOptions {
   node?: ConfigNodeOptions
 
   /**
-   * Configs bellow can be disabled
+   * Configs below can be disabled
    */
   antfu?: boolean | ConfigAntfuOptions
   deMorgan?: boolean | ConfigDeMorganOptions
@@ -264,39 +273,40 @@ export interface ConfigOptions {
   yml?: boolean | ConfigYmlOptions
 
   /**
-   * Configs bellow are disabled by default
+   * Configs below are disabled by default
    */
   astro?: boolean | ConfigAstroOptions
   html?: boolean | ConfigHtmlOptions
   pnpm?: boolean | ConfigPnpmOptions
+  oxfmt?: boolean | ConfigOxfmtOptions
   svelte?: boolean | ConfigSvelteOptions
   svgo?: boolean | ConfigSVGOOptions
   eslintPlugin?: boolean | ConfigESLintPluginOptions
 }
 ```
 
-## Versioning policy
+## 📌 Versioning policy
 
-This project aims to follows [Semantic Versioning](https://semver.org/) for releases.
+This project aims to follow [Semantic Versioning](https://semver.org/) for releases.
 
-### Changes considered as Breaking Changes
+### 🔴 Changes treated as Breaking Changes
 
 - Node.js version requirement changes
 - Huge refactors that might break the config
 - Plugins made major changes that might break the config
 - Changes that might affect most of the codebases
 
-### Changes considered as Non-Breaking Changes
+### 🟢 Changes treated as Non-Breaking Changes
 
 - Enable/disable rules and plugins (that might become stricter)
-- Rules options changes
+- Rule option changes
 - Version bumps of dependencies
 
-## Credits
+## 🙏 Credits
 
 - [@sxzz/eslint-config](https://github.com/sxzz/eslint-config)
 - [@antfu/eslint-config](https://github.com/antfu/eslint-config)
 
-## License
+## 📄 License
 
 [MIT](./LICENSE) License © 2023-PRESENT [ntnyq](https://github.com/ntnyq)