@dartess/eslint-plugin 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 [//]: # (https://keepachangelog.com/en/1.1.0/)
 
+## [0.0.4] - 2025-12-27
+
+- remove `arrow-body-style` from 'recommeded': not relevant for typed code
+- add `@typescript-eslint/consistent-type-imports` to `recommeded`: it helps with three-shaking
+
 ## [0.0.3] - 2025-12-25
 
 - disable recommended `mobx/missing-make-observable`: this rule useless with modern decorators syntax

package/README.md

@@ -1,10 +1,33 @@
 # @dartess/eslint-plugin
 
-A set of rules for various react projects
+A set of configs and rules for various TypeScript projects.
+Based on outdated or deprecated configs `eslint-config-airbnb` and `eslint-config-airbnb-typescript`.
+Also extends
+* `@eslint/js` — `recommended`
+* `typescript-eslint` — `strictTypeChecked` & `stylisticTypeChecked`
+* `eslint-plugin-import-x` — `recommended` & `typescript`
+* `@eslint-community/eslint-plugin-eslint-comments` — `recommended`
+
+Also can extends (if it is applicable)
+* `eslint-plugin-react` — `recommended` & `jsx-runtime`
+* `@next/eslint-plugin-next` — `recommended` & `core-web-vitals`
+* `eslint-config-next`
+* `eslint-plugin-mobx` — `recommended`
+* `eslint-plugin-storybook` — `recommended` & `csf-strict`
+
+All of it pinched with extra configs, setups and extra rules. Just take it and use it!
+
+### Notes
+
+1. The package is intended for use with TypeScript (it'll be useful for plain JS, but it hasn't been weel-tested).
+
+2. The package is intended for use only with the `flat` eslint config.
+
+3. _(for React users)_ The package is intended for use with [React New JSX Transform](https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html).
 
 ## Installation
 
-You'll first need to install [ESLint](https://eslint.org/) and common peer deps:
+You'll first need to install [ESLint](https://eslint.org/) and peer deps:
 
 ```sh
 npm i -D eslint eslint-plugin-import-x eslint-import-resolver-typescript @eslint-community/eslint-plugin-eslint-comments typescript-eslint eslint-plugin-unicorn
@@ -25,7 +48,7 @@ npm i -D eslint-plugin-mobx
 npm i -D eslint-plugin-storybook
 ```
 
-Next, install `@dartess/eslint-plugin`
+Next, install `@dartess/eslint-plugin` itself.
 
 ```sh
 npm i -D @dartess/eslint-plugin
@@ -52,7 +75,7 @@ import dartessEslintPluginStorybook from '@dartess/eslint-plugin/storybook';
 import { parseGitIgnore } from '@dartess/eslint-plugin/utils';
 
 export default [
-  parseGitIgnore(), // the easiest way to ignore all `.gitignore` files
+  parseGitIgnore(), // (optional) the easiest way to ignore all `.gitignore` files
   
   {
     languageOptions: {
@@ -75,45 +98,47 @@ export default [
 
 ```
 
-The package is intended for use with TypeScript.
-
-The package is intended for use with [React New JSX Transform](https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html).
-
-The package is intended for use only with the `flat` eslint config.
-
 ## Next steps
 
-If you are using React, you also probably will want to add 
+If you're using React, you also probably will want to add 
 [eslint-plugin-react-refresh](https://www.npmjs.com/package/eslint-plugin-react-refresh). 
 This plugin requires manual setup for you build tools.
 
-If you are using Mobx with legacy decorators, you have to enable rule `mobx/missing-make-observable` manually.
+If you're using Mobx with legacy decorators, you have to enable rule `mobx/missing-make-observable` manually.
 
-## Usage rules
+### Formatters
 
-Copy example above into your `eslint.config.ts` and remove unnecesary parts.
+If you're want to (and you should to) use formatting tools, you need to additionally install and setup something else.
 
-Then configure the rules you want to use under the rules section.
+#### dprint
 
-```json
-{
-    "rules": {
-        "@dartess/strict-observable-components-declaration": "error"
-    }
-}
-```
+Use `eslint-plugin-format` with rule `format/dprint` for running `dprint` as eslint rule (you probably will want to add `eslint-config-prettier` for disabling unnecessary rules).
+
+#### Biome
+
+Use `eslint-config-biome` for disabling unnecessary rules.
+
+#### Oxlint
+
+Use `eslint-plugin-oxlint` for disabling unnecessary rules.
+
+#### Prettier (Old School)
+
+* Use `eslint-config-prettier` for disabling unnecessary rules.
+* Use `eslint-plugin-prettier` for running `prettier` as eslint rule.
+* Use `eslint-plugin-format` with rule `format/prettier` for running `prettier` as eslint rule (you probably will want to add `eslint-config-prettier` for disabling unnecessary rules).
 
 ## Supported Rules
 
 Each rule has emojis denoting:
 
-- ✅ if it belongs to the `recommended` configuration
+- ✅ if it belongs to the one of `recommended` configuration
 - 🔧 if some problems reported by the rule are automatically fixable by the `--fix` [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) option
 - 💡 if some problems reported by the rule are manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
 
 | Name                                                                                                       | Description                                                                   | ✅ | 🔧 | 💡 |
 |:-----------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------|:--|:---|:---|
-| [strict-observable-components-declaration](docs/rules/strict-observable-components-declaration.md)         | Wrapping components in `observer` must comply with the regulations.           |   |    |    |
+| [strict-observable-components-declaration](docs/rules/strict-observable-components-declaration.md)         | Wrapping components in `observer` must comply with the regulations.           | ✅ |    |    |
 | [require-observer](docs/rules/require-observer.md)                                                         | Components using the stores must be wrapped in an `observer`                  | ✅ | 🔧 |    |
 | [prevent-mixing-external-and-internal-classes](docs/rules/prevent-mixing-external-and-internal-classes.md) | Prevent mixing of outer and inner classes to avoid dependency on style order. |   |    |    |
 | [jsx-no-text-as-child](docs/rules/jsx-text-as-child.md)                                                    | JSX elements should not have text without translation                         |   |    |    |

package/dist/configs/react.js

@@ -19,7 +19,10 @@ const config = [
             },
         },
     },
