@ghettoddos/eslint-config 1.4.0 → 1.5.0

package/dist/index.d.ts

@@ -219,6 +219,105 @@ interface RuleOptions {
    * @see https://eslint.org/docs/latest/rules/dot-notation
    */
   'dot-notation'?: Linter.RuleEntry<DotNotation>;
+  /**
+   * Enforce Fx as a suffix for any effect created by Effector methods
+   * @see https://eslint.effector.dev/rules/enforce-effect-naming-convention
+   */
+  'effector/enforce-effect-naming-convention'?: Linter.RuleEntry<[]>;
+  /**
+   * Enforce first capital letter for gate naming
+   * @see https://eslint.effector.dev/rules/enforce-gate-naming-convention
+   */
+  'effector/enforce-gate-naming-convention'?: Linter.RuleEntry<[]>;
+  /**
+   * Enforce $ as a prefix or postfix for any store created by Effector methods
+   * @see https://eslint.effector.dev/rules/enforce-store-naming-convention
+   */
+  'effector/enforce-store-naming-convention'?: Linter.RuleEntry<[]>;
+  /**
+   * Enforce options order for Effector methods
+   * @see https://eslint.effector.dev/rules/keep-options-order
+   */
+  'effector/keep-options-order'?: Linter.RuleEntry<[]>;
+  /**
+   * Forbids `Event` and `Effect` usage without `useUnit` in React components.
+   * @see https://eslint.effector.dev/rules/mandatory-scope-binding
+   */
+  'effector/mandatory-scope-binding'?: Linter.RuleEntry<[]>;
+  /**
+   * Forbids ambiguity targets in `sample` and `guard`
+   * @see https://eslint.effector.dev/rules/no-ambiguity-target
+   */
+  'effector/no-ambiguity-target'?: Linter.RuleEntry<[]>;
+  /**
+   * Forbids unit duplicates on `source` and `clock``
+   * @see https://eslint.effector.dev/rules/no-duplicate-clock-or-source-array-values
+   */
+  'effector/no-duplicate-clock-or-source-array-values'?: Linter.RuleEntry<[]>;
+  /**
+   * Forbids duplicate `.on` calls on store
+   * @see https://eslint.effector.dev/rules/no-duplicate-on
+   */
+  'effector/no-duplicate-on'?: Linter.RuleEntry<[]>;
+  /**
+   * Prefer `sample` over `forward`
+   * @see https://eslint.effector.dev/rules/no-forward
+   */
+  'effector/no-forward'?: Linter.RuleEntry<[]>;
+  /**
+   * Forbids `.getState` calls on any Effector store
+   * @see https://eslint.effector.dev/rules/no-getState
+   */
+  'effector/no-getState'?: Linter.RuleEntry<[]>;
+  /**
+   * Prefer `sample` over `guard`
+   * @see https://eslint.effector.dev/rules/no-guard
+   */
+  'effector/no-guard'?: Linter.RuleEntry<[]>;
+  /**
+   * Disallow the use of patronum `debug`
+   * @see https://eslint.effector.dev/rules/no-patronum-debug
+   */
+  'effector/no-patronum-debug'?: Linter.RuleEntry<[]>;
+  /**
+   * Forbids unnecessary combinations in `clock`, `source` and `forward`
+   * @see https://eslint.effector.dev/rules/no-unnecessary-combination
+   */
+  'effector/no-unnecessary-combination'?: Linter.RuleEntry<[]>;
+  /**
+   * Forbids unnecessary duplication in `clock` and `source`
+   * @see https://eslint.effector.dev/rules/no-unnecessary-duplication
+   */
+  'effector/no-unnecessary-duplication'?: Linter.RuleEntry<[]>;
+  /**
+   * Forbids useless calls of `sample` and `guard`
+   * @see https://eslint.effector.dev/rules/no-useless-methods
+   */
+  'effector/no-useless-methods'?: Linter.RuleEntry<[]>;
+  /**
+   * Avoid `.watch` calls on any Effector unit or operator
+   * @see https://eslint.effector.dev/rules/no-watch
+   */
+  'effector/no-watch'?: Linter.RuleEntry<[]>;
+  /**
+   * Prefer `sample` over `forward` with `.map`/`.prepend`
+   * @see https://eslint.effector.dev/rules/prefer-sample-over-forward-with-mapping
+   */
+  'effector/prefer-sample-over-forward-with-mapping'?: Linter.RuleEntry<[]>;
+  /**
+   * Suggests to replace old hooks `useStore`/`useEvent` by the new one `useUnit`
+   * @see https://eslint.effector.dev/rules/prefer-useUnit
+   */
+  'effector/prefer-useUnit'?: Linter.RuleEntry<[]>;
+  /**
+   * @see https://eslint.effector.dev/rules/require-pickup-in-persist
+   */
+  'effector/require-pickup-in-persist'?: Linter.RuleEntry<[]>;
+  /**
+   * Forbids mix of async functions and effects calls in effect handlers.
+   * @see https://eslint.effector.dev/rules/strict-effect-handlers
+   */
+  'effector/strict-effect-handlers'?: Linter.RuleEntry<[]>;
   /**
    * Require or disallow newline at the end of files
    * @see https://eslint.org/docs/latest/rules/eol-last
@@ -12794,7 +12893,7 @@ type Yoda = [] | [("always" | "never")] | [("always" | "never"), {
   onlyEquality?: boolean;
 }];
 // Names of all the configs
-type ConfigNames = 'eslint-comments/rules' | 'formatter/setup' | 'imports/rules' | 'javascript/setup' | 'javascript/rules' | 'jsx/setup' | 'jsonc/setup' | 'jsonc/rules' | 'markdown/setup' | 'markdown/processor' | 'markdown/parser' | 'markdown/disables' | 'node/rules' | 'perfectionist/setup' | 'pnpm/package-json' | 'pnpm/pnpm-workspace-yaml' | 'react/setup' | 'react/rules' | 'sort/package-json' | 'stylistic/rules' | 'toml/setup' | 'toml/rules' | 'regexp/rules' | 'typescript/setup' | 'typescript/parser' | 'typescript/rules' | 'unicorn/rules' | 'unocss' | 'yaml/setup' | 'yaml/rules' | 'yaml/pnpm-workspace' | 'next/rules' | 'jsx-a11y/rules';
+type ConfigNames = 'eslint-comments/rules' | 'formatter/setup' | 'imports/rules' | 'javascript/setup' | 'javascript/rules' | 'jsx/setup' | 'jsonc/setup' | 'jsonc/rules' | 'markdown/setup' | 'markdown/processor' | 'markdown/parser' | 'markdown/disables' | 'node/rules' | 'perfectionist/setup' | 'pnpm/package-json' | 'pnpm/pnpm-workspace-yaml' | 'react/setup' | 'react/rules' | 'sort/package-json' | 'stylistic/rules' | 'toml/setup' | 'toml/rules' | 'regexp/rules' | 'typescript/setup' | 'typescript/parser' | 'typescript/rules' | 'unicorn/rules' | 'unocss' | 'yaml/setup' | 'yaml/rules' | 'yaml/pnpm-workspace' | 'next/rules' | 'jsx-a11y/rules' | 'effector/setup' | 'effector/rules';
 //#endregion
 //#region src/vendor/prettier-types.d.ts
 /**
@@ -12989,6 +13088,32 @@ interface OptionsUnicorn extends OptionsOverrides {
    */
   allRecommended?: boolean;
 }
