@zimbra/eslint-config 1.2.0 → 2.0.0

package/README.md

@@ -9,11 +9,13 @@ This package bundles a set of shareable ESLint configs and rule customizations s
 - [Overview](#overview)
 - [Quick start](#quick-start)
 - [Installation](#installation)
+- [Prettier integration (important)](#prettier-integration-important)
+- [When should I integrate this?](#when-should-i-integrate-this)
+- [What problem will it resolve?](#what-problem-will-it-resolve)
 - [Usage examples](#usage-examples)
 - [ESLint Flat Config example (eslint.config.mjs)](#eslint-flat-config-example-eslintconfigmjs)
 - [Exports & configs](#exports--configs)
-- [Rule summary](#rule-summary)
-- [Custom rules](#custom-rules)
+- [Architecture & rule organization](#architecture--rule-organization)
 - [Scripts](#scripts)
 - [Publishing](#publishing)
 - [Contributing](#contributing)
@@ -101,15 +103,15 @@ Adopting this config helps maintain code quality, reduces time spent configuring
 
 ## **ESLint Flat Config example (eslint.config.mjs)**
 
-If your project uses ESLint v9+ with the Flat Config (`eslint.config.mjs` / `eslint.config.cjs`), import the named config blocks exported by this package and spread them into your exported array. Example JS project:
+If your project uses ESLint v9+ with the Flat Config (`eslint.config.mjs` / `eslint.config.cjs`), import the named config blocks exported by this package and add them to your exported array. Example JS project:
 
 ```js
 // eslint.config.mjs
 import { coreJsConfig, customConfig } from "@zimbra/eslint-config";
 
 export default [
-  ...coreJsConfig,
-  ...customConfig,
+  coreJsConfig,
+  customConfig,
   // Add local overrides or additional blocks here
   {
     files: ["**/*.js", "**/*.jsx"],
@@ -120,6 +122,24 @@ export default [
 ];
 ```
 
+Example React project with i18n support:
+
+```js
+// eslint.config.mjs
+import { coreJsConfig, customConfig, reactConfig, preactI18nConfig } from "@zimbra/eslint-config";
+
+export default [
+  coreJsConfig,
+  customConfig,
+  reactConfig,
+  preactI18nConfig,
+  {
+    files: ["**/*.jsx"],
+    // local React overrides (if needed)
+  }
+];
+```
+
 TypeScript project using the package TypeScript export:
 
 ```js
@@ -128,8 +148,8 @@ import { coreJsConfig } from "@zimbra/eslint-config";
 import typescriptConfig from "@zimbra/eslint-config/typescript";
 
 export default [
-  ...coreJsConfig,
-  ...typescriptConfig,
+  coreJsConfig,
+  typescriptConfig,
   {
     files: ["**/*.ts", "**/*.tsx"],
     // local TypeScript overrides (if needed)
@@ -141,17 +161,40 @@ Notes:
 
 - Ensure your project has `type: "module"` in `package.json` or use the `.mjs` extension for the config file so Node treats it as ESM.
 - Install peer dependencies (`eslint`, `@typescript-eslint/*`, `prettier`) in the consumer project as described in the Installation section.
-- The exported config blocks (`coreJsConfig`, `customConfig`, etc.) are arrays of config blocks — spreading them preserves ordering and allows local blocks to appear before/after as desired.
+- The exported config blocks (`coreJsConfig`, `customConfig`, etc.) are objects that represent a single ESLint config block — add them directly to your config array without spreading.
 
 ## **Exports & configs**
 
-- `.` -> `src/index.js` (base config)
-- `./typescript` -> `src/typescript.js` (TypeScript-focused config)
-- Additional configs are in `src/configs/` (automation, core-js, custom, locale-json, ts-eslint-config)
+### Main exports from `src/index.js`
+
+- **`coreJsConfig`** — Base JavaScript config with ESLint recommended rules, import rules, security, and style rules.
+- **`customConfig`** — Custom Zimbra rules (includes `no-direct-memoize` and other custom patterns).
+- **`reactConfig`** — React and React Hooks rules (includes plugin setup and recommended rules).
+- **`preactI18nConfig`** — Preact i18n rules and configuration (requires `ESLINT_INTL_PATH` environment variable or defaults to `src/intl`).
+- **`prettierConfig`** — Prettier integration (formatting rules and conflict resolution).
+- **`automationConfig`** — Automation/TestCafe rules for test files.
+- **`localeJsonConfig`** — i18n JSON validation rules.
+
+### Additional exports
+
+- `./typescript` -> `src/typescript.js` (TypeScript-focused config — exports `tsEslintConfig`)
+
+## **Architecture & rule organization**
+
+The package follows a modular structure:
+
+- **`src/rules/`** — Individual rule modules (react, style, security, import, etc.) that define which ESLint rules are enabled and their severity levels.
+- **`src/configs/`** — Config modules that combine related rules and plugins into focused, reusable blocks. Each config handles a specific concern (e.g., React, i18n, Prettier, automation).
+- **`src/index.js`** — Exports the themed configs for use in consumer projects.
+- **`src/typescript.js`** — TypeScript-specific config export.
+
+Rule details and descriptions have moved to [RULES.md](RULES.md). That file contains a complete list of rule modules and plain-language explanations of what each rule enforces or why a rule is disabled. It also reflects the latest updates in this branch, including converting numeric rule severity values (0/1/2) into explicit words (`off`, `warn`, `error`) for `src/rules/style.js` and `src/rules/security.js` rules. See [RULES.md](RULES.md) in the repo root for the authoritative list and examples.
+
+### Custom rules
 
-## **Rules and custom rules**
+Custom rules are defined in `src/rules/custom-rules/`:
 
-Rule details and descriptions have moved to `RULES.md`. That file contains a complete list of rule modules and plain-language explanations of what each rule enforces or why a rule is disabled. See `RULES.md` in the repo root for the authoritative list and examples.
+- **`no-direct-memoize.js`** — Prevents direct wrapping of components in React.memo without considering performance implications. Use memoization only when genuinely needed.
 
 ## **Scripts**
 

package/RULES.md

@@ -62,6 +62,20 @@ Source: `src/rules/import.js`
 
 ---
 
+## **src/rules/security.js**
+
+Purpose: Security-focused rules that disallow unsafe JavaScript patterns.
+
+Rules and what they do:
+
+- `no-eval`: error — disallow `eval()` usage (runtime injection risk).
+- `no-implied-eval`: error — disallow `setTimeout/string` and similar implicit eval patterns.
+- `no-new-func`: error — disallow `new Function(...)` creation (runtime code execution risk).
+
+Source: `src/rules/security.js`
+
+---
+
 ## **src/rules/parser.js**
 
 Purpose: Central parser configuration used for TypeScript-enabled linting blocks.
@@ -134,11 +148,19 @@ Purpose: Style and code-shape rules that affect common JavaScript patterns.
 
 Rules and what they do:
 
-- `no-undef`: off — do not report undefined variables here (TypeScript or other checks may handle this).
-- `no-unsafe-optional-chaining`: off — allow some optional chaining patterns that would otherwise be flagged.
+- `new-cap`: warn — require constructor function names to be capitalized, but at warn level.
+- `no-console`: ['warn', { allow: ['warn', 'error'] }] — warn on console calls except `console.warn` and `console.error`.
+- `no-shadow-restricted-names`: error — disallow shadowing of restricted names such as `arguments`.
+- `no-shadow`: error — disallow variable shadowing.
+- `eqeqeq`: ['error', 'smart'] — require strict equality except for some safe special cases.
+- `camelcase`: ['warn', { properties: 'never' }] — warn on non-camelcase identifiers while allowing property names.
+- `guard-for-in`: error — require `hasOwnProperty` checks in `for..in` loops.
+- `prefer-rest-params`: error — prefer rest parameters over `arguments`.
+- `no-alert`: error — disallow alert/confirm/prompt usage.
+- `no-unused-vars`: ['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true, caughtErrors: 'none' }] — report unused variables while allowing common ignore patterns.
 - `no-empty`: off — allow empty blocks in some cases.
 - `no-empty-pattern`: off — allow empty destructuring patterns.
-- `no-unused-vars`: `['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true, caughtErrors: 'none' }]` — report unused variables, but ignore some common patterns (e.g., rest siblings).
+- `no-unsafe-optional-chaining`: off — allow optional chaining in conditions that would otherwise be invalid.
 
 Source: `src/rules/style.js`
 

package/eslint.config.mjs

@@ -1,3 +1,3 @@
 import { coreJsConfig } from './src/index.js';
 
-export default [...coreJsConfig];
+export default coreJsConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zimbra/eslint-config",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "type": "module",
   "description": "ESLint configuration for Zimbra javascript projects.",
   "main": "src/index.js",
@@ -11,7 +11,6 @@
   "scripts": {
     "lint": "eslint src --config eslint.config.mjs",
     "lint:fix": "npm run lint -- --fix",
-    "prepublishOnly": "npm run lint && git commit -am $npm_package_version && git tag $npm_package_version && git push && git push --tags",
     "prepare": "husky || true"
   },
   "engines": {

package/src/configs/automation-config.js

@@ -1,16 +1,20 @@
+import { fixupPluginRules } from '@eslint/compat';
+
 import testcafePlugin from 'eslint-plugin-testcafe';
+import pluginMocha from 'eslint-plugin-mocha';
+
 import { automationRules } from '../rules/automation.js';
 
-export default [
-	{
-		files: ['test/**/*.{js,jsx,mjs,cjs}', 'tests/**/*.{js,jsx,mjs,cjs}'],
-		ignores: ['**/node_modules/**', '**/dist/**', '**/build/**'],
-		plugins: {
-			testcafePlugin: testcafePlugin
-		},
-		rules: {
-			...testcafePlugin.configs.recommended.rules,
-			...automationRules
-		}
+export default {
+	files: ['**/*.{js,jsx,mjs,cjs}'],
+
+	plugins: {
+		mocha: fixupPluginRules(pluginMocha),
+		testcafePlugin: testcafePlugin
+	},
+
+	rules: {
+		...testcafePlugin.configs.recommended.rules,
+		...automationRules
 	}
-];
+};

package/src/configs/core-js-config.js

@@ -1,91 +1,37 @@
 import eslint from '@eslint/js';
-import { fixupPluginRules } from '@eslint/compat';
 import globals from 'globals';
-import path from 'path';
 
-import prettierConfig from 'eslint-config-prettier';
-import pluginPrettier from 'eslint-plugin-prettier';
-import pluginMocha from 'eslint-plugin-mocha';
-import pluginPreactI18n from 'eslint-plugin-preact-i18n';
-import pluginReact from 'eslint-plugin-react';
-import pluginReactHooks from 'eslint-plugin-react-hooks';
 import importPlugin from 'eslint-plugin-import';
 
 import styleRules from '../rules/style.js';
-import reactRules from '../rules/react.js';
-import reactHooksRules from '../rules/react-hooks.js';
 import securityRules from '../rules/security.js';
 import importRules from '../rules/import.js';
-import { i18nRules, LANGUAGE_FILES_RELATIVE, i18nTextComponents } from '../rules/i18n.js';
-import prettierRules from '../rules/prettier.js';
 import parserConfig from '../rules/parser.js';
 
-const intlPath = process.env.ESLINT_INTL_PATH ?? 'src/intl';
-const disableIntl = process.env.ESLINT_DISABLE_INTL === 'true';
+export default {
+	files: ['**/*.{js,jsx,mjs,cjs}'],
 
-const coreRules = {
-	...styleRules,
-	...reactRules,
-	...reactHooksRules,
-	...importRules,
-	...prettierRules,
-	...securityRules,
-	...(disableIntl ? {} : i18nRules)
-};
-
-const languageFilesAbsolute = LANGUAGE_FILES_RELATIVE.map(entry => ({
-	name: entry.name,
-	path: path.join(intlPath, entry.filename)
-}));
-
-export default [
-	{
-		files: ['**/*.{js,jsx,mjs,cjs}'],
-
-		ignores: ['**/node_modules/**', '**/dist/**', '**/build/**', '**/*.graphql', '**/*.gql'],
-
-		languageOptions: {
-			...parserConfig,
-			globals: {
-				...globals.browser,
-				...globals.node
-			}
-		},
-
-		plugins: {
-			react: pluginReact,
-			'react-hooks': pluginReactHooks,
-			mocha: fixupPluginRules(pluginMocha),
-			prettier: pluginPrettier,
-			import: importPlugin,
-			...(disableIntl
-				? {}
-				: {
-						// TODO: Upgrade `pluginPreactI18n` to a modern version to ensure compatibility with current tooling and React/Preact best practices
-						'preact-i18n': fixupPluginRules(pluginPreactI18n)
-					})
-		},
-
-		rules: {
-			...eslint.configs.recommended.rules,
-			...prettierConfig.rules,
-			...pluginReact.configs.recommended.rules,
-			...pluginReactHooks.configs.recommended.rules,
-			...importPlugin.configs.recommended.rules,
-			...coreRules
-		},
-
-		settings: {
-			// Requires exactly version 16.0. See: https://github.com/jsx-eslint/eslint-plugin-react/issues/1754
-			react: { pragma: 'createElement', version: '16.0' },
-			...(disableIntl
-				? {}
-				: {
-						'preact-i18n': {
-							languageFiles: languageFilesAbsolute,
-							textComponents: i18nTextComponents
-						}
-					})
+	languageOptions: {
+		...parserConfig,
+		globals: {
+			...globals.browser,
+			...globals.node
 		}
+	},
+
+	plugins: {
+		import: importPlugin
+	},
+
+	rules: {
+		...eslint.configs.recommended.rules,
+		...importPlugin.configs.recommended.rules,
+		...styleRules,
+		...importRules,
+		...securityRules
+	},
+
+	settings: {
+		'import/node-version': '18.20.0'
 	}
-];
+};

package/src/configs/custom-config.js

@@ -1,19 +1,18 @@
 import customRules from '../rules/custom-rules/custom-rules.js';
 import noDirectMemoize from '../rules/custom-rules/no-direct-memoize.js';
 
-export default [
-	{
-		files: ['**/*.{js,jsx,mjs,cjs}'],
-		ignores: ['**/node_modules/**', '**/dist/**', '**/build/**'],
-		plugins: {
-			custom: {
-				rules: {
-					'no-direct-memoize': noDirectMemoize
-				}
+export default {
+	files: ['**/*.{js,jsx,mjs,cjs}'],
+
+	plugins: {
+		custom: {
+			rules: {
+				'no-direct-memoize': noDirectMemoize
 			}
-		},
-		rules: {
-			...customRules
 		}
+	},
+
+	rules: {
+		...customRules
 	}
-];
+};

package/src/configs/locale-json-config.js

@@ -1,20 +1,20 @@
 import pluginI18nJson from 'eslint-plugin-i18n-json';
 import { i18nJsonRules } from '../rules/i18n.js';
 
-export default [
-	{
-		files: ['**/*.json'],
-		ignores: ['**/node_modules/**', '**/dist/**', '**/build/**'],
-		plugins: {
-			'i18n-json': pluginI18nJson
-		},
-		processor: {
-			meta: { name: '.json' },
-			...pluginI18nJson.processors['.json']
-		},
-		rules: {
-			...pluginI18nJson.configs.recommended.rules,
-			...i18nJsonRules
-		}
+export default {
+	files: ['**/*.json'],
+
+	plugins: {
+		'i18n-json': pluginI18nJson
+	},
+
+	processor: {
+		meta: { name: '.json' },
+		...pluginI18nJson.processors['.json']
+	},
+
+	rules: {
+		...pluginI18nJson.configs.recommended.rules,
+		...i18nJsonRules
 	}
-];
+};

package/src/configs/prettier-config.js

@@ -0,0 +1,17 @@
+import prettierConfig from 'eslint-config-prettier';
+import pluginPrettier from 'eslint-plugin-prettier';
+
+import prettierRules from '../rules/prettier.js';
+
+export default {
+	files: ['**/*.{js,jsx,mjs,cjs}'],
+
+	plugins: {
+		prettier: pluginPrettier
+	},
+
+	rules: {
+		...prettierConfig.rules,
+		...prettierRules
+	}
+};

package/src/index.js

@@ -1,6 +1,17 @@
-import automationConfig from './configs/automation-config.js';
-import localeJsonConfig from './configs/locale-json-config.js';
 import coreJsConfig from './configs/core-js-config.js';
+import localeJsonConfig from './configs/locale-json-config.js';
+import automationConfig from './configs/automation-config.js';
+import prettierConfig from './configs/prettier-config.js';
 import customConfig from './configs/custom-config.js';
+import reactConfig from './configs/react-config.js';
+import preactI18nConfig from './configs/preact-i18n-config.js';
 
-export { coreJsConfig, localeJsonConfig, automationConfig, customConfig };
+export {
+	coreJsConfig,
+	localeJsonConfig,
+	automationConfig,
+	prettierConfig,
+	customConfig,
+	reactConfig,
+	preactI18nConfig
+};

package/src/rules/automation.js

@@ -1,16 +1,8 @@
 export const automationRules = {
-	'prettier/prettier': 'off',
 	'prefer-const': 'off',
-	'require-atomic-updates': 'off',
 	'guard-for-in': 'off',
-	'react/jsx-no-useless-fragment': 'off',
-	'lines-around-comment': 'off',
+	'prettier/prettier': 'off',
 	'no-unexpected-multiline': 'off',
-	'no-spaced-func': 'off',
 	'new-cap': 'off',
-	'no-undef-init': 'off',
-	'no-shadow': 'off',
-	'no-case-declarations': 'off',
-	'no-constant-binary-expression': 'off',
-	semi: ['error', 'always']
+	'no-case-declarations': 'off'
 };

package/src/rules/i18n.js

@@ -1,5 +1,5 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 
 const configUrl = import.meta.url;
 const intlPath = process.env.ESLINT_INTL_PATH ?? 'src/intl';

package/src/rules/import.js

@@ -1,8 +1,13 @@
 export const importRules = {
 	'import/no-unresolved': 'off',
+	'import/enforce-node-protocol-usage': ['error', 'always'],
 
 	// TODO: Enable these rules once the codebase is updated to follow best practices
-	'import/no-named-as-default': 'off'
+	'import/no-named-as-default': 'off',
+	'import/extensions': 'off',
+	'import/newline-after-import': 'off',
+	'import/order': 'off',
+	'import/no-extraneous-dependencies': 'off'
 };
 
 export default importRules;

package/src/rules/react.js

@@ -14,6 +14,9 @@ export const reactRules = {
 	'react/jsx-no-duplicate-props': 'error',
 	'react/jsx-pascal-case': 'error',
 
+	// Security related rules
+	'react/no-danger': 'error',
+
 	// TODO: Enable these rules once the codebase is updated to follow best practices
 	'react/react-in-jsx-scope': 'off',
 	'react/jsx-key': 'off',

package/src/rules/security.js

@@ -1,8 +1,7 @@
 export const securityRules = {
-	'no-eval': 2,
-	'no-implied-eval': 2,
-	'no-new-func': 2,
-	'react/no-danger': 'error'
+	'no-eval': 'error',
+	'no-implied-eval': 'error',
+	'no-new-func': 'error'
 };
 
 export default securityRules;

package/src/rules/style.js

@@ -1,12 +1,12 @@
 export const styleRules = {
-	'new-cap': 1,
-	'no-console': [1, { allow: ['warn', 'error'] }],
-	'no-shadow-restricted-names': 2,
+	'new-cap': 'warn',
+	'no-console': ['warn', { allow: ['warn', 'error'] }],
+	'no-shadow-restricted-names': 'error',
 	'no-shadow': 'error',
 	eqeqeq: ['error', 'smart'],
-	camelcase: [1, { properties: 'never' }],
-	'guard-for-in': 2,
-	'prefer-rest-params': 2,
+	camelcase: ['warn', { properties: 'never' }],
+	'guard-for-in': 'error',
+	'prefer-rest-params': 'error',
 	'no-alert': 'error',
 
 	// TODO: Fully enable this rule once the codebase is updated to follow best practices