eslint-config-mgz 1.0.0

package/README.md

@@ -0,0 +1,444 @@
+# eslint-config-mgz
+
+Shared ESLint configuration for React + TypeScript projects
+
+---
+
+## 🇷🇺 Русский
+
+### 📦 Описание
+
+`eslint-config-mgz` — это переиспользуемая конфигурация ESLint
+для frontend проектов с React и TypeScript:
+
+- ✅ **TypeScript** поддержка с `@typescript-eslint`
+- ✅ **React** правила и хуки
+- ✅ **Import** правила для модулей
+- ✅ **JSX accessibility** проверки
+- ✅ **Prettier** интеграция (отключает конфликтующие правила)
+
+Цель пакета — стандартизировать линтинг во всех проектах и обеспечить качество кода.
+
+---
+
+### 📂 Содержимое пакета
+
+| Файл             | Назначение                          |
+| ---------------- | ----------------------------------- |
+| `base.js`        | Основная конфигурация ESLint (v7-8) |
+| `flat-config.js` | Flat config для ESLint v9+          |
+
+---
+
+### 🚀 Установка
+
+```bash
+# ESLint v7-8 (обязательные)
+npm install -D eslint-config-mgz eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-import eslint-plugin-jsx-a11y eslint-config-prettier
+
+# ESLint v9+ (обязательные + опциональные)
+npm install -D eslint-config-mgz eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-import eslint-plugin-jsx-a11y eslint-config-prettier @eslint/js typescript-eslint
+```
+
+```bash
+# ESLint v7-8 (обязательные)
+pnpm add -D eslint-config-mgz eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-import eslint-plugin-jsx-a11y eslint-config-prettier
+
+# ESLint v9+ (обязательные + опциональные)
+pnpm add -D eslint-config-mgz eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-import eslint-plugin-jsx-a11y eslint-config-prettier @eslint/js typescript-eslint
+```
+
+```bash
+# ESLint v7-8 (обязательные)
+yarn add -D eslint-config-mgz eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-import eslint-plugin-jsx-a11y eslint-config-prettier
+
+# ESLint v9+ (обязательные + опциональные)
+yarn add -D eslint-config-mgz eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-import eslint-plugin-jsx-a11y eslint-config-prettier @eslint/js typescript-eslint
+```
+
+---
+
+## 🚨 **Совместимость с ESLint**
+
+### 📊 **Таблица совместимости:**
+
+| ESLint версия | Совместимость | Конфиг файл       | Примечания              |
+| ------------- | ------------- | ----------------- | ----------------------- |
+| **v7.x**      | ✅ Полная     | `.eslintrc.*`     | Рекомендуется           |
+| **v8.x**      | ✅ Полная     | `.eslintrc.*`     | Рекомендуется           |
+| **v9.x**      | ✅ Полная     | `eslint.config.*` | Используйте flat-config |
+
+### 🧩 Использование
+
+#### В .eslintrc.js
+
+```javascript
+module.exports = {
+  extends: ["eslint-config-mgz"],
+  parserOptions: {
+    project: "./tsconfig.json",
+  },
+};
+```
+
+#### В .eslintrc.json
+
+```json
+{
+  "extends": ["eslint-config-mgz"],
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  }
+}
+```
+
+#### С дополнительными правилами
+
+```javascript
+module.exports = {
+  extends: ["eslint-config-mgz"],
+  rules: {
+    // Ваши дополнительные правила
+    "no-console": "warn",
+    "@typescript-eslint/no-unused-vars": "error",
+  },
+  parserOptions: {
+    project: "./tsconfig.json",
+  },
+};
+```
+
+#### Для ESLint v9+ (Flat Config)
+
+```javascript
+// eslint.config.js
+import config from "eslint-config-mgz/flat-config";
+
+export default config;
+```
+
+Или с дополнительными правилами:
+
+```javascript
+// eslint.config.js
+import { FlatCompat } from "@eslint/eslintrc";
+import baseConfig from "eslint-config-mgz";
+
+const compat = new FlatCompat();
+export default [
+  ...compat.config(baseConfig),
+  {
+    rules: {
+      // Ваши дополнительные правила
+      "no-console": "warn",
+    },
+  },
+];
+```
+
+#### Для старых версий ESLint (v7-8)
+
+```bash
+# Принудительное использование старого формата в v9
+npx eslint --config .eslintrc.js src/
+```
+
+---
+
+### 🧠 Включенные правила
+
+#### **ESLint Recommended**
+
+- Базовые правила JavaScript
+
+#### **TypeScript ESLint**
+
+- Правила для TypeScript кода
+- Строгая типизация
+- Лучшие практики TS
+
+#### **React ESLint**
+
+- Правила для React компонентов
+- React Hooks правила
+- JSX правила
+
+#### **Import ESLint**
+
+- Правила импортов модулей
+- Проверка путей импорта
+
+#### **JSX Accessibility**
+
+- Доступность JSX элементов
+- WCAG рекомендации
+
+#### **Prettier Integration**
+
+- Отключение конфликтующих правил
+- Совместимость с prettier
+
+---
+
+### ⚠️ Важные нюансы
+
+- **Peer dependencies**: Все плагины нужно устанавливать отдельно
+- **TypeScript**: Требуется `tsconfig.json` для parserOptions.project
+- **React**: Автоматически определяет версию React
+- **Prettier**: Рекомендуется использовать вместе с prettier-config-mgz
+
+---
+
+### ❓ Возможные вопросы
+
+**Нужен ли tsconfig.json?**
+Да, для правильной работы TypeScript правил нужен файл tsconfig.json.
+
+**Можно ли переопределять правила?**
+Да, добавляйте свои правила в локальном .eslintrc файле.
+
+**Почему некоторые правила отключены?**
+Некоторые правила отключены намеренно для гибкости или из-за конфликтов с другими инструментами.
+
+## 🇬🇧 English
+
+### 📦 Description
+
+`eslint-config-mgz` is a shared ESLint configuration
+for frontend projects with React and TypeScript:
+
+- ✅ **TypeScript** support with `@typescript-eslint`
+- ✅ **React** rules and hooks
+- ✅ **Import** rules for modules
+- ✅ **JSX accessibility** checks
+- ✅ **Prettier** integration (disables conflicting rules)
+
+The goal is to standardize linting across all projects and ensure code quality.
+
+---
+
+### 📂 Package contents
+
+| File             | Purpose                          |
+| ---------------- | -------------------------------- |
+| `base.js`        | Main ESLint configuration (v7-8) |
+| `flat-config.js` | Flat config for ESLint v9+       |
+
+---
+
+### 🚀 Installation
+
+```bash
+npm install -D eslint-config-mgz eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-import eslint-plugin-jsx-a11y eslint-config-prettier
+```
+
+---
+
+## 🚨 **ESLint Compatibility**
+
+### 📊 **Compatibility Table:**
+
+| ESLint Version | Compatibility | Config File       | Notes           |
+| -------------- | ------------- | ----------------- | --------------- |
+| **v7.x**       | ✅ Full       | `.eslintrc.*`     | Recommended     |
+| **v8.x**       | ✅ Full       | `.eslintrc.*`     | Recommended     |
+| **v9.x**       | ✅ Full       | `eslint.config.*` | Use flat-config |
+
+### 🧩 Usage
+
+#### In .eslintrc.js
+
+```javascript
+module.exports = {
+  extends: ["eslint-config-mgz"],
+  parserOptions: {
+    project: "./tsconfig.json",
+  },
+};
+```
+
+#### With additional rules
+
+```javascript
+module.exports = {
+  extends: ["eslint-config-mgz"],
+  rules: {
+    // Your additional rules
+    "no-console": "warn",
+  },
+  parserOptions: {
+    project: "./tsconfig.json",
+  },
+};
+```
+
+#### For ESLint v9+ (Flat Config)
+
+```javascript
+// eslint.config.js
+import config from "eslint-config-mgz/flat-config";
+
+export default config;
+```
+
+Or with additional rules:
+
+```javascript
+// eslint.config.js
+import { FlatCompat } from "@eslint/eslintrc";
+import baseConfig from "eslint-config-mgz";
+
+const compat = new FlatCompat();
+export default [
+  ...compat.config(baseConfig),
+  {
+    rules: {
+      // Your additional rules
+      "no-console": "warn",
+    },
+  },
+];
+```
+
+#### For older ESLint versions (v7-8)
+
+```bash
+# Force old config format in v9
+npx eslint --config .eslintrc.js src/
+```
+
+---
+
+### ⚠️ Important notes
+
+- **Peer dependencies**: All plugins must be installed separately
+- **TypeScript**: Requires `tsconfig.json` for parserOptions.project
+- **React**: Automatically detects React version
+- **Prettier**: Recommended to use with prettier-config-mgz
+
+---
+
+### ❓ Possible questions
+
+**Is tsconfig.json required?**
+Yes, needed for proper TypeScript rules functioning.
+
+**Can rules be overridden?**
+Yes, add your rules in local .eslintrc file.
+
+**Why are some rules disabled?**
+Some rules are intentionally disabled for flexibility or due to conflicts with other tools.
+
+## 🇰🇿 Қазақша
+
+### 📦 Сипаттама
+
+`eslint-config-mgz` — React және TypeScript жобалары үшін
+қайта қолданылатын ESLint конфигурациясы:
+
+- ✅ **TypeScript** `@typescript-eslint` арқылы қолдау
+- ✅ **React** ережелері және хуктары
+- ✅ **Import** модульдердің ережелері
+- ✅ **JSX accessibility** тексерулері
+- ✅ **Prettier** интеграциясы (қайшы келетін ережелерді өшіру)
+
+Мақсаты — барлық жобаларда линтингті стандарттау және код сапасын қамтамасыз ету.
+
+---
+
+### 📂 Пакет құрамында
+
+| Файл             | Мақсаты                       |
+| ---------------- | ----------------------------- |
+| `base.js`        | Негізгі ESLint конфигі (v7-8) |
+| `flat-config.js` | Flat config ESLint v9+ үшін   |
+
+---
+
+### 🚀 Орнату
+
+```bash
+npm install -D eslint-config-mgz eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-import eslint-plugin-jsx-a11y eslint-config-prettier
+```
+
+---
+
+## 🚨 **ESLint үйлесімділігі**
+
+### 📊 **Үйлесімділік кестесі:**
+
+| ESLint нұсқасы | Үйлесімділік | Конфиг файл       | Ескертулер               |
+| -------------- | ------------ | ----------------- | ------------------------ |
+| **v7.x**       | ✅ Толық     | `.eslintrc.*`     | Ұсынылады                |
+| **v8.x**       | ✅ Толық     | `.eslintrc.*`     | Ұсынылады                |
+| **v9.x**       | ✅ Толық     | `eslint.config.*` | flat-config пайдаланыңыз |
+
+### 🧩 Қолдану
+
+#### .eslintrc.js ішінде
+
+```javascript
+module.exports = {
+  extends: ["eslint-config-mgz"],
+  parserOptions: {
+    project: "./tsconfig.json",
+  },
+};
+```
+
+#### ESLint v9+ үшін (Flat Config)
+
+```javascript
+// eslint.config.js
+import config from "eslint-config-mgz/flat-config";
+
+export default config;
+```
+
+Қосымша ережелермен:
+
+```javascript
+// eslint.config.js
+import { FlatCompat } from "@eslint/eslintrc";
+import baseConfig from "eslint-config-mgz";
+
+const compat = new FlatCompat();
+export default [
+  ...compat.config(baseConfig),
+  {
+    rules: {
+      // Сіздің қосымша ережелеріңіз
+      "no-console": "warn",
+    },
+  },
+];
+```
+
+#### Ескі ESLint нұсқалары үшін (v7-8)
+
+```bash
+# v9-да ескі конфиг форматын мәжбүрлеу
+npx eslint --config .eslintrc.js src/
+```
+
+---
+
+### ⚠️ Маңызды ескертулер
+
+- **Peer dependencies**: Барлық плагиндерді бөлек орнату қажет
+- **TypeScript**: parserOptions.project үшін tsconfig.json қажет
+- **React**: React нұсқасын автоматты түрде анықтайды
+- **Prettier**: prettier-config-mgz бірге қолдану ұсынылады
+
+---
+
+### ❓ Мүмкін сұрақтар
+
+**tsconfig.json қажет пе?**
+Иә, TypeScript ережелерінің дұрыс жұмысы үшін қажет.
+
+**Ережелерді өзгертуге бола ма?**
+Иә, жергілікті .eslintrc файлында өз ережелеріңізді қосыңыз.
+
+**Неге кейбір ережелер өшірілген?**
+Кейбір ережелер икемділік үшін немесе басқа құралдармен қайшылықтар салдарынан арнайы өшірілген.

