@ghettoddos/eslint-config 1.5.1 → 1.6.0

package/dist/index.d.ts

@@ -117,6 +117,41 @@ interface RuleOptions {
    * @deprecated
    */
   'block-spacing'?: Linter.RuleEntry<BlockSpacing>;
+  /**
+   * Check allowed dependencies between element types
+   * @see https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/element-types.md
+   */
+  'boundaries/element-types'?: Linter.RuleEntry<BoundariesElementTypes>;
+  /**
+   * Check entry point used for each element type
+   * @see https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/entry-point.md
+   */
+  'boundaries/entry-point'?: Linter.RuleEntry<BoundariesEntryPoint>;
+  /**
+   * Check allowed external dependencies by element type
+   * @see https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/external.md
+   */
+  'boundaries/external'?: Linter.RuleEntry<BoundariesExternal>;
+  /**
+   * Prevent importing ignored files from recognized elements
+   * @see https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/no-ignored.md
+   */
+  'boundaries/no-ignored'?: Linter.RuleEntry<[]>;
+  /**
+   * Prevent importing private elements of another element
+   * @see https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/no-private.md
+   */
+  'boundaries/no-private'?: Linter.RuleEntry<BoundariesNoPrivate>;
+  /**
+   * Prevent importing unknown elements from the known ones
+   * @see https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/no-unknown.md
+   */
+  'boundaries/no-unknown'?: Linter.RuleEntry<[]>;
+  /**
+   * Prevent creating files not recognized as any of the element types
+   * @see https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/no-unknown-files.md
+   */
+  'boundaries/no-unknown-files'?: Linter.RuleEntry<[]>;
   /**
    * Enforce consistent brace style for blocks
    * @see https://eslint.org/docs/latest/rules/brace-style
@@ -5966,6 +6001,47 @@ type ArrowSpacing = [] | [{
 }];
 // ----- block-spacing -----
 type BlockSpacing = [] | [("always" | "never")];
+// ----- boundaries/element-types -----
+type BoundariesElementTypes = [] | [{
+  message?: string;
+  default?: ("allow" | "disallow");
+  rules?: ({
+    [k: string]: unknown | undefined;
+  } | {
+    [k: string]: unknown | undefined;
+  } | {
+    [k: string]: unknown | undefined;
+  })[];
+}];
+// ----- boundaries/entry-point -----
+type BoundariesEntryPoint = [] | [{
+  message?: string;
+  default?: ("allow" | "disallow");
+  rules?: ({
+    [k: string]: unknown | undefined;
+  } | {
+    [k: string]: unknown | undefined;
+  } | {
+    [k: string]: unknown | undefined;
+  })[];
+}];
+// ----- boundaries/external -----
+type BoundariesExternal = [] | [{
+  message?: string;
+  default?: ("allow" | "disallow");
+  rules?: ({
+    [k: string]: unknown | undefined;
+  } | {
+    [k: string]: unknown | undefined;
+  } | {
+    [k: string]: unknown | undefined;
+  })[];
+}];
+// ----- boundaries/no-private -----
+type BoundariesNoPrivate = [] | [{
+  allowUncles?: boolean;
+  message?: string;
+}];
 // ----- brace-style -----
 type BraceStyle = [] | [("1tbs" | "stroustrup" | "allman")] | [("1tbs" | "stroustrup" | "allman"), {
   allowSingleLine?: boolean;
@@ -12893,7 +12969,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' | 'effector/setup' | 'effector/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' | 'fsd/setup' | 'fsd/public-api' | 'fsd/layers-slices';
 //#endregion
 //#region src/vendor/prettier-types.d.ts
 /**
@@ -13180,6 +13256,27 @@ interface OptionsUnoCSS extends OptionsOverrides {
    */
   strict?: boolean;
 }
