@maz-ui/eslint-config 4.0.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 LouisMazel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,164 @@
+# @maz-ui/eslint-config
+
+Reusable ESLint configuration for JavaScript/TypeScript projects.
+
+## Features
+
+- 🚀 **Based on @antfu/eslint-config** - Modern and performant configuration
+- 🛡️ **Strict TypeScript** - Full TypeScript support
+- 🎨 **Tailwind CSS** - Rules for Tailwind CSS (with Tailwind CSS plugin)
+- 🔍 **SonarJS** - Code quality with SonarJS (with SonarJS plugin)
+- ⚙️ **Configurable** - Flexible and extensible options
+- 📦 **Production ready** - Optimized for production environments
+
+## Installation
+
+```bash
+pnpm add -D @maz-ui/eslint-config eslint
+```
+
+## Basic usage
+
+```js
+// eslint.config.js
+import { defineConfig } from '@maz-ui/eslint-config'
+
+export default defineConfig()
+```
+
+## Custom configuration
+
+```js
+// eslint.config.js
+import { defineConfig } from '@maz-ui/eslint-config'
+
+export default defineConfig({
+  // Environment (affects console rules)
+  env: 'production', // 'development' | 'production'
+
+  // Enable/disable plugins
+  typescript: true,
+  tailwindcss: true,
+  sonarjs: true,
+  formatters: true,
+
+  // Files to ignore
+  ignores: ['custom-dist/**'],
+
+  // Custom rules
+  rules: {
+    'no-console': 'error',
+    'prefer-const': 'warn'
+  }
+})
+```
+
+## Available options
+
+```typescript
+interface MazESLintOptions {
+  typescript?: boolean // TypeScript support (default: true)
+  tailwindcss?: boolean // Tailwind CSS rules (default: true)
+  sonarjs?: boolean // SonarJS rules (default: true)
+  formatters?: boolean // Formatters support (default: true)
+  env?: 'development' | 'production' // Environment (default: 'development')
+  ignores?: string[] // Files to ignore
+  rules?: Record<string, any> // Custom ESLint rules
+}
+```
+
+## Advanced usage
+
+### Selective rule imports
+
+```js
+import { baseRules, sonarjsRules, tailwindcssRules } from '@maz-ui/eslint-config'
+
+export default [
+  {
+    rules: {
+      ...baseRules,
+      ...sonarjsRules,
+      // Your custom rules
+    }
+  }
+]
+```
+
+### Example for Vue project
+
+```js
+// eslint.config.js
+import { defineConfig } from '@maz-ui/eslint-config'
+
+export default defineConfig({
+  env: 'production',
+  rules: {
+    'vue/custom-event-name-casing': ['error', 'kebab-case'],
+    'vue/no-undef-components': ['error', {
+      ignorePatterns: ['RouterView', 'RouterLink']
+    }]
+  }
+})
+```
+
+## Included rules
+
+### Base (JavaScript/TypeScript)
+
+- Console management by environment
+- Code quality rules
+- Optimized TypeScript support
+
+### SonarJS
+
+- Limited cognitive complexity
+- Duplicate code detection
+- Security best practices
+
+### Tailwind CSS
+
+- Consistent class ordering
+- Contradictory class detection
+- Valid Tailwind syntax
+
+## Compatibility
+
+- **ESLint** ^9.0.0
+- **Node.js** >=18.0.0
+- **TypeScript** ^5.0.0
+
+## Usage examples
+
+### Simple JavaScript project
+
+```js
+export default defineConfig({
+  typescript: false,
+  tailwindcss: false
+})
+```
+
+### Project with Tailwind
+
+```js
+export default defineConfig({
+  tailwindcss: true,
+  rules: {
+    'tailwindcss/classnames-order': 'error'
+  }
+})
+```
+
+### Production project
+
+```js
+export default defineConfig({
+  env: 'production',
+  sonarjs: true,
+  rules: {
+    'no-console': 'error',
+    'no-debugger': 'error'
+  }
+})
+```