-    reactPlugin.configs.flat.recommended,
+    {
+        name: 'react/recommended', // missed name, @see e.g. https://github.com/jsx-eslint/eslint-plugin-react/pull/3882
+        ...reactPlugin.configs.flat.recommended,
+    },
     {
         name: '@dartess/eslint-plugin-react/jsx-runtime',
         files: ['**/*.{jsx,tsx}'],

package/dist/configs/recommended.js

@@ -199,8 +199,16 @@ const config = [
                     allowNever: false,
                 },
             ],
-            '@typescript-eslint/no-import-type-side-effects': 'error', // TODO is enabled by default?
             '@typescript-eslint/array-type': ['error', { default: 'generic' }],
+            /* this two rules help with three-shaking */
+            '@typescript-eslint/no-import-type-side-effects': 'error',
+            '@typescript-eslint/consistent-type-imports': [
+                'error',
+                {
+                    fixStyle: 'inline-type-imports',
+                    disallowTypeAnnotations: false,
+                },
+            ],
         },
     },
     {

package/dist/configs/vendor-rules/es6.d.ts

@@ -1,7 +1,4 @@
 declare const rules: {
-    'arrow-body-style': ["error", string, {
-        requireReturnForObjectLiteral: boolean;
-    }];
     'no-class-assign': "error";
     'no-restricted-exports': ["error", {
         restrictedNamedExports: string[];

package/dist/configs/vendor-rules/es6.js

@@ -3,15 +3,6 @@
 // License: MIT (see LICENSE-eslint-config-airbnb.md file)
 // Permalink: https://github.com/airbnb/javascript/blob/c25bce83be4db06e6a221d79686c485cd2ed5d5d/packages/eslint-config-airbnb-base/rules/es6.js
 const rules = {
-    // enforces no braces where they can be omitted
-    // https://eslint.org/docs/rules/arrow-body-style
-    'arrow-body-style': [
-        'error',
-        'as-needed',
-        {
-            requireReturnForObjectLiteral: false,
-        },
-    ],
     // disallow modifying variables of class declarations
     // https://eslint.org/docs/rules/no-class-assign
     'no-class-assign': 'error',

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-import { ESLint } from 'eslint';
+import type { ESLint } from 'eslint';
 declare const plugin: ESLint.Plugin;
 export default plugin;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dartess/eslint-plugin",
   "type": "module",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "A set of rules and configs for various react projects",
   "keywords": [
     "eslint",
@@ -22,6 +22,7 @@
   },
   "scripts": {
     "lint": "eslint .",
+    "lint:fix": "npm run lint -- --fix",
     "clean": "rimraf dist",
     "build": "npm run clean && tsc -p tsconfig.build.json",
     "test": "node --import ./test-setup.ts --test --experimental-strip-types",