@ntnyq/eslint-config 4.0.0-beta.1 → 4.0.0-beta.11

package/README.md

@@ -15,12 +15,24 @@
 - 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.5.0+
+- [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files) for ESLint v9.20.0+
 
 ## Install
 
 ```shell
-pnpm add eslint prettier typescript @ntnyq/eslint-config @ntnyq/prettier-config -D
+npm i eslint typescript @ntnyq/eslint-config -D
+```
+
+```shell
+yarn add eslint typescript @ntnyq/eslint-config -D
+```
+
+```shell
+pnpm add eslint typescript @ntnyq/eslint-config -D
+```
+
+```shell
+bun add eslint typescript @ntnyq/eslint-config -D
 ```
 
 ## Usage
@@ -40,8 +52,8 @@ Add scripts `lint` in `package.json`:
 ```json
 {
   "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint": "eslint",
+    "lint:fix": "eslint --fix"
   }
 }
 ```
@@ -53,7 +65,26 @@ Add scripts `lint` in `package.json`:
 
 ## Prettier config
 
+Install `prettier` and setup your prettier config:
+
+```shell
+npm i prettier @ntnyq/prettier-config -D
+```
+
+```shell
+yarn add prettier @ntnyq/prettier-config -D
+```
+
+```shell
+pnpm add prettier @ntnyq/prettier-config -D
+```
+
+```shell
+bun add prettier @ntnyq/prettier-config -D
+```
+
 ```js
+// prettier.config.mjs
 // @ts-check
 
 import { config, defineConfig } from '@ntnyq/prettier-config'
@@ -86,12 +117,13 @@ export default defineConfig({
   "eslint.enable": true,
   "prettier.enable": true,
   "editor.formatOnSave": true,
+  "prettier.configPath": "./prettier.config.mjs",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit",
     "source.organizeImports": "never",
     "source.sortImports": "never"
   },
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "eslint.validate": [
     "vue",
     "yaml",
@@ -124,7 +156,7 @@ pnpm add husky nano-staged -D
     "prepare": "husky"
   },
   "nano-staged": {
-    "*.{js,ts,cjs,mjs,jsx,tsx,vue,md,svg,json,toml,yml,yaml}": "eslint --fix",
+    "*.{js,ts,cjs,mjs,jsx,tsx,vue,md,svg,yml,yaml,toml,json}": "eslint --fix",
     "*.{css,scss,html}": "prettier -uw"
   }
 }
@@ -148,9 +180,18 @@ Check for detail in:
 ### Config interface
 
 ```ts
-export interface ConfigOptions extends ConfigOptionsInternal, OptionsExtensions {
+export interface ConfigOptions {
+  /**
+   * Shareable options
+   */
+  shareable?: OptionsShareable
+
+  /**
+   * Configs enabled by default
+   * @pg
+   */
   command?: ConfigCommandOptions
-  comments?: ConfigCommentsOptions
+  eslintComments?: ConfigESLintCommentsOptions
   ignores?: ConfigIgnoresOptions
   importX?: ConfigImportXOptions
   javascript?: ConfigJavaScriptOptions
@@ -159,9 +200,10 @@ export interface ConfigOptions extends ConfigOptionsInternal, OptionsExtensions
   specials?: ConfigSpecialsOptions
 
   /**
-   * bellow can be disabled
+   * Configs bellow can be disabled
    */
   antfu?: boolean | ConfigAntfuOptions
+  deMorgan?: boolean | ConfigDeMorganOptions
   depend?: boolean | ConfigDependOptions
   githubAction?: boolean | ConfigGitHubActionOptions
   gitignore?: boolean | ConfigGitIgnoreOptions
@@ -180,16 +222,12 @@ export interface ConfigOptions extends ConfigOptionsInternal, OptionsExtensions
   unocss?: boolean | ConfigUnoCSSOptions
   vue?: boolean | ConfigVueOptions
   yml?: boolean | ConfigYmlOptions
-
   /**
    * disabled by default
    */
   svgo?: boolean | ConfigSVGOOptions
-
   /**
    * disabled by default
-   *
-   * require `eslint-plugin-eslint-plugin` installed mannally
    */
   eslintPlugin?: boolean | ConfigESLintPluginOptions
 }