package/dist/index.d.mts

@@ -0,0 +1,106 @@
+import { antfu, OptionsConfig, Rules, TypedFlatConfigItem } from '@antfu/eslint-config';
+import { Linter } from 'eslint';
+
+type MazESLintUserConfig = TypedFlatConfigItem | TypedFlatConfigItem[] | Linter.Config | Linter.Config[];
+interface MazESLintOptions extends OptionsConfig {
+    /**
+     * Enable Tailwind CSS support
+     * @default true
+     */
+    tailwindcss?: boolean;
+    /**
+     * Enable SonarJS rules for code quality
+     * @default true
+     */
+    sonarjs?: boolean;
+    /**
+     * Enable Vue Accessibility plugin
+     * @default false
+     */
+    vueAccessibility?: boolean;
+    /**
+     * Environment (affects console warnings/errors)
+     * @default 'development'
+     */
+    env?: 'development' | 'production';
+    /**
+     * Files to ignore
+     * @default ['**\/*.md', 'dist/**', 'node_modules/**']
+     */
+    ignores?: string[];
+    /**
+     * Additional rules to merge
+     */
+    rules?: Partial<Rules>;
+}
+type MazESLintConfig = ReturnType<typeof antfu>;
+
+/**
+ * Base ESLint rules for JavaScript/TypeScript projects
+ * Optimized for code quality and consistency
+ */
+declare function baseRules(isProduction: boolean): Partial<Rules>;
+
+/**
+ * SonarJS rules configuration
+ * Focused on code quality and maintainability
+ */
+declare const sonarjsRules: {
+    readonly 'sonarjs/no-duplicate-string': "off";
+    readonly 'sonarjs/class-name': "off";
+    readonly 'sonarjs/no-nested-conditional': "off";
+    readonly 'sonarjs/sonar-no-unused-vars': "off";
+    readonly 'sonarjs/cognitive-complexity': readonly ["error", 20];
+    readonly 'sonarjs/no-identical-functions': "error";
+    readonly 'sonarjs/no-collapsible-if': "error";
+    readonly 'sonarjs/prefer-immediate-return': "error";
+    readonly 'sonarjs/prefer-object-literal': "error";
+    readonly 'sonarjs/prefer-single-boolean-return': "error";
+};
+/**
+ * SonarJS rules for test files
+ */
+declare const sonarjsTestRules: {
+    readonly 'sonarjs/no-nested-functions': "off";
+    readonly 'sonarjs/cognitive-complexity': "off";
+    readonly 'sonarjs/no-hardcoded-credentials': "off";
+    readonly 'sonarjs/no-duplicate-string': "off";
+};
+
+/**
+ * Tailwind CSS ESLint rules configuration
+ */
+declare const tailwindcssRules: {
+    readonly 'tailwindcss/no-custom-classname': "off";
+    readonly 'tailwindcss/classnames-order': "warn";
+    readonly 'tailwindcss/no-contradicting-classname': "error";
+    readonly 'tailwindcss/enforces-negative-arbitrary-values': "error";
+    readonly 'tailwindcss/enforces-shorthand': "warn";
+};
+
+declare const vueRules: {
+    'vue/custom-event-name-casing': ["error", "kebab-case"];
+};
+
+/**
+ * Create ESLint configuration for Maz-UI and JavaScript/TypeScript projects
+ *
+ * @param options Configuration options
+ * @returns ESLint flat config array
+ *
+ * @example
+ * ```js
+ * import { defineConfig } from '@maz-ui/eslint-config'
+ *
+ * export default defineConfig({
+ *   env: 'production',
+ *   rules: {
+ *     'no-console': 'error'
+ *   }
+ * })
+ * ```
+ */
+declare function defineConfig(options?: MazESLintOptions, ...userConfigs: MazESLintUserConfig[]): MazESLintConfig;
+
+export { baseRules, defineConfig, sonarjsRules, sonarjsTestRules, tailwindcssRules, vueRules };
+export type { MazESLintConfig, MazESLintOptions };

