@ntnyq/eslint-config 3.0.0-beta.9 → 3.0.0

package/README.md

@@ -6,6 +6,10 @@
 [![NPM DOWNLOADS](https://img.shields.io/npm/dy/@ntnyq/eslint-config)](https://www.npmjs.com/package/@ntnyq/eslint-config)
 [![NPM VERSION](https://img.shields.io/npm/v/@ntnyq/eslint-config/latest.svg)](https://www.npmjs.com/package/@ntnyq/eslint-config/v/latest)
 
+## Features
+
+- 🚦 Designed to work alongside with Prettier
+
 ## Install
 
 ```bash
@@ -14,20 +18,23 @@ pnpm add eslint prettier typescript @ntnyq/eslint-config @ntnyq/prettier-config
 
 ## Usage
 
-Config in `eslint.config.{mjs,mts}`:
+Highly recommended using **`eslint.config.mjs`** as the config file :
 
 ```js
-import { ntnyq } from '@ntnyq/eslint-config'
+import { defineESLintConfig } from '@ntnyq/eslint-config'
 
-export default ntnyq()
+export default defineESLintConfig()
 ```
 
-Config in `eslint.config.{cjs,cts}`
-
-```js
-const ntnyq = require('@ntnyq/eslint-config')
+Add scripts `lint` in `package.json`:
 
-module.exports = ntnyq()
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
 ```
 
 ## VSCode Config
@@ -57,6 +64,103 @@ module.exports = ntnyq()
 }
 ```
 
+## Lint changed files only
+
+### 1. Add dependencies
+
+```bash
+pnpm add husky nano-staged -D
+```
+
+### 2. Config `package.json`
+
+```json
+{
+  "scripts": {
+    "prepare": "husky"
+  },
+  "nano-staged": {
+    "*.{js,ts,cjs,mjs,vue,md,yml,yaml,json,html}": "eslint --fix"
+  }
+}
+```
+
+### 3. Add a hook
+
+```bash
+echo "nano-staged" > .husky/pre-commit
+```
+
+## Advanced config
+
+Check for detail in:
+
+- [./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 {
+  ignores?: ConfigIgnoresOptions
+
+  sort?: boolean | ConfigSortOptions
+
+  command?: boolean | ConfigCommandOptions
+
+  gitignore?: boolean | ConfigGitIgnoreOptions
+
+  imports?: ConfigImportsOptions
+
+  node?: ConfigNodeOptions
+
+  javascript?: ConfigJavaScriptOptions
+
+  typescript?: boolean | ConfigTypeScriptOptions
+
+  unicorn?: boolean | ConfigUnicornOptions
+
+  prettier?: boolean | ConfigPrettierOptions
+
+  perfectionist?: boolean | ConfigPerfectionistOptions
+
+  /**
+   * @internal
+   */
+  unusedImports?: boolean | ConfigUnusedImportsOptions
+
+  /**
+   * @internal
+   */
+  antfu?: boolean | ConfigAntfuOptions
+
+  /**
+   * @internal
+   */
+  ntnyq?: boolean | ConfigNtnyqOptions
+
+  comments?: boolean | ConfigCommentsOptions
+
+  jsdoc?: boolean | ConfigJsdocOptions
+
+  unocss?: boolean | ConfigUnoCSSOptions
+
+  regexp?: boolean | ConfigRegexpOptions
+
+  jsonc?: boolean | ConfigJsoncOptions
+
+  yml?: boolean | ConfigYmlOptions
+
+  markdown?: boolean | ConfigMarkdownOptions
+
+  toml?: boolean | ConfigTomlOptions
+
+  vue?: boolean | ConfigVueOptions
+
+  test?: boolean | ConfigTestOptions
+}
+```
+
 ## Credits
 
 - [@sxzz/eslint-config](https://github.com/sxzz/eslint-config)