package/base.js

@@ -0,0 +1,45 @@
+module.exports = {
+  parser: "@typescript-eslint/parser",
+  extends: [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:react-hooks/recommended",
+    "plugin:import/recommended",
+    "plugin:jsx-a11y/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "eslint-config-prettier",
+  ],
+  settings: {
+    react: { version: "detect" },
+    "import/resolver": {
+      node: {
+        paths: ["src"],
+        extensions: [".js", ".jsx", ".ts", ".tsx"],
+      },
+    },
+  },
+  plugins: ["@typescript-eslint"],
+  rules: {
+    "no-alert": "error",
+    "no-console": "error",
+    "no-undef-init": "error",
+    "no-undefined": "error",
+    "no-var": "error",
+    "no-inline-comments": "off",
+    "no-use-before-define": "off",
+    "import/no-unresolved": "off",
+    "react/react-in-jsx-scope": "off",
+    "react/display-name": "off",
+    "react/no-array-index-key": "warn",
+    "no-duplicate-imports": "warn",
+    "jsx-a11y/no-autofocus": "off",
+    "jsx-a11y/anchor-has-content": "off",
+    "jsx-a11y/heading-has-content": "off",
+    "react/prop-types": "off",
+    "react/no-unknown-property": [
+      "error",
+      { ignore: ["cmdk-input-wrapper", "cmdk-empty"] },
+    ],
+    "import/named": "off",
+  },
+};