+interface OptionsEffector extends OptionsOverrides {
+  /**
+   * Include react rules.
+   *
+   * @default auto-detect based on the dependencies
+   */
+  react?: boolean;
+  /**
+   * Include patronum rules.
+   *
+   * @default auto-detect based on the dependencies
+   */
+  patronum?: boolean;
+  /**
+   * Include future rules.
+   *
+   * @default false
+   */
+  future?: boolean;
+  /**
+   * Include scope rules.
+   *
+   * @default false
+   */
+  scope?: boolean;
+}
 interface OptionsTypeScriptParserOptions {
   /**
    * Additional parser options for TypeScript.
@@ -13149,6 +13274,15 @@ interface OptionsConfig extends OptionsComponentExts, OptionsProjectType {
    * @default auto-detect based on the dependencies
    */
   next?: boolean | OptionsOverrides;
+  /**
+   * Enable effector rules.
+   *
+   * Requires installing:
+   * - `eslint-plugin-effector`
+   *
+   * @default auto-detect based on the dependencies
+   */
+  effector?: boolean | OptionsEffector;
   /**
    * Enable unocss rules.
    *
@@ -13241,6 +13375,9 @@ declare function comments(): Promise<TypedFlatConfigItem[]>;
 //#region src/configs/disables.d.ts
 declare function disables(): Promise<TypedFlatConfigItem[]>;
 //#endregion
+//#region src/configs/effector.d.ts
+declare function effector(options?: OptionsEffector): Promise<TypedFlatConfigItem[]>;
+//#endregion
 //#region src/configs/formatters.d.ts
 declare function formatters(options?: OptionsFormatters | true, stylistic?: StylisticConfig): Promise<TypedFlatConfigItem[]>;
 //#endregion
@@ -13404,4 +13541,4 @@ declare function ensurePackages(packages: (string | undefined)[]): Promise<void>
 declare function isInEditorEnv(): boolean;
 declare function isInGitHooksOrLintStaged(): boolean;
 //#endregion
-export { Awaitable, ConfigNames, GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVG, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_XML, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsFiles, OptionsFormatters, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsProjectType, OptionsRegExp, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, OptionsTypescript, OptionsUnicorn, OptionsUnoCSS, ResolvedOptions, Rules, StylisticConfig, StylisticConfigDefaults, StylisticOptions, TypedFlatConfigItem, combine, comments, config, config as default, defaultPluginRenaming, disables, ensurePackages, formatters, getOverrides, ignores, imports, interopDefault, isInEditorEnv, isInGitHooksOrLintStaged, isPackageInScope, javascript, jsonc, jsx, jsxA11y, markdown, next, node, parserPlain, perfectionist, pnpm, react, regexp, renameRules, resolveSubOptions, sortPackageJson, sortTsconfig, stylistic, toml, typescript, unicorn, unocss, yaml };
+export { Awaitable, ConfigNames, GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVG, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_XML, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsEffector, OptionsFiles, OptionsFormatters, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsProjectType, OptionsRegExp, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, OptionsTypescript, OptionsUnicorn, OptionsUnoCSS, ResolvedOptions, Rules, StylisticConfig, StylisticConfigDefaults, StylisticOptions, TypedFlatConfigItem, combine, comments, config, config as default, defaultPluginRenaming, disables, effector, ensurePackages, formatters, getOverrides, ignores, imports, interopDefault, isInEditorEnv, isInGitHooksOrLintStaged, isPackageInScope, javascript, jsonc, jsx, jsxA11y, markdown, next, node, parserPlain, perfectionist, pnpm, react, regexp, renameRules, resolveSubOptions, sortPackageJson, sortTsconfig, stylistic, toml, typescript, unicorn, unocss, yaml };

package/dist/index.js

@@ -125,6 +125,18 @@ async function disables() {
 	];
 }
 
+//#endregion
+//#region src/constants.ts
+const ReactPackages = ["react", "nest"];
+const ReactRefreshAllowConstantExportPackages = ["vite"];
+const ReactRouterPackages = [
+	"@react-router/node",
+	"@react-router/react",
+	"@react-router/serve",
+	"@react-router/dev"
+];
+const NextJsPackages = ["next"];
+
 //#endregion
 //#region src/utils.ts
 const scopeUrl = fileURLToPath(new URL(".", import.meta.url));
@@ -203,6 +215,49 @@ function isInGitHooksOrLintStaged() {
 	return !!(process.env.GIT_PARAMS || process.env.VSCODE_GIT_COMMAND || process.env.npm_lifecycle_script?.startsWith("lint-staged"));
 }
 
+//#endregion
+//#region src/configs/effector.ts
+async function effector(options = {}) {
+	const { future = false, overrides = {}, patronum = isPackageExists("patronum"), react: react$1 = ReactPackages.some((i) => isPackageExists(i)), scope = false } = options;
+	await ensurePackages(["eslint-plugin-effector"]);
+	const [pluginEffector] = await Promise.all([interopDefault(import("eslint-plugin-effector"))]);
+	return [{
+		name: "effector/setup",
+		plugins: { effector: pluginEffector }
+	}, {
+		name: "effector/rules",
+		rules: {
+			"effector/enforce-effect-naming-convention": "error",
+			"effector/enforce-store-naming-convention": "error",
+			"effector/keep-options-order": "warn",
+			"effector/no-ambiguity-target": "warn",
+			"effector/no-duplicate-on": "error",
+			"effector/no-getState": "error",
+			"effector/no-unnecessary-combination": "warn",
+			"effector/no-unnecessary-duplication": "warn",
+			"effector/no-useless-methods": "error",
+			"effector/no-watch": "warn",
+			"effector/prefer-sample-over-forward-with-mapping": "warn",
+			...react$1 ? {
+				"effector/enforce-gate-naming-convention": "error",
+				"effector/mandatory-scope-binding": "error",
+				"effector/prefer-useUnit": "warn"
+			} : {},
+			...patronum ? { "effector/no-patronum-debug": "error" } : {},
+			...scope ? {
+				"effector/require-pickup-in-persist": "error",
+				"effector/strict-effect-handlers": "error"
+			} : {},
+			...future ? {
+				"effector/no-forward": "warn",
+				"effector/no-guard": "warn",
+				"effector/prefer-sample-over-forward-with-mapping": "off"
+			} : {},
+			...overrides
+		}
+	}];
+}
+
 //#endregion
 //#region src/configs/stylistic.ts
 const StylisticConfigDefaults = {
@@ -687,12 +742,11 @@ async function jsx() {
 
 //#endregion
 //#region src/configs/jsx-a11y.ts
-const NextJsPackages$1 = ["next"];
-const isUsingNext = NextJsPackages$1.some((i) => isPackageExists(i));
 async function jsxA11y(options = {}) {
 	const { overrides = {} } = options;
 	await ensurePackages(["eslint-plugin-jsx-a11y"]);
 	const [pluginJsxA11y] = await Promise.all([interopDefault(import("eslint-plugin-jsx-a11y"))]);
+	const isUsingNext = NextJsPackages.some((i) => isPackageExists(i));
 	return [{
 		name: "jsx-a11y/rules",
 		plugins: { "jsx-a11y": pluginJsxA11y },
@@ -908,14 +962,6 @@ async function pnpm() {
 
 //#endregion
 //#region src/configs/react.ts
-const ReactRefreshAllowConstantExportPackages = ["vite"];
-const ReactRouterPackages = [
-	"@react-router/node",
-	"@react-router/react",
-	"@react-router/serve",
-	"@react-router/dev"
-];
-const NextJsPackages = ["next"];
 async function react(options = {}) {
 	const { files = [GLOB_SRC], filesTypeAware = [GLOB_TS, GLOB_TSX], ignoresTypeAware = [`${GLOB_MARKDOWN}/**`], overrides = {}, tsconfigPath } = options;
 	const isTypeAware = !!tsconfigPath;
@@ -927,7 +973,7 @@ async function react(options = {}) {
 	]);
 	const isAllowConstantExport = ReactRefreshAllowConstantExportPackages.some((i) => isPackageExists(i));
 	const isUsingReactRouter = ReactRouterPackages.some((i) => isPackageExists(i));
-	const isUsingNext$1 = NextJsPackages.some((i) => isPackageExists(i));
+	const isUsingNext = NextJsPackages.some((i) => isPackageExists(i));
 	const plugins = pluginReact.configs.all.plugins;
 	return [
 		{
@@ -1014,7 +1060,7 @@ async function react(options = {}) {
 				"react-web-api/no-leaked-timeout": "warn",
 				"react-refresh/only-export-components": ["warn", {
 					allowConstantExport: isAllowConstantExport,
-					allowExportNames: [...isUsingNext$1 ? [
+					allowExportNames: [...isUsingNext ? [
 						"dynamic",
 						"dynamicParams",
 						"revalidate",
@@ -1604,7 +1650,6 @@ const flatConfigProps = [
 	"rules",
 	"settings"
 ];
-const ReactPackages = ["react", "nest"];
 const defaultPluginRenaming = {
 	"@eslint-react": "react",
 	"@eslint-react/dom": "react-dom",
@@ -1627,7 +1672,8 @@ const defaultPluginRenaming = {
 *  The merged ESLint configurations.
 */
 function config(options = {}, ...userConfigs) {
-	const { autoRenamePlugins = true, componentExts = [], gitignore: enableGitignore = true, jsx: enableJsx = true, jsxA11y: enableJsxA11y = ReactPackages.some((i) => isPackageExists(i)), next: enableNext = isPackageExists("next"), pnpm: enableCatalogs = false, react: enableReact = ReactPackages.some((i) => isPackageExists(i)), regexp: enableRegexp = true, typescript: enableTypeScript = isPackageExists("typescript"), unicorn: enableUnicorn = true, unocss: enableUnoCSS = false } = options;
+	const isUsingReact = ReactPackages.some((i) => isPackageExists(i));
+	const { autoRenamePlugins = true, componentExts = [], effector: enableEffector = isPackageExists("effector"), gitignore: enableGitignore = true, jsx: enableJsx = true, jsxA11y: enableJsxA11y = isUsingReact, next: enableNext = NextJsPackages.some((i) => isPackageExists(i)), pnpm: enableCatalogs = false, react: enableReact = isUsingReact, regexp: enableRegexp = true, typescript: enableTypeScript = isPackageExists("typescript"), unicorn: enableUnicorn = true, unocss: enableUnoCSS = false } = options;
 	let isInEditor = options.isInEditor;
 	if (isInEditor == null) {
 		isInEditor = isInEditorEnv();
@@ -1670,6 +1716,10 @@ function config(options = {}, ...userConfigs) {
 	}));
 	if (enableJsxA11y) configs$1.push(jsxA11y({ overrides: getOverrides(options, "jsxA11y") }));
 	if (enableNext) configs$1.push(next({ overrides: getOverrides(options, "next") }));
+	if (enableEffector) configs$1.push(effector({
+		...resolveSubOptions(options, "effector"),
+		overrides: getOverrides(options, "effector")
+	}));
 	if (enableUnoCSS) configs$1.push(unocss({
 		...resolveSubOptions(options, "unocss"),
 		overrides: getOverrides(options, "unocss")
@@ -1721,4 +1771,4 @@ function getOverrides(options, key) {
 var src_default = config;
 
 //#endregion
-export { GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVG, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_XML, GLOB_YAML, StylisticConfigDefaults, combine, comments, config, src_default as default, defaultPluginRenaming, disables, ensurePackages, formatters, getOverrides, ignores, imports, interopDefault, isInEditorEnv, isInGitHooksOrLintStaged, isPackageInScope, javascript, jsonc, jsx, jsxA11y, markdown, next, node, parserPlain, perfectionist, pnpm, react, regexp, renameRules, resolveSubOptions, sortPackageJson, sortTsconfig, stylistic, toml, typescript, unicorn, unocss, yaml };
+export { GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVG, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_XML, GLOB_YAML, StylisticConfigDefaults, combine, comments, config, src_default as default, defaultPluginRenaming, disables, effector, ensurePackages, formatters, getOverrides, ignores, imports, interopDefault, isInEditorEnv, isInGitHooksOrLintStaged, isPackageInScope, javascript, jsonc, jsx, jsxA11y, markdown, next, node, parserPlain, perfectionist, pnpm, react, regexp, renameRules, resolveSubOptions, sortPackageJson, sortTsconfig, stylistic, toml, typescript, unicorn, unocss, yaml };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ghettoddos/eslint-config",
   "type": "module",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "ghettoDdOS ESLint config",
   "author": "ghettoDdOS <pen.egor2002@gamil.com> (https://github.com/ghettoDdOS/)",
   "license": "MIT",
@@ -29,6 +29,7 @@
     "@prettier/plugin-xml": "^3.4.1",
     "@unocss/eslint-plugin": ">=0.50.0",
     "eslint": "^9.10.0",
+    "eslint-plugin-effector": "^0.15.0",
     "eslint-plugin-format": ">=0.1.0",
     "eslint-plugin-jsx-a11y": "^6.10.2"
   },
@@ -42,6 +43,9 @@
     "@unocss/eslint-plugin": {
       "optional": true
     },
+    "eslint-plugin-effector": {
+      "optional": true
+    },
     "eslint-plugin-format": {
       "optional": true
     },
@@ -89,6 +93,7 @@
     "@unocss/eslint-plugin": "66.1.0-beta.3",
     "bumpp": "^10.1.1",
     "eslint": "^9.27.0",
+    "eslint-plugin-effector": "^0.15.0",
     "eslint-plugin-format": "^1.0.1",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-typegen": "^2.2.0",