package/dist/index.d.ts

@@ -0,0 +1,106 @@
+import { antfu, OptionsConfig, Rules, TypedFlatConfigItem } from '@antfu/eslint-config';
+import { Linter } from 'eslint';
+
+type MazESLintUserConfig = TypedFlatConfigItem | TypedFlatConfigItem[] | Linter.Config | Linter.Config[];
+interface MazESLintOptions extends OptionsConfig {
+    /**
+     * Enable Tailwind CSS support
+     * @default true
+     */
+    tailwindcss?: boolean;
+    /**
+     * Enable SonarJS rules for code quality
+     * @default true
+     */
+    sonarjs?: boolean;
+    /**
+     * Enable Vue Accessibility plugin
+     * @default false
+     */
+    vueAccessibility?: boolean;
+    /**
+     * Environment (affects console warnings/errors)
+     * @default 'development'
+     */
+    env?: 'development' | 'production';
+    /**
+     * Files to ignore
+     * @default ['**\/*.md', 'dist/**', 'node_modules/**']
+     */
+    ignores?: string[];
+    /**
+     * Additional rules to merge
+     */
+    rules?: Partial<Rules>;
+}
+type MazESLintConfig = ReturnType<typeof antfu>;
+
+/**
+ * Base ESLint rules for JavaScript/TypeScript projects
+ * Optimized for code quality and consistency
+ */
+declare function baseRules(isProduction: boolean): Partial<Rules>;
+
+/**
+ * SonarJS rules configuration
+ * Focused on code quality and maintainability
+ */
+declare const sonarjsRules: {
+    readonly 'sonarjs/no-duplicate-string': "off";
+    readonly 'sonarjs/class-name': "off";
+    readonly 'sonarjs/no-nested-conditional': "off";
+    readonly 'sonarjs/sonar-no-unused-vars': "off";
+    readonly 'sonarjs/cognitive-complexity': readonly ["error", 20];
+    readonly 'sonarjs/no-identical-functions': "error";
+    readonly 'sonarjs/no-collapsible-if': "error";
+    readonly 'sonarjs/prefer-immediate-return': "error";
+    readonly 'sonarjs/prefer-object-literal': "error";
+    readonly 'sonarjs/prefer-single-boolean-return': "error";
+};
+/**
+ * SonarJS rules for test files
+ */
+declare const sonarjsTestRules: {
+    readonly 'sonarjs/no-nested-functions': "off";
+    readonly 'sonarjs/cognitive-complexity': "off";
+    readonly 'sonarjs/no-hardcoded-credentials': "off";
+    readonly 'sonarjs/no-duplicate-string': "off";
+};
+
+/**
+ * Tailwind CSS ESLint rules configuration
+ */
+declare const tailwindcssRules: {
+    readonly 'tailwindcss/no-custom-classname': "off";
+    readonly 'tailwindcss/classnames-order': "warn";
+    readonly 'tailwindcss/no-contradicting-classname': "error";
+    readonly 'tailwindcss/enforces-negative-arbitrary-values': "error";
+    readonly 'tailwindcss/enforces-shorthand': "warn";
+};
+
+declare const vueRules: {
+    'vue/custom-event-name-casing': ["error", "kebab-case"];
+};
+
+/**
+ * Create ESLint configuration for Maz-UI and JavaScript/TypeScript projects
+ *
+ * @param options Configuration options
+ * @returns ESLint flat config array
+ *
+ * @example
+ * ```js
+ * import { defineConfig } from '@maz-ui/eslint-config'
+ *
+ * export default defineConfig({
+ *   env: 'production',
+ *   rules: {
+ *     'no-console': 'error'
+ *   }
+ * })
+ * ```
+ */
+declare function defineConfig(options?: MazESLintOptions, ...userConfigs: MazESLintUserConfig[]): MazESLintConfig;
+
+export { baseRules, defineConfig, sonarjsRules, sonarjsTestRules, tailwindcssRules, vueRules };
+export type { MazESLintConfig, MazESLintOptions };