package/flat-config.js

@@ -0,0 +1,80 @@
+// eslint-config-mgz/flat-config.js
+import { configs as jsConfigs } from "@eslint/js";
+import tsPlugin from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+import reactPlugin from "eslint-plugin-react";
+import reactHooksPlugin from "eslint-plugin-react-hooks";
+import importPlugin from "eslint-plugin-import";
+import jsxA11yPlugin from "eslint-plugin-jsx-a11y";
+
+export default [
+  // Игнорируем лишние файлы
+  {
+    ignores: [
+      "dist/**",
+      "build/**",
+      "node_modules/**",
+      ".eslintrc.*",
+      ".prettierrc.*",
+      "eslint.config.*",
+    ],
+  },
+
+  // Базовые правила ESLint
+  jsConfigs.recommended,
+
+  // TypeScript rules
+  {
+    files: ["**/*.{ts,tsx}"],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        project: "./tsconfig.json",
+        ecmaVersion: "latest",
+        sourceType: "module",
+      },
+    },
+    rules: {
+      ...tsPlugin.configs.recommended.rules,
+      "@typescript-eslint/no-unused-vars": "warn",
+      "@typescript-eslint/no-explicit-any": "warn",
+      "@typescript-eslint/prefer-const": "error",
+    },
+  },
+
+  // React rules
+  {
+    files: ["**/*.{jsx,tsx}"],
+    plugins: {
+      react: reactPlugin,
+      "react-hooks": reactHooksPlugin,
+      import: importPlugin,
+      "jsx-a11y": jsxA11yPlugin,
+    },
+    rules: {
+      "react/react-in-jsx-scope": "off",
+      "react/prop-types": "off",
+      "react/display-name": "off",
+      "react/no-array-index-key": "warn",
+      "react-hooks/rules-of-hooks": "error",
+      "react-hooks/exhaustive-deps": "warn",
+      "import/no-unresolved": "off",
+      "import/named": "off",
+      "jsx-a11y/no-autofocus": "off",
+      "jsx-a11y/anchor-has-content": "off",
+      "jsx-a11y/heading-has-content": "off",
+      "no-alert": "error",
+      "no-console": "error",
+      "no-undef-init": "error",
+      "no-undefined": "error",
+      "no-var": "error",
+      "no-inline-comments": "off",
+      "no-use-before-define": "off",
+      "no-duplicate-imports": "warn",
+      "react/no-unknown-property": [
+        "error",
+        { ignore: ["cmdk-input-wrapper", "cmdk-empty"] },
+      ],
+    },
+  },
+];

package/index.js

@@ -0,0 +1,27 @@
+// eslint-config-mgz/index.js
+function isEslintV9Plus() {
+  try {
+    require.resolve("@eslint/js");
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+let config;
+
+if (isEslintV9Plus()) {
+  config = require("./flat-config").default;
+} else {
+  const { FlatCompat } = require("@eslint/eslintrc");
+  const baseConfig = require("./base");
+
+  const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    resolvePluginsRelativeTo: __dirname,
+  });
+
+  config = compat.config(baseConfig);
+}
+
+module.exports = config;

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "eslint-config-mgz",
+  "version": "1.0.0",
+  "main": "index.js",
+  "type": "commonjs",
+  "peerDependencies": {
+    "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0",
+    "@typescript-eslint/parser": "^6.0.0 || ^7.0.0 || ^8.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0 || ^7.0.0 || ^8.0.0",
+    "eslint-plugin-react": "^7.0.0 || ^8.0.0",
+    "eslint-plugin-react-hooks": "^4.0.0 || ^5.0.0 || ^7.0.0",
+    "eslint-plugin-import": "^2.0.0",
+    "eslint-plugin-jsx-a11y": "^6.0.0",
+    "eslint-config-prettier": "^9.0.0"
+  }
+}