https://github.com/lvjiaxuan/eslint-config

My personal ESLint config presets inherit from antfu.
https://github.com/lvjiaxuan/eslint-config

eslint eslint-config eslint-plugin

Last synced: about 1 month ago
JSON representation

My personal ESLint config presets inherit from antfu.

• Host: GitHub
• URL: https://github.com/lvjiaxuan/eslint-config
• Owner: lvjiaxuan
• License: mit
• Created: 2022-05-20T09:31:50.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-18T02:02:34.000Z (4 months ago)
• Last Synced: 2024-11-15T04:40:02.321Z (about 2 months ago)
• Topics: eslint, eslint-config, eslint-plugin
• Language: TypeScript
• Homepage:
• Size: 964 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/v/@lvjiaxuan/eslint-config)](https://www.npmjs.com/package/@lvjiaxuan/eslint-config)

[![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)

All rules inherit from [@antfu/eslint-config](https://github.com/antfu/eslint-config). The same as the usage.

# Features

1. Add my [@lvjiaxuan/eslint-plugin](https://github.com/lvjiaxuan/eslint-config/blob/main/packages/eslint-plugin/src/index.ts) with some rules.

2. Add [OXLint](https://github.com/oxc-project/oxc#-linter) as an config to reduce ESLint's burden.

3. ~~Auto-list referenced projects in `tsconfig.json` if "TypeScript" is enabled. (Deprecated since the feature of [v8-beta](https://typescript-eslint.io/blog/announcing-typescript-eslint-v8-beta/#project-service))~~

## [OXLint](https://github.com/oxc-project/oxc#-linter)

A number of rules will be taken care of by OXLint to reduce ESLint's burden.

> [!WARNING]

> 1. The rules settings of antfu's will be overwritten.

> 2. Maybe some miss-handled rules will conflict with ESLint.

```js

// eslint.config.js

import lv from '@lvjiaxuan/eslint-config'

export default lv({

  oxlint: true // equals to `{ deny: 'correctness' }`.

})

```

> [Check](https://github.com/lvjiaxuan/eslint-config/blob/main/packages/eslint-config/src/types.ts) the `OXLintOptions` types.

Modify lint scritp:

```diff

// package.json

{

  "scripts": {

-    "lint": "eslint ."

+    "lint": "npx oxlint && eslint",

+    "lintf": "npx oxlint --fix && eslint --fix"

  }

}

```