@dartess/eslint-plugin 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+[//]: # (https://keepachangelog.com/en/1.1.0/)
+
+## [0.0.1] - 2025-12-16
+
+- initial version

package/README.md

@@ -0,0 +1,134 @@
+# @dartess/eslint-plugin
+
+A set of rules for various react projects
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/) and common 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
+```
+
+Next, also install the packages that suit your needs.
+
+```sh
+npm i -D eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y
+```
+```sh
+npm i -D @next/eslint-plugin-next
+```
+```sh
+npm i -D eslint-plugin-mobx
+```
+```sh
+npm i -D eslint-plugin-storybook
+```
+
+Next, install `@dartess/eslint-plugin`
+
+```sh
+npm i -D @dartess/eslint-plugin
+```
+
+## Usage configs
+
+Shared config based on `eslint-config-airbnb`, `eslint-config-airbnb-typescript`, `eslint-plugin-react/recommended`, `eslint-plugin-react/jsx-runtime`.
+
+Edit or create `eslint.config.ts` (or `eslint.config.mts`). You probably have to install `jiti` for it.
+
+```ts
+import dartessEslintPluginRecommended from '@dartess/eslint-plugin/recommended';
+
+// if `react` is used
+import dartessEslintPluginReact from '@dartess/eslint-plugin/react';
+// if `next.js` is used
+import dartessEslintPluginNext from '@dartess/eslint-plugin/next';
+// if `mobx` is used
+import dartessEslintPluginMobx from '@dartess/eslint-plugin/mobx';
+// if `storybook` is used
+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
+  
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+      },
+    },
+  },
+  
+  ...dartessEslintPluginRecommended,
+  // if `react` is used
+  ...dartessEslintPluginReact,
+  // if `next.js` is used
+  ...dartessEslintPluginNext,
+  // if `mobx` is used
+  ...dartessEslintPluginMobx,
+  // if `storybook` is used
+  ...dartessEslintPluginStorybook,
+]
+
+```
+
+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 
+[eslint-plugin-react-refresh](https://www.npmjs.com/package/eslint-plugin-react-refresh). 
+This plugin requires manual setup for you build tools.
+
+## Usage rules
+
+Copy example above into your `eslint.config.ts` and remove unnecesary parts.
+
+Then configure the rules you want to use under the rules section.
+
+```json
+{
+    "rules": {
+        "@dartess/strict-observable-components-declaration": "error"
+    }
+}
+```
+
+## Supported Rules
+
+Each rule has emojis denoting:
+
+- ✅ if it belongs to the `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.           |   |    |    |
+| [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                         |   |    |    |
+| [stories-export-meta](docs/rules/stories-export-meta.md)                                                   | Storybook's Meta should be typed                                              | ✅ |    |    |
+| [stories-export-typed](docs/rules/stories-export-typed.md)                                                 | Storybook's Stories should be typed                                           | ✅ |    |    |
+| [max-parent-import-depth](docs/rules/max-parent-import-depth.md)                                           | Limit relative imports to a maximum parent depth.                             | ✅ |    |    |
+
+## Code Reuse Policy
+
+### `eslint-config-airbnb`
+
+The package has a huge number of dependencies and will not be updated for a very long time; instead, all useful code has been copied. Configs are now considered "ours" (but remember the copyright) and can be edited.
+
+### `eslint-config-airbnb-typescript`
+
+Also as `eslint-config-airbnb` but also [deprecated](https://github.com/iamturns/eslint-config-airbnb-typescript?tab=readme-ov-file#this-repo-has-been-archived).
+
+### `@next/eslint-plugin-next` and `eslint-config-next`
+
+One of the packages does not support `flat config`. It may be removed from the repository if support appears (which is unlikely in the next many years, however).

package/dist/configs/mobx.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from 'eslint';
+declare const config: Array<Linter.Config>;
+export default config;

package/dist/configs/mobx.js

@@ -0,0 +1,13 @@
+import pluginMobx from 'eslint-plugin-mobx';
+const config = [
+    pluginMobx.flatConfigs.recommended,
+    {
+        name: '@dartess/mobx',
+        rules: {
+            'mobx/missing-observer': 'off', // replaced by the neater "@dartess/require-observer"
+            '@dartess/strict-observable-components-declaration': 'error',
+            '@dartess/require-observer': 'error',
+        },
+    },
+];
+export default config;

package/dist/configs/next.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from 'eslint';
+declare const config: Array<Linter.Config>;
+export default config;

package/dist/configs/next.js

@@ -0,0 +1,17 @@
+import nextPlugin from '@next/eslint-plugin-next';
+import vendorRulesNextConfig from "./vendor-rules/next-config.js";
+const config = [
+    {
+        name: '@dartess/nextjs',
+        files: ['**/*.{jsx,tsx}'],
+        plugins: {
+            '@next/next': nextPlugin,
+        },
+        rules: {
+            ...nextPlugin.configs.recommended.rules,
+            ...nextPlugin.configs['core-web-vitals'].rules,
+            ...vendorRulesNextConfig,
+        },
+    },
+];
+export default config;

package/dist/configs/react.d.ts

@@ -0,0 +1,3 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+declare const config: TSESLint.FlatConfig.ConfigArray;
+export default config;

package/dist/configs/react.js

@@ -0,0 +1,78 @@
+// This file contains code from the `eslint-config-airbnb` project
+// Original author: Jake Teton-Landis (https://twitter.com/@jitl)
+// License: MIT (see LICENSE-eslint-config-airbnb.md file)
+import reactPlugin from 'eslint-plugin-react';
+import reactHooksPlugin from 'eslint-plugin-react-hooks';
+import jsxA11yPlugin from 'eslint-plugin-jsx-a11y';
+import vendorRulesReact from "./vendor-rules/react.js";
+import vendorRulesReactHooks from "./vendor-rules/react-hooks.js";
+const config = [
+    {
+        name: '@dartess/react-setup',
+        plugins: {
+            'react-hooks': reactHooksPlugin,
+            'jsx-a11y': jsxA11yPlugin,
+        },
+        settings: {
+            react: {
+                version: 'detect',
+            },
+        },
+    },
+    reactPlugin.configs.flat.recommended,
+    {
+        name: '@dartess/eslint-plugin-react/jsx-runtime',
+        files: ['**/*.{jsx,tsx}'],
+        ...reactPlugin.configs.flat['jsx-runtime'],
+    },
+    {
+        name: '@dartess/react',
+        files: ['**/*.{jsx,tsx}'],
+        languageOptions: {
+            parserOptions: {
+                ecmaFeatures: {
+                    jsx: true,
+                },
+            },
+        },
+        settings: {
+            // Append 'ts' extensions to Airbnb 'import-x/resolver' setting
+            // Prepend 'mjs' to match shared config
+            // Original: ['.js', '.jsx', '.json']
+            'import-x/resolver': {
+                node: {
+                    extensions: ['.mjs', '.js', '.jsx', '.json', '.ts', '.tsx', '.d.ts'],
+                },
+            },
+        },
+        rules: {
+            ...vendorRulesReact,
+            // too hard for fixing, TODO maybe try later?
+            'react/jsx-props-no-spreading': 'off',
+            // TODO: try to enable this rules later (if needed)
+            'react/require-default-props': 'off',
+            'react/no-unstable-nested-components': 'off',
+            'jsx-a11y/click-events-have-key-events': 'off',
+            'jsx-a11y/anchor-is-valid': 'off',
+            'jsx-a11y/interactive-supports-focus': 'off',
+            // TODO END: try to enable this rules later (if needed)
+            'jsx-a11y/no-static-element-interactions': 'off', // TODO enable later
+            'jsx-a11y/no-noninteractive-tabindex': 'off', // TODO enable later
+            'jsx-a11y/no-noninteractive-element-interactions': 'off', // TODO enable later
+            'jsx-a11y/label-has-associated-control': 'off', // TODO enable later but with `assert`=`either`
+            // Append 'tsx' to Airbnb 'react/jsx-filename-extension' rule
+            // Original: ['.jsx']
+            'react/jsx-filename-extension': ['error', { extensions: ['.jsx', '.tsx'] }],
+            // overrides
+            'react/jsx-no-duplicate-props': 'off', // checked by typescript
+            'react/jsx-no-undef': 'off', // checked by typescript
+        },
+    },
+    {
+        name: '@dartess/react-hooks',
+        rules: {
+            ...vendorRulesReactHooks,
+        },
+    },
+];
+export default config;

package/dist/configs/recommended.d.ts

@@ -0,0 +1,3 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+declare const config: TSESLint.FlatConfig.ConfigArray;
+export default config;

package/dist/configs/recommended.js

@@ -0,0 +1,211 @@
+// This file contains code from the `eslint-config-airbnb` project
+// Original author: Jake Teton-Landis (https://twitter.com/@jitl)
+// License: MIT (see LICENSE-eslint-config-airbnb.md file)
+import tsEslint from 'typescript-eslint';
+import globals from 'globals';
+import eslintPluginImportX from 'eslint-plugin-import-x';
+import eslintPluginUnicorn from 'eslint-plugin-unicorn';
+import pluginJs from '@eslint/js';
+import eslintCommentsPlugin from '@eslint-community/eslint-plugin-eslint-comments/configs';
+import dartessPlugin from "../index.js";
+import vendorRulesBestPractices from "./vendor-rules/best-practices.js";
+import vendorRulesErrors from "./vendor-rules/errors.js";
+import vendorRulesStyle from "./vendor-rules/style.js";
+import vendorRulesVariables from "./vendor-rules/variables.js";
+import vendorRulesEs6 from "./vendor-rules/es6.js";
+import vendorRulesImports from "./vendor-rules/imports.js";
+import vendorRulesStrict from "./vendor-rules/strict.js";
+import vendorRulesTypescriptDisablings from "./vendor-rules/typescript-disablings.js";
+import vendorRulesTypescript from "./vendor-rules/typescript.js";
+const NO_MIDDLE_ABBRS = '(?!.*[A-Z]{3})';
+const NO_END_ABBRS = '(?!.*[A-Z]{2}$)';
+const NO_MIDDLE_UNDERSCORE = '(?!.*_{2})';
+const EMPTY = `^$`;
+const anyCamelCase = `^${NO_MIDDLE_ABBRS}${NO_END_ABBRS}[A-Za-z0-9]+$`;
+const lowerCamelCase = `^${NO_MIDDLE_ABBRS}${NO_END_ABBRS}[a-z][A-Za-z0-9]+$`;
+const UpperCamelCase = `^${NO_MIDDLE_ABBRS}${NO_END_ABBRS}[A-Z][A-Za-z0-9]+$`;
+const snake_case = `^${NO_MIDDLE_UNDERSCORE}[a-z_]+$`;
+const UPPER_CASE = `^${NO_MIDDLE_UNDERSCORE}[A-Z0-9_]+$`;
+const config = [
+    {
+        name: '@dartess/recommended/enable-report-unused-disable-directives',
+        linterOptions: {
+            reportUnusedDisableDirectives: 'error',
+        },
+    },
+    {
+        name: '@eslint/js/recommended',
+        ...pluginJs.configs.recommended,
+    },
+    ...tsEslint.configs.strictTypeChecked,
+    ...tsEslint.configs.stylisticTypeChecked,
+    eslintPluginImportX.flatConfigs.recommended,
+    eslintPluginImportX.flatConfigs.typescript,
+    eslintCommentsPlugin.recommended,
+    {
+        name: '@dartess/recommended',
+        plugins: {
+            unicorn: eslintPluginUnicorn,
+            '@dartess': dartessPlugin,
+        },
+        languageOptions: {
+            parser: tsEslint.parser,
+            globals: {
+                ...globals.browser,
+            },
+        },
+        settings: {
+            'import-x/core-modules': [],
+            'import-x/ignore': ['node_modules', '\\.(coffee|scss|css|less|hbs|svg|json)$'],
+        },
+        rules: {
+            ...vendorRulesBestPractices,
+            ...vendorRulesErrors,
+            ...vendorRulesStyle,
+            ...vendorRulesVariables,
+            ...vendorRulesEs6,
+            ...vendorRulesImports,
+            ...vendorRulesStrict,
+            /* restricts console outputs to essential log levels for cleaner logs */
+            'no-console': ['error', { allow: ['info', 'warn', 'error'] }],
+            /* permits file-wide rule control to streamline exceptional cases */
+            '@eslint-community/eslint-comments/disable-enable-pair': ['error', { allowWholeFile: true }],
+            /* obliges to describe the reason for disconnection */
+            '@eslint-community/eslint-comments/require-description': [
+                'error',
+                {
+                    ignore: [],
+                },
+            ],
+            'unicorn/no-useless-undefined': 'error',
+            'unicorn/prefer-node-protocol': 'error',
+            '@dartess/max-parent-import-depth': 'error',
+            curly: ['error', 'all'],
+            'import-x/order': [
+                'error',
+                {
+                    groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
+                    'newlines-between': 'always',
+                },
+            ],
+            'prefer-arrow-callback': [
+                'error',
+                {
+                    allowNamedFunctions: true,
+                    allowUnboundThis: true,
+                },
+            ],
+        },
+    },
+    {
+        name: '@dartess/recommended-ts',
+        files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+        rules: {
+            ...vendorRulesTypescriptDisablings,
+            ...vendorRulesTypescript,
+            /* ensures ts-ignore is accompanied by a description for proper justification */
+            '@typescript-eslint/ban-ts-comment': ['error', { 'ts-ignore': 'allow-with-description' }],
+            /* enforces consistent type alias declarations for improved clarity */
+            '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
+            /* index signature can be more informative */
+            '@typescript-eslint/consistent-indexed-object-style': 'off',
+            /* can be false-positive */
+            '@typescript-eslint/no-unnecessary-type-parameters': 'off',
+            /* can be false-positive -- TODO can be enabled after `noUncheckedIndexedAccess` */
+            '@typescript-eslint/no-unnecessary-condition': 'off',
+            /* can be false-positive */
+            '@typescript-eslint/no-floating-promises': 'off',
+            /* can be false-positive */
+            '@typescript-eslint/no-misused-promises': 'off',
+            /* can be false-positive */
+            '@typescript-eslint/prefer-nullish-coalescing': 'off',
+            /* slow; not much use */
+            '@typescript-eslint/no-deprecated': 'off',
+            '@typescript-eslint/explicit-member-accessibility': [
+                'error',
+                {
+                    overrides: {
+                        constructors: 'off',
+                        accessors: 'explicit',
+                        methods: 'explicit',
+                        properties: 'explicit',
+                        parameterProperties: 'explicit',
+                    },
+                },
+            ],
+            /* more strict rules then official options */
+            '@typescript-eslint/naming-convention': [
+                'error',
+                {
+                    selector: 'variable',
+                    format: null,
+                    custom: {
+                        regex: `${anyCamelCase}|${UPPER_CASE}`,
+                        match: true,
+                    },
+                },
+                {
+                    selector: 'function',
+                    format: null,
+                    custom: {
+                        regex: anyCamelCase,
+                        match: true,
+                    },
+                },
+                {
+                    selector: 'parameter',
+                    format: null,
+                    custom: {
+                        regex: `${anyCamelCase}|${snake_case}|${EMPTY}`,
+                        match: true,
+                    },
+                    leadingUnderscore: 'allowSingleOrDouble',
+                },
+                {
+                    selector: 'method',
+                    format: null,
+                    custom: {
+                        regex: lowerCamelCase,
+                        match: true,
+                    },
+                },
+                {
+                    selector: 'typeLike',
+                    format: null,
+                    custom: {
+                        regex: UpperCamelCase,
+                        match: true,
+                    },
+                },
+                {
+                    selector: 'typeParameter',
+                    format: null,
+                    custom: {
+                        regex: `${UpperCamelCase}|${EMPTY}`,
+                        match: true,
+                    },
+                    prefix: ['T'],
+                },
+            ],
+            '@typescript-eslint/restrict-template-expressions': [
+                'error',
+                {
+                    allowNumber: true,
+                    allowAny: false,
+                    allowArray: false,
+                    allowBoolean: false,
+                    allowNullish: false,
+                    allowRegExp: false,
+                    allowNever: false,
+                },
+            ],
+            '@typescript-eslint/no-import-type-side-effects': 'error', // TODO is enabled by default?
+            '@typescript-eslint/array-type': ['error', { default: 'generic' }],
+        },
+    },
+    {
+        files: ['**/*.js'],
+        ...tsEslint.configs.disableTypeChecked,
+    },
+];
+export default config;

package/dist/configs/storybook.d.ts

@@ -0,0 +1,3 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+declare const config: Array<TSESLint.FlatConfig.Config>;
+export default config;

package/dist/configs/storybook.js

@@ -0,0 +1,20 @@
+import pluginStorybook from 'eslint-plugin-storybook';
+const config = [
+    {
+        ignores: ['!.storybook'],
+    },
+    ...pluginStorybook.configs['flat/recommended'],
+    ...pluginStorybook.configs['flat/csf-strict'],
+    {
+        name: '@dartess/storybook',
+        files: ['**/*.stories.tsx'],
+        rules: {
+            'storybook/no-title-property-in-meta': 'off', // generated names may be inappropriate
+            '@dartess/stories-export-meta': 'error', // TODO can be replaced with native storybook/meta-satisfies-type ?
+            '@dartess/stories-export-typed': 'error',
+            '@typescript-eslint/no-explicit-any': 'off', // can be hard for typing in stories
+            '@dartess/jsx-text-as-child': 'off', // not necessary in stories
+        },
+    },
+];
+export default config;

package/dist/configs/vendor-rules/best-practices.d.ts

@@ -0,0 +1,120 @@
+declare const rules: {
+    'array-callback-return': ["error", {
+        allowImplicit: boolean;
+    }];
+    'block-scoped-var': "error";
+    'default-case': ["error", {
+        commentPattern: string;
+    }];
+    'default-case-last': "error";
+    'default-param-last': "error";
+    eqeqeq: ["error", string, {
+        null: string;
+    }];
+    'grouped-accessor-pairs': "error";
+    'guard-for-in': "error";
+    'max-classes-per-file': ["error", number];
+    'no-alert': "error";
+    'no-caller': "error";
+    'no-case-declarations': "error";
+    'no-constructor-return': "error";
+    'no-else-return': ["error", {
+        allowElseIf: boolean;
+    }];
+    'no-empty-function': ["error", {
+        allow: string[];
+    }];
+    'no-empty-pattern': "error";
+    'no-eval': "error";
+    'no-extend-native': "error";
+    'no-extra-bind': "error";
+    'no-extra-label': "error";
+    'no-fallthrough': "error";
+    'no-global-assign': ["error", {
+        exceptions: never[];
+    }];
+    'no-iterator': "error";
+    'no-labels': ["error", {
+        allowLoop: boolean;
+        allowSwitch: boolean;
+    }];
+    'no-lone-blocks': "error";
+    'no-loop-func': "error";
+    'no-multi-str': "error";
+    'no-new': "error";
+    'no-new-wrappers': "error";
+    'no-nonoctal-decimal-escape': "error";
+    'no-object-constructor': "error";
+    'no-octal': "error";
+    'no-octal-escape': "error";
+    'no-param-reassign': ["error", {
+        props: boolean;
+        ignorePropertyModificationsFor: string[];
+    }];
+    'no-proto': "error";
+    'no-restricted-properties': ["error", {
+        object: string;
+        property: string;
+        message: string;
+    }, {
+        object: string;
+        property: string;
+        message: string;
+    }, {
+        object: string;
+        property: string;
+        message: string;
+    }, {
+        object: string;
+        property: string;
+        message: string;
+    }, {
+        object: string;
+        property: string;
+        message: string;
+    }, {
+        object: string;
+        property: string;
+        message: string;
+    }, {
+        object: string;
+        property: string;
+        message: string;
+    }, {
+        property: string;
+        message: string;
+    }, {
+        property: string;
+        message: string;
+    }, {
+        object: string;
+        property: string;
+        message: string;
+    }];
+    'no-return-assign': ["error", string];
+    'no-script-url': "error";
+    'no-self-assign': ["error", {
+        props: boolean;
+    }];
+    'no-self-compare': "error";
+    'no-sequences': "error";
+    'no-throw-literal': "error";
+    'no-unused-labels': "error";
+    'no-useless-catch': "error";
+    'no-useless-concat': "error";
+    'no-useless-escape': "error";
+    'no-useless-return': "error";
+    'no-void': "error";
+    'prefer-promise-reject-errors': ["error", {
+        allowEmptyReject: boolean;
+    }];
+    'prefer-object-has-own': "off";
+    'prefer-regex-literals': ["error", {
+        disallowRedundantWrapping: boolean;
+    }];
+    radix: "error";
+    'require-await': "off";
+    'vars-on-top': "error";
+    yoda: "error";
+};
+export default rules;