package/dist/index.mjs

@@ -0,0 +1,151 @@
+import antfu from '@antfu/eslint-config';
+import sonarjs from 'eslint-plugin-sonarjs';
+import tailwind from 'eslint-plugin-tailwindcss';
+import vueA11y from 'eslint-plugin-vuejs-accessibility';
+
+function baseRules(isProduction) {
+  return {
+    // Console warnings in development, errors in production
+    "no-console": [isProduction ? "error" : "warn"],
+    // Code quality
+    "prefer-regex-literals": "off",
+    "require-await": "error",
+    // Import/export
+    "node/prefer-global/process": "off",
+    // Disable overly strict rules
+    "no-unused-vars": "off",
+    // Handled by TypeScript
+    "ts/no-unused-vars": ["error", {
+      argsIgnorePattern: "^_",
+      varsIgnorePattern: "^_"
+    }],
+    // Allow reasonable complexity
+    "complexity": ["error", { max: 20 }],
+    "max-depth": ["error", { max: 4 }],
+    "max-nested-callbacks": ["error", { max: 3 }]
+  };
+}
+
+const markdown = {
+  ignores: ["**/*.md"],
+  rules: {
+    "ts/no-unused-vars": "off",
+    "sonarjs/unused-import": "off"
+  }
+};
+
+const sonarjsRules = {
+  // Disable overly strict SonarJS rules
+  "sonarjs/no-duplicate-string": "off",
+  "sonarjs/class-name": "off",
+  "sonarjs/no-nested-conditional": "off",
+  "sonarjs/sonar-no-unused-vars": "off",
+  "sonarjs/cognitive-complexity": ["error", 20],
+  // Keep useful SonarJS rules
+  "sonarjs/no-identical-functions": "error",
+  "sonarjs/no-collapsible-if": "error",
+  "sonarjs/prefer-immediate-return": "error",
+  "sonarjs/prefer-object-literal": "error",
+  "sonarjs/prefer-single-boolean-return": "error"
+};
+const sonarjsTestRules = {
+  "sonarjs/no-nested-functions": "off",
+  "sonarjs/cognitive-complexity": "off",
+  "sonarjs/no-hardcoded-credentials": "off",
+  "sonarjs/no-duplicate-string": "off"
+};
+
+const tailwindcssRules = {
+  // Allow custom class names (useful for component libraries)
+  "tailwindcss/no-custom-classname": "off",
+  // Enforce consistent class ordering
+  "tailwindcss/classnames-order": "warn",
+  // Prevent contradicting classes
+  "tailwindcss/no-contradicting-classname": "error",
+  // Enforce valid Tailwind syntax
+  "tailwindcss/enforces-negative-arbitrary-values": "error",
+  "tailwindcss/enforces-shorthand": "warn"
+};
+
+const testRules = {
+  "max-nested-callbacks": "off"
+};
+
+const vueRules = {
+  "vue/custom-event-name-casing": ["error", "kebab-case"]
+};
+
+const defaultOptions = {
+  formatters: true,
+  typescript: true,
+  sonarjs: true,
+  tailwindcss: false,
+  ignores: ["dist/**", "node_modules/**"],
+  rules: {}
+};
+function defineConfig(options = {}, ...userConfigs) {
+  const opts = { ...defaultOptions, ...options };
+  const env = opts.env || process.env.NODE_ENV || "production";
+  let allRules = {
+    ...baseRules(env === "production"),
+    ...opts.rules
+  };
+  if (opts.vue || opts.formatters) {
+    allRules = {
+      ...allRules,
+      ...vueRules
+    };
+  }
+  const additionalConfigs = [];
+  if (opts.sonarjs) {
+    additionalConfigs.push(sonarjs.configs.recommended);
+    additionalConfigs.push({
+      rules: {
+        ...sonarjs.configs.recommended.rules
+      }
+    });
+    additionalConfigs.push({
+      files: ["**/*.spec.ts", "**/*.test.ts", "**/*.spec.js", "**/*.test.js"],
+      rules: sonarjsTestRules
+    });
+  }
+  if (opts.vueAccessibility) {
+    const vueA11yConfigs = vueA11y.configs["flat/recommended"];
+    const configsArray = Array.isArray(vueA11yConfigs) ? vueA11yConfigs : [vueA11yConfigs];
+    const fixedConfigs = configsArray.map((config) => {
+      if (config && config.languageOptions && config.languageOptions.globals) {
+        const fixedGlobals = { ...config.languageOptions.globals };
+        if ("AudioWorkletGlobalScope " in fixedGlobals) {
+          fixedGlobals.AudioWorkletGlobalScope = fixedGlobals["AudioWorkletGlobalScope "];
+          delete fixedGlobals["AudioWorkletGlobalScope "];
+        }
+        return {
+          ...config,
+          languageOptions: {
+            ...config.languageOptions,
+            globals: fixedGlobals
+          }
+        };
+      }
+      return config;
+    });
+    additionalConfigs.push(...fixedConfigs);
+  }
+  if (opts.tailwindcss) {
+    additionalConfigs.push(...tailwind.configs["flat/recommended"]);
+    additionalConfigs.push({
+      rules: tailwindcssRules
+    });
+  }
+  additionalConfigs.push({
+    files: ["**/*.spec.ts", "**/*.test.ts", "**/*.spec.js", "**/*.test.js"],
+    rules: testRules
+  });
+  return antfu({
+    formatters: opts.formatters,
+    ...opts,
+    rules: allRules
+  }, ...additionalConfigs, ...userConfigs, markdown);
+}
+
+export { baseRules, defineConfig, sonarjsRules, sonarjsTestRules, tailwindcssRules, vueRules };

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@maz-ui/eslint-config",
+  "type": "module",
+  "version": "4.0.0-beta.0",
+  "description": "ESLint configuration for JavaScript/TypeScript projects",
+  "author": "Louis Mazel <me@loicmazuel.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LouisMazel/maz-ui.git"
+  },
+  "bugs": "https://github.com/LouisMazel/maz-ui/issues",
+  "keywords": [
+    "eslint",
+    "eslint-config",
+    "javascript",
+    "typescript",
+    "code-quality",
+    "maz-ui"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    },
+    "./*": "./*"
+  },
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "LICENSE",
+    "README.md",
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "typecheck": "tsc --noEmit --skipLibCheck",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "pre-commit": "lint-staged"
+  },
+  "peerDependencies": {
+    "eslint-plugin-format": "^1.0.1",
+    "eslint-plugin-sonarjs": "^3.0.2",
+    "eslint-plugin-tailwindcss": "^3.18.0",
+    "eslint-plugin-vuejs-accessibility": "^2.4.0"
+  },
+  "peerDependenciesMeta": {
+    "eslint-plugin-format": {
+      "optional": true
+    },
+    "eslint-plugin-sonarjs": {
+      "optional": true
+    },
+    "eslint-plugin-tailwindcss": {
+      "optional": true
+    },
+    "eslint-plugin-vuejs-accessibility": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@antfu/eslint-config": "^4.14.1"
+  },
+  "devDependencies": {
+    "@types/eslint-plugin-tailwindcss": "^3.17.0",
+    "eslint": "^9.29.0",
+    "eslint-plugin-format": "^1.0.1",
+    "typescript": "^5.8.3",
+    "unbuild": "^3.5.0"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,mjs,mts,cjs,md}": [
+      "eslint --fix"
+    ]
+  },
+  "gitHead": "9ef7beb4feeee0b0cb44e7df8af7115d5d5ef334"
+}