+interface OptionsFSDPublicApi extends OptionsOverrides {
+  /**
+   * Without SegmentsAPI / InnerAPI restrictions.
+   * @default true
+   */
+  lite?: boolean;
+}
+interface OptionsFSD {
+  /**
+   * FSD Public API rules.
+   * @see https://github.com/feature-sliced/eslint-config/tree/master/rules/public-api
+   * @default true
+   */
+  publicApi?: boolean | OptionsFSDPublicApi;
+  /**
+   * FSD Layers slices rules.
+   * @see https://github.com/feature-sliced/eslint-config/tree/master/rules/layers-slices
+   * @default true
+   */
+  layersSlices?: boolean | OptionsOverrides;
+}
 interface OptionsConfig extends OptionsComponentExts, OptionsProjectType {
   /**
    * Enable gitignore support.
@@ -13303,6 +13400,13 @@ interface OptionsConfig extends OptionsComponentExts, OptionsProjectType {
    * @default false
    */
   pnpm?: boolean;
+  /**
+   * Enable FSD rules.
+   *
+   * @see https://feature-sliced.github.io/
+   * @default false
+   */
+  fsd?: boolean | OptionsFSD;
   /**
    * Use external formatters to format files.
    *
@@ -13365,9 +13469,6 @@ declare const defaultPluginRenaming: {
  *  The merged ESLint configurations.
  */
 declare function config(options?: OptionsConfig & Omit<TypedFlatConfigItem, 'files'>, ...userConfigs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<any, any> | Linter.Config[]>[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
-type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
-declare function resolveSubOptions<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): ResolvedOptions<OptionsConfig[K]>;
-declare function getOverrides<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): Partial<Linter.RulesRecord & RuleOptions>;
 //#endregion
 //#region src/configs/comments.d.ts
 declare function comments(): Promise<TypedFlatConfigItem[]>;
@@ -13381,6 +13482,9 @@ declare function effector(options?: OptionsEffector): Promise<TypedFlatConfigIte
 //#region src/configs/formatters.d.ts
 declare function formatters(options?: OptionsFormatters | true, stylistic?: StylisticConfig): Promise<TypedFlatConfigItem[]>;
 //#endregion
+//#region src/configs/fsd.d.ts
+declare function fsd(options?: OptionsFSD): Promise<TypedFlatConfigItem[]>;
+//#endregion
 //#region src/configs/ignores.d.ts
 declare function ignores(userIgnores?: string[]): Promise<TypedFlatConfigItem[]>;
 //#endregion
@@ -13540,5 +13644,8 @@ declare function isPackageInScope(name: string): boolean;
 declare function ensurePackages(packages: (string | undefined)[]): Promise<void>;
 declare function isInEditorEnv(): boolean;
 declare function isInGitHooksOrLintStaged(): boolean;
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+declare function resolveSubOptions<C extends Record<string, any>, K extends keyof C>(options: C, key: K): ResolvedOptions<C[K]>;
+declare function getOverrides<C extends Record<string, any>, K extends keyof C>(options: C, key: K): Partial<Linter.RulesRecord & RuleOptions>;
 //#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, 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 };
+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, OptionsFSD, OptionsFSDPublicApi, 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, fsd, 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

@@ -215,6 +215,16 @@ function isInEditorEnv() {
 function isInGitHooksOrLintStaged() {
 	return !!(process.env.GIT_PARAMS || process.env.VSCODE_GIT_COMMAND || process.env.npm_lifecycle_script?.startsWith("lint-staged"));
 }
+function resolveSubOptions(options, key) {
+	return typeof options[key] === "boolean" ? {} : options[key] || {};
+}
+function getOverrides(options, key) {
+	const sub = resolveSubOptions(options, key);
+	return {
+		...options.overrides?.[key],
+		..."overrides" in sub ? sub.overrides : {}
+	};
+}
 
 //#endregion
 //#region src/configs/effector.ts
@@ -404,6 +414,118 @@ async function formatters(options = {}, stylistic$1 = {}) {
 	return configs$1;
 }
 
+//#endregion
+//#region src/configs/fsd.ts
+const FS_LAYERS = [
+	"app",
+	"processes",
+	"pages",
+	"widgets",
+	"features",
+	"entities",
+	"shared"
+];
+const FS_SEGMENTS = [
+	"ui",
+	"model",
+	"lib",
+	"api",
+	"config",
+	"assets"
+];
+function getLowerLayers(layer) {
+	return FS_LAYERS.slice(FS_LAYERS.indexOf(layer) + 1);
+}
+function getUpperLayers(layer) {
+	return FS_LAYERS.slice(0, FS_LAYERS.indexOf(layer));
+}
+const FS_SLICED_LAYERS_REG = getUpperLayers("shared").join("|");
+const FS_SEGMENTS_REG = [...FS_SEGMENTS, ...FS_SEGMENTS.map((seg) => `${seg}.*`)].join("|");
+function getNotSharedLayersRules() {
+	return getUpperLayers("shared").map((layer) => ({
+		allow: getLowerLayers(layer),
+		from: layer
+	}));
+}
+const slicelessLayerRules = [{
+	allow: "shared",
+	from: "shared"
+}, {
+	allow: "app",
+	from: "app"
+}];
+function getLayersBoundariesElements() {
+	return FS_LAYERS.map((layer) => ({
+		capture: ["slices"],
+		mode: "folder",
+		pattern: `${layer}/!(_*){,/*}`,
+		type: layer
+	}));
+}
+function getGodModeRules() {
+	return FS_LAYERS.map((layer) => ({
+		allow: [layer, ...getLowerLayers(layer)],
+		from: `gm_${layer}`
+	}));
+}
+function getGodModeElements() {
+	return FS_LAYERS.map((layer) => ({
+		capture: ["slices"],
+		mode: "folder",
+		pattern: `${layer}/_*`,
+		type: `gm_${layer}`
+	}));
+}
+async function fsd(options = {}) {
+	const { layersSlices: enableLayersSlices = true, publicApi: enablePublicApi = true } = options;
+	const configs$1 = [{
+		name: "fsd/setup",
+		plugins: { "eslint-comments": pluginComments }
+	}];
+	if (enablePublicApi) {
+		const { lite = true } = resolveSubOptions(options, "publicApi");
+		configs$1.push({
+			name: "fsd/public-api",
+			rules: {
+				"import/no-internal-modules": ["error", { allow: [
+					`**/*(${FS_SLICED_LAYERS_REG})/!(${FS_SEGMENTS_REG})`,
+					`**/*(${FS_SLICED_LAYERS_REG})/!(${FS_SEGMENTS_REG})/!(${FS_SEGMENTS_REG})`,
+					`**/*shared/*(${FS_SEGMENTS_REG})/!(${FS_SEGMENTS_REG})`,
+					`**/*shared/*(${FS_SEGMENTS_REG})`,
+					`**/node_modules/**`,
+					`**/*shared/_*`,
+					`**/*shared/_*/*`,
+					...lite ? [`./**`] : []
+				] }],
+				...getOverrides(options, "publicApi")
+			}
+		});
+	}
+	if (enableLayersSlices) {
+		ensurePackages(["eslint-plugin-boundaries"]);
+		const [pluginBoundaries] = await Promise.all([interopDefault(import("eslint-plugin-boundaries"))]);
+		configs$1.push({
+			name: "fsd/layers-slices",
+			plugins: { boundaries: pluginBoundaries },
+			rules: {
+				...pluginBoundaries.configs.recommended.rules,
+				"boundaries/element-types": [2, {
+					default: "disallow",
+					message: "\"${file.type}\" is not allowed to import \"${dependency.type}\" | See rules: https://feature-sliced.design/docs/reference/layers/overview ",
+					rules: [
+						...getNotSharedLayersRules(),
+						...slicelessLayerRules,
+						...getGodModeRules()
+					]
+				}],
+				...getOverrides(options, "layersSlices")
+			},
+			settings: { "boundaries/elements": [...getLayersBoundariesElements(), ...getGodModeElements()] }
+		});
+	}
+	return configs$1;
+}
+
 //#endregion
 //#region src/configs/ignores.ts
 async function ignores(userIgnores = []) {
@@ -1674,7 +1796,7 @@ const defaultPluginRenaming = {
 */
 function config(options = {}, ...userConfigs) {
 	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;
+	const { autoRenamePlugins = true, componentExts = [], effector: enableEffector = isPackageExists("effector"), fsd: enableFsd = false, 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();
@@ -1717,6 +1839,7 @@ 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 (enableFsd) configs$1.push(fsd({ ...resolveSubOptions(options, "fsd") }));
 	if (enableEffector) configs$1.push(effector({
 		...resolveSubOptions(options, "effector"),
 		overrides: getOverrides(options, "effector")
@@ -1756,20 +1879,10 @@ function config(options = {}, ...userConfigs) {
 	if (isInEditor) composer = composer.disableRulesFix(["unused-imports/no-unused-imports", "prefer-const"], { builtinRules: () => import(["eslint", "use-at-your-own-risk"].join("/")).then((r) => r.builtinRules) });
 	return composer;
 }
-function resolveSubOptions(options, key) {
-	return typeof options[key] === "boolean" ? {} : options[key] || {};
-}
-function getOverrides(options, key) {
-	const sub = resolveSubOptions(options, key);
-	return {
-		...options.overrides?.[key],
-		..."overrides" in sub ? sub.overrides : {}
-	};
-}
 
 //#endregion
 //#region src/index.ts
 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, 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 };
+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, fsd, 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.5.1",
+  "version": "1.6.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-boundaries": "^5.0.1",
     "eslint-plugin-effector": "^0.15.0",
     "eslint-plugin-format": ">=0.1.0",
     "eslint-plugin-jsx-a11y": "^6.10.2"
@@ -43,6 +44,9 @@
     "@unocss/eslint-plugin": {
       "optional": true
     },
+    "eslint-plugin-boundaries": {
+      "optional": true
+    },
     "eslint-plugin-effector": {
       "optional": true
     },
@@ -94,6 +98,7 @@
     "@unocss/eslint-plugin": "66.1.0-beta.3",
     "bumpp": "^10.1.1",
     "eslint": "^9.27.0",
+    "eslint-plugin-boundaries": "^5.0.1",
     "eslint-plugin-effector": "^0.15.0",
     "eslint-plugin-format": "^1.0.1",
     "eslint-plugin-jsx-a11y": "^6.10.2",