@liwo/eslint-config 0.0.7 → 0.1.0

package/README.md

@@ -1,6 +1,13 @@
 # @liwo/eslint-config
 
-Hard-forked from `@antfu/eslint-config`. It adopts a more opinionated and aggressive approach, making it generally unsuitable for the majority of users.
+![TypeScript](https://img.shields.io/badge/TypeScript-007ACC.svg?logo=typescript&logoColor=white)
+[![npm](https://img.shields.io/npm/v/@liwo/eslint-config?label=npm)](https://npmjs.com/package/@liwo/eslint-config)
+[![downloads](https://img.shields.io/npm/dm/@liwo/eslint-config.svg)](https://npmjs.com/package/@liwo/eslint-config)
+[![ci status](https://github.com/liwonet/eslint-config/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/liwonet/eslint-config/actions/workflows/ci.yml)
+![unpacked size](https://img.shields.io/npm/unpacked-size/%40liwo%2Feslint-config)
+![license](https://img.shields.io/github/license/liwonet/eslint-config)
+
+It's an opinionated and aggressive eslint config.
 
 ## Install
 
@@ -8,6 +15,27 @@ Hard-forked from `@antfu/eslint-config`. It adopts a more opinionated and aggres
 pnpm add -D eslint @liwo/eslint-config
 ```
 
+Add `package.json` scripts.
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "format": "eslint --fix ."
+  }
+}
+```
+
+## Usage
+
+```shell
+pnpm run lint
+```
+
+```shell
+pnpm run format
+```
+
 ## Acknowledgements
 
 Thanks to the community and developers for their contributions!

package/dist/index.d.ts

@@ -2534,11 +2534,6 @@ interface RuleOptions {
    * @see https://eslint.org/docs/latest/rules/radix
    */
   'radix'?: Linter.RuleEntry<Radix>;
-  /**
-   * Disallow `children` in void DOM elements.
-   * @see https://eslint-react.xyz/docs/rules/dom-no-void-elements-with-children
-   */
-  'react-dom/no-children-in-void-dom-elements'?: Linter.RuleEntry<[]>;
   /**
    * Disallow `dangerouslySetInnerHTML`.
    * @see https://eslint-react.xyz/docs/rules/dom-no-dangerously-set-innerhtml
@@ -2570,7 +2565,7 @@ interface RuleOptions {
    */
   'react-dom/no-missing-button-type'?: Linter.RuleEntry<[]>;
   /**
-   * Enforces explicit `sandbox` attribute for `iframe` elements.
+   * Enforces explicit `sandbox` prop for `iframe` elements.
    * @see https://eslint-react.xyz/docs/rules/dom-no-missing-iframe-sandbox
    */
   'react-dom/no-missing-iframe-sandbox'?: Linter.RuleEntry<[]>;
@@ -2594,6 +2589,11 @@ interface RuleOptions {
    * @see https://eslint-react.xyz/docs/rules/dom-no-script-url
    */
   'react-dom/no-script-url'?: Linter.RuleEntry<[]>;
+  /**
+   * Disallows the use of string style prop.
+   * @see https://eslint-react.xyz/docs/rules/dom-no-string-style-prop
+   */
+  'react-dom/no-string-style-prop'?: Linter.RuleEntry<[]>;
   /**
    * Disallow unknown `DOM` property.
    * @see https://eslint-react.xyz/docs/rules/dom-no-unknown-property
@@ -2620,60 +2620,15 @@ interface RuleOptions {
    */
   'react-dom/no-void-elements-with-children'?: Linter.RuleEntry<[]>;
   /**
-   * Enforces that a function with the `use` prefix should use at least one Hook inside of it.
-   * @see https://eslint-react.xyz/docs/rules/hooks-extra-no-unnecessary-use-prefix
-   */
-  'react-hooks-extra/ensure-custom-hooks-using-other-hooks'?: Linter.RuleEntry<[]>;
-  /**
-   * Disallow unnecessary usage of `useCallback`.
-   * @see https://eslint-react.xyz/docs/rules/hooks-extra-no-unnecessary-use-callback
+   * Enforces React Dom is imported via a namespace import.
+   * @see https://eslint-react.xyz/docs/rules/dom-prefer-namespace-import
    */
-  'react-hooks-extra/ensure-use-callback-has-non-empty-deps'?: Linter.RuleEntry<[]>;
-  /**
-   * Disallow unnecessary usage of `useMemo`.
-   * @see https://eslint-react.xyz/docs/rules/hooks-extra-no-unnecessary-use-memo
-   */
-  'react-hooks-extra/ensure-use-memo-has-non-empty-deps'?: Linter.RuleEntry<[]>;
+  'react-dom/prefer-namespace-import'?: Linter.RuleEntry<[]>;
   /**
    * Disallow direct calls to the `set` function of `useState` in `useEffect`.
    * @see https://eslint-react.xyz/docs/rules/hooks-extra-no-direct-set-state-in-use-effect
    */
   'react-hooks-extra/no-direct-set-state-in-use-effect'?: Linter.RuleEntry<[]>;
-  /**
-   * Disallow direct calls to the `set` function of `useState` in `useLayoutEffect`.
-   * @see https://eslint-react.xyz/docs/rules/hooks-extra-no-direct-set-state-in-use-layout-effect
-   */
-  'react-hooks-extra/no-direct-set-state-in-use-layout-effect'?: Linter.RuleEntry<[]>;
-  /**
-   * Enforces that a function with the `use` prefix should use at least one Hook inside of it.
-   * @see https://eslint-react.xyz/docs/rules/hooks-extra-no-unnecessary-use-prefix
-   */
-  'react-hooks-extra/no-redundant-custom-hook'?: Linter.RuleEntry<[]>;
-  /**
-   * Disallow unnecessary usage of `useCallback`.
-   * @see https://eslint-react.xyz/docs/rules/hooks-extra-no-unnecessary-use-callback
-   */
-  'react-hooks-extra/no-unnecessary-use-callback'?: Linter.RuleEntry<[]>;
-  /**
-   * Disallow unnecessary usage of `useMemo`.
-   * @see https://eslint-react.xyz/docs/rules/hooks-extra-no-unnecessary-use-memo
-   */
-  'react-hooks-extra/no-unnecessary-use-memo'?: Linter.RuleEntry<[]>;
-  /**
-   * Enforces that a function with the `use` prefix should use at least one Hook inside of it.
-   * @see https://eslint-react.xyz/docs/rules/hooks-extra-no-unnecessary-use-prefix
-   */
-  'react-hooks-extra/no-unnecessary-use-prefix'?: Linter.RuleEntry<[]>;
-  /**
-   * Enforces that a function with the `use` prefix should use at least one Hook inside of it.
-   * @see https://eslint-react.xyz/docs/rules/hooks-extra-no-unnecessary-use-prefix
-   */
-  'react-hooks-extra/no-useless-custom-hooks'?: Linter.RuleEntry<[]>;
-  /**
-   * Enforces function calls made inside `useState` to be wrapped in an `initializer function`.
-   * @see https://eslint-react.xyz/docs/rules/hooks-extra-prefer-use-state-lazy-initialization
-   */
-  'react-hooks-extra/prefer-use-state-lazy-initialization'?: Linter.RuleEntry<[]>;
   /**
    * Verifies that automatic effect dependencies are compiled if opted-in
    */
@@ -2839,25 +2794,15 @@ interface RuleOptions {
    */
   'react-web-api/no-leaked-timeout'?: Linter.RuleEntry<[]>;
   /**
-   * Enforces explicit boolean values for boolean attributes.
-   * @see https://eslint-react.xyz/docs/rules/avoid-shorthand-boolean
-   */
-  'react/avoid-shorthand-boolean'?: Linter.RuleEntry<[]>;
-  /**
-   * Enforces explicit `<Fragment>` components instead of the shorthand `<>` or `</>` syntax.
-   * @see https://eslint-react.xyz/docs/rules/avoid-shorthand-fragment
-   */
-  'react/avoid-shorthand-fragment'?: Linter.RuleEntry<[]>;
-  /**
-   * Disallow useless `forwardRef` calls on components that don't use `ref`s.
-   * @see https://eslint-react.xyz/docs/rules/no-useless-forward-ref
-   */
-  'react/ensure-forward-ref-using-ref'?: Linter.RuleEntry<[]>;
-  /**
-   * Enforces that the 'key' attribute is placed before the spread attribute in JSX elements.
+   * Enforces that the 'key' prop is placed before the spread prop in JSX elements.
    * @see https://eslint-react.xyz/docs/rules/jsx-key-before-spread
    */
   'react/jsx-key-before-spread'?: Linter.RuleEntry<[]>;
+  /**
+   * Prevents comments from being inserted as text nodes.
+   * @see https://eslint-react.xyz/docs/rules/jsx-no-comment-textnodes
+   */
+  'react/jsx-no-comment-textnodes'?: Linter.RuleEntry<[]>;
   /**
    * Disallow duplicate props in JSX elements.
    * @see https://eslint-react.xyz/docs/rules/jsx-no-duplicate-props
@@ -2873,6 +2818,16 @@ interface RuleOptions {
    * @see https://eslint-react.xyz/docs/rules/jsx-no-undef
    */
   'react/jsx-no-undef'?: Linter.RuleEntry<[]>;
+  /**
+   * Enforces shorthand syntax for boolean attributes.
+   * @see https://eslint-react.xyz/docs/rules/jsx-shorthand-boolean
+   */
+  'react/jsx-shorthand-boolean'?: Linter.RuleEntry<ReactJsxShorthandBoolean>;
+  /**
+   * Enforces shorthand syntax for fragments.
+   * @see https://eslint-react.xyz/docs/rules/jsx-shorthand-fragment
+   */
+  'react/jsx-shorthand-fragment'?: Linter.RuleEntry<ReactJsxShorthandFragment>;
   /**
    * Marks React variables as used when JSX is used.
    * @see https://eslint-react.xyz/docs/rules/jsx-uses-react
@@ -2933,21 +2888,6 @@ interface RuleOptions {
    * @see https://eslint-react.xyz/docs/rules/no-clone-element
    */
   'react/no-clone-element'?: Linter.RuleEntry<[]>;
-  /**
-   * Prevents comments from being inserted as text nodes.
-   * @see https://eslint-react.xyz/docs/rules/no-comment-textnodes
-   */
-  'react/no-comment-textnodes'?: Linter.RuleEntry<[]>;
-  /**
-   * Disallow complex conditional rendering in JSX expressions.
-   * @see https://eslint-react.xyz/docs/rules/no-complex-conditional-rendering
-   */
-  'react/no-complex-conditional-rendering'?: Linter.RuleEntry<[]>;
-  /**
-   * Disallow complex conditional rendering in JSX expressions.
-   * @see https://eslint-react.xyz/docs/rules/no-complex-conditional-rendering
-   */
-  'react/no-complicated-conditional-rendering'?: Linter.RuleEntry<[]>;
   /**
    * Replace usages of `componentWillMount` with `UNSAFE_componentWillMount`.
    * @see https://eslint-react.xyz/docs/rules/no-component-will-mount
@@ -2983,16 +2923,16 @@ interface RuleOptions {
    * @see https://eslint-react.xyz/docs/rules/no-direct-mutation-state
    */
   'react/no-direct-mutation-state'?: Linter.RuleEntry<[]>;
-  /**
-   * Disallow duplicate props in JSX elements.
-   * @see https://eslint-react.xyz/docs/rules/jsx-no-duplicate-props
-   */
-  'react/no-duplicate-jsx-props'?: Linter.RuleEntry<[]>;
   /**
    * Disallow duplicate `key` on elements in the same array or a list of `children`.
    * @see https://eslint-react.xyz/docs/rules/no-duplicate-key
    */
   'react/no-duplicate-key'?: Linter.RuleEntry<[]>;
+  /**
+   * Disallow certain props on components.
+   * @see https://eslint-react.xyz/docs/rules/no-forbidden-props
+   */
+  'react/no-forbidden-props'?: Linter.RuleEntry<ReactNoForbiddenProps>;
   /**
    * Replaces usages of `forwardRef` with passing `ref` as a prop.
    * @see https://eslint-react.xyz/docs/rules/no-forward-ref
@@ -3033,11 +2973,6 @@ interface RuleOptions {
    * @see https://eslint-react.xyz/docs/rules/no-nested-component-definitions
    */
   'react/no-nested-component-definitions'?: Linter.RuleEntry<[]>;
-  /**
-   * Disallow nesting component definitions inside other components.
-   * @see https://eslint-react.xyz/docs/rules/no-nested-component-definitions
-   */
-  'react/no-nested-components'?: Linter.RuleEntry<[]>;
   /**
    * Disallow nesting lazy component declarations inside other components.
    * @see https://eslint-react.xyz/docs/rules/no-nested-lazy-component-declarations
@@ -3064,7 +2999,7 @@ interface RuleOptions {
    */
   'react/no-set-state-in-component-did-update'?: Linter.RuleEntry<[]>;
   /**
-   * Disallows calling `this.setState` in `componentWillUpdate` outside of functions, such as callbacks.
+   * Disallow calling `this.setState` in `componentWillUpdate` outside of functions, such as callbacks.
    * @see https://eslint-react.xyz/docs/rules/no-set-state-in-component-will-update
    */
   'react/no-set-state-in-component-will-update'?: Linter.RuleEntry<[]>;
@@ -3073,6 +3008,26 @@ interface RuleOptions {
    * @see https://eslint-react.xyz/docs/rules/no-string-refs
    */
   'react/no-string-refs'?: Linter.RuleEntry<[]>;
+  /**
+   * Prevents the use of unnecessary `key` props on JSX elements when rendering lists.
+   * @see https://eslint-react.xyz/docs/rules/no-unnecessary-key
+   */
+  'react/no-unnecessary-key'?: Linter.RuleEntry<[]>;
+  /**
+   * Disallow unnecessary usage of `useCallback`.
+   * @see https://eslint-react.xyz/docs/rules/no-unnecessary-use-callback
+   */
+  'react/no-unnecessary-use-callback'?: Linter.RuleEntry<[]>;
+  /**
+   * Disallow unnecessary usage of `useMemo`.
+   * @see https://eslint-react.xyz/docs/rules/no-unnecessary-use-memo
+   */
+  'react/no-unnecessary-use-memo'?: Linter.RuleEntry<[]>;
+  /**
+   * Enforces that a function with the `use` prefix should use at least one Hook inside of it.
+   * @see https://eslint-react.xyz/docs/rules/no-unnecessary-use-prefix
+   */
+  'react/no-unnecessary-use-prefix'?: Linter.RuleEntry<[]>;
   /**
    * Warns the usage of `UNSAFE_componentWillMount` in class components.
    * @see https://eslint-react.xyz/docs/rules/no-unsafe-component-will-mount
@@ -3103,6 +3058,11 @@ interface RuleOptions {
    * @see https://eslint-react.xyz/docs/rules/no-unused-class-component-members
    */
   'react/no-unused-class-component-members'?: Linter.RuleEntry<[]>;
+  /**
+   * Warns component props that are defined but never used.
+   * @see https://eslint-react.xyz/docs/rules/no-unused-props
+   */
+  'react/no-unused-props'?: Linter.RuleEntry<[]>;
   /**
    * Warns unused class component state.
    * @see https://eslint-react.xyz/docs/rules/no-unused-state
@@ -3130,29 +3090,19 @@ interface RuleOptions {
   'react/prefer-destructuring-assignment'?: Linter.RuleEntry<[]>;
   /**
    * Enforces React is imported via a namespace import.
-   * @see https://eslint-react.xyz/docs/rules/prefer-react-namespace-import
+   * @see https://eslint-react.xyz/docs/rules/prefer-namespace-import
    */
-  'react/prefer-react-namespace-import'?: Linter.RuleEntry<[]>;
+  'react/prefer-namespace-import'?: Linter.RuleEntry<[]>;
   /**
    * Enforces read-only props in components.
    * @see https://eslint-react.xyz/docs/rules/prefer-read-only-props
    */
   'react/prefer-read-only-props'?: Linter.RuleEntry<[]>;
   /**
-   * Enforces shorthand syntax for boolean attributes.
-   * @see https://eslint-react.xyz/docs/rules/prefer-shorthand-boolean
-   */
-  'react/prefer-shorthand-boolean'?: Linter.RuleEntry<[]>;
-  /**
-   * Enforces shorthand syntax for fragments.
-   * @see https://eslint-react.xyz/docs/rules/prefer-shorthand-fragment
-   */
-  'react/prefer-shorthand-fragment'?: Linter.RuleEntry<[]>;
-  /**
-   * Marks variables used in JSX elements as used.
-   * @see https://eslint-react.xyz/docs/rules/jsx-uses-vars
+   * Enforces function calls made inside `useState` to be wrapped in an `initializer function`.
+   * @see https://eslint-react.xyz/docs/rules/prefer-use-state-lazy-initialization
    */
-  'react/use-jsx-vars'?: Linter.RuleEntry<[]>;
+  'react/prefer-use-state-lazy-initialization'?: Linter.RuleEntry<[]>;
   /**
    * disallow confusing quantifiers
    * @see https://ota-meshi.github.io/eslint-plugin-regexp/rules/confusing-quantifier.html
@@ -11918,6 +11868,20 @@ type ReactRefreshOnlyExportComponents = [] | [{
   customHOCs?: string[];
   checkJS?: boolean;
 }];
+// ----- react/jsx-shorthand-boolean -----
+type ReactJsxShorthandBoolean = [] | [(-1 | 1)];
+// ----- react/jsx-shorthand-fragment -----
+type ReactJsxShorthandFragment = [] | [(-1 | 1)];
+// ----- react/no-forbidden-props -----
+type ReactNoForbiddenProps = [] | [{
+  forbid?: (string | {
+    excludedNodes?: string[];
+    prop: string;
+  } | {
+    includedNodes?: string[];
+    prop: string;
+  })[];
+}];
 // ----- react/no-useless-fragment -----
 type ReactNoUselessFragment = [] | [{
   allowExpressions?: boolean;

package/dist/index.js

@@ -1043,6 +1043,7 @@ async function react(options = {}) {
 			},
 			name: "liwo/react/rules",
 			rules: {
+				"react/jsx-no-comment-textnodes": "warn",
 				"react/jsx-no-duplicate-props": "warn",
 				"react/jsx-uses-vars": "warn",
 				"react/no-access-state-in-setstate": "error",
@@ -1053,7 +1054,6 @@ async function react(options = {}) {
 				"react/no-children-only": "warn",
 				"react/no-children-to-array": "warn",
 				"react/no-clone-element": "warn",
-				"react/no-comment-textnodes": "warn",
 				"react/no-component-will-mount": "error",
 				"react/no-component-will-receive-props": "error",
 				"react/no-component-will-update": "error",
@@ -1072,6 +1072,7 @@ async function react(options = {}) {
 				"react/no-set-state-in-component-did-update": "warn",
 				"react/no-set-state-in-component-will-update": "warn",
 				"react/no-string-refs": "error",
+				"react/no-unnecessary-use-prefix": "warn",
 				"react/no-unsafe-component-will-mount": "warn",
 				"react/no-unsafe-component-will-receive-props": "warn",
 				"react/no-unsafe-component-will-update": "warn",
@@ -1081,6 +1082,7 @@ async function react(options = {}) {
 				"react/no-unused-state": "warn",
 				"react/no-use-context": "warn",
 				"react/no-useless-forward-ref": "warn",
+				"react/prefer-use-state-lazy-initialization": "warn",
 				"react-dom/no-dangerously-set-innerhtml": "warn",
 				"react-dom/no-dangerously-set-innerhtml-with-children": "error",
 				"react-dom/no-find-dom-node": "error",
@@ -1096,11 +1098,8 @@ async function react(options = {}) {
 				"react-dom/no-unsafe-target-blank": "warn",
 				"react-dom/no-use-form-state": "error",
 				"react-dom/no-void-elements-with-children": "error",
-				"react-hooks/exhaustive-deps": "warn",
-				"react-hooks/rules-of-hooks": "error",
+				...pluginReactHooks.configs.recommended.rules,
 				"react-hooks-extra/no-direct-set-state-in-use-effect": "warn",
-				"react-hooks-extra/no-unnecessary-use-prefix": "warn",
-				"react-hooks-extra/prefer-use-state-lazy-initialization": "warn",
 				"react-web-api/no-leaked-event-listener": "warn",
 				"react-web-api/no-leaked-interval": "warn",
 				"react-web-api/no-leaked-resize-observer": "warn",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@liwo/eslint-config",
   "type": "module",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "ESLint config by Liwo",
   "author": "Aoang <aoang@x2oe.com>",
   "license": "MIT",
@@ -49,7 +49,7 @@
     "@antfu/install-pkg": "1.1.0",
     "@clack/prompts": "0.11.0",
     "@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
-    "@eslint-react/eslint-plugin": "1.53.1",
+    "@eslint-react/eslint-plugin": "2.2.4",
     "@eslint/markdown": "7.5.0",
     "@stylistic/eslint-plugin": "5.5.0",
     "@typescript-eslint/eslint-plugin": "8.46.2",
@@ -106,7 +106,7 @@
     "typescript": "^5.9.3",
     "vitest": "^4.0.5",
     "vue": "^3.5.22",
-    "@liwo/eslint-config": "0.0.7"
+    "@liwo/eslint-config": "0.1.0"
   },
   "simple-git-hooks": {
     "pre-commit": "npx lint-staged"
@@ -124,6 +124,7 @@
     "build:inspector": "pnpm build && npx @eslint/config-inspector build && tsx scripts/fixed-netlify.ts",
     "watch": "tsdown --watch",
     "lint": "eslint",
+    "format": "eslint --fix .",
     "gen": "tsx scripts/typegen.ts",
     "test": "vitest",
     "release": "bumpp",