@zimbra/eslint-config 0.0.3 → 1.2.0

package/.husky/pre-commit

@@ -0,0 +1 @@
+npm run lint

package/.husky/prepare-commit-message

@@ -0,0 +1 @@
+./scripts/git-commit-msg.sh $1

package/eslint.config.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zimbra/eslint-config",
-  "version": "0.0.3",
+  "version": "1.2.0",
   "type": "module",
   "description": "ESLint configuration for Zimbra javascript projects.",
   "main": "src/index.js",
@@ -9,12 +9,19 @@
     "./typescript": "./src/typescript.js"
   },
   "scripts": {
-    "lint": "eslint src",
-    "lint:fix": "npm run lint -- --fix"
+    "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": {
+    "node": "^18.20.0",
+    "npm": "^6"
   },
   "dependencies": {
     "@eslint/compat": "^1.0.0",
     "@eslint/js": "^9.37.0",
+    "@typescript-eslint/parser": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-i18n-json": "^4.0.1",
     "eslint-plugin-import": "^2.32.0",
@@ -24,13 +31,12 @@
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.0.1",
     "eslint-plugin-testcafe": "^0.2.1",
-    "typescript": "^5.9.3",
-    "@typescript-eslint/parser": "^8.48.1",
-    "globals": "^15.15.0",
-    "prettier": "^3.6.2"
+    "globals": "^17.3.0",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "eslint": "^9.37.0",
+    "eslint": "^9.39.3",
     "@typescript-eslint/eslint-plugin": "^8.50.1"
   },
   "peerDependenciesMeta": {
@@ -39,7 +45,8 @@
     }
   },
   "devDependencies": {
-    "eslint": "^9.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.50.1"
+    "@typescript-eslint/eslint-plugin": "^8.50.1",
+    "eslint": "^9.39.3",
+    "husky": "^9.1.7"
   }
 }

package/scripts/git-commit-msg.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# This way you can customize which branches should be skipped when
+# prepending commit message.
+if [ -z "$BRANCHES_TO_SKIP" ]; then
+  BRANCHES_TO_SKIP=(main)
+fi
+
+# Get the current branch name
+BRANCH_NAME=$(git symbolic-ref --short HEAD)
+
+# Strip any leading prefix, up to and including, the last "/".  e.g. turn "feature/ISSUE-1234" into "ISSUE-1234"
+BRANCH_NAME="${BRANCH_NAME##*/}"
+
+BRANCH_EXCLUDED=$(printf "%s\n" "${BRANCHES_TO_SKIP[@]}" | grep -c "^$BRANCH_NAME$")
+BRANCH_IN_COMMIT=$(grep -c "^$BRANCH_NAME" $1)
+
+if [ -n "$BRANCH_NAME" ] && ! [[ $BRANCH_EXCLUDED -eq 1 ]] && ! [[ $BRANCH_IN_COMMIT -ge 1 ]]; then
+  sed -i.bak -e "1s/^/$BRANCH_NAME /" $1
+fi

package/src/configs/automation-config.js

@@ -4,7 +4,7 @@ import { automationRules } from '../rules/automation.js';
 export default [
 	{
 		files: ['test/**/*.{js,jsx,mjs,cjs}', 'tests/**/*.{js,jsx,mjs,cjs}'],
-		ignores: ['**/node_modules/*', '**/dist/*', '**/build/*'],
+		ignores: ['**/node_modules/**', '**/dist/**', '**/build/**'],
 		plugins: {
 			testcafePlugin: testcafePlugin
 		},

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

@@ -20,6 +20,9 @@ import { i18nRules, LANGUAGE_FILES_RELATIVE, i18nTextComponents } from '../rules
 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';
+
 const coreRules = {
 	...styleRules,
 	...reactRules,
@@ -27,11 +30,9 @@ const coreRules = {
 	...importRules,
 	...prettierRules,
 	...securityRules,
-	...i18nRules
+	...(disableIntl ? {} : i18nRules)
 };
 
-const intlPath = process.env.ESLINT_INTL_PATH ?? 'src/intl';
-
 const languageFilesAbsolute = LANGUAGE_FILES_RELATIVE.map(entry => ({
 	name: entry.name,
 	path: path.join(intlPath, entry.filename)
@@ -41,7 +42,7 @@ export default [
 	{
 		files: ['**/*.{js,jsx,mjs,cjs}'],
 
-		ignores: ['**/node_modules/*', '**/dist/*', '**/build/*', '**/*.graphql', '**/*.gql'],
+		ignores: ['**/node_modules/**', '**/dist/**', '**/build/**', '**/*.graphql', '**/*.gql'],
 
 		languageOptions: {
 			...parserConfig,
@@ -57,8 +58,12 @@ export default [
 			mocha: fixupPluginRules(pluginMocha),
 			prettier: pluginPrettier,
 			import: importPlugin,
-			// TODO: Upgrade `pluginPreactI18n` to a modern version to ensure compatibility with current tooling and React/Preact best practices
-			'preact-i18n': fixupPluginRules(pluginPreactI18n)
+			...(disableIntl
+				? {}
+				: {
+						// TODO: Upgrade `pluginPreactI18n` to a modern version to ensure compatibility with current tooling and React/Preact best practices
+						'preact-i18n': fixupPluginRules(pluginPreactI18n)
+					})
 		},
 
 		rules: {
@@ -73,10 +78,14 @@ export default [
 		settings: {
 			// Requires exactly version 16.0. See: https://github.com/jsx-eslint/eslint-plugin-react/issues/1754
 			react: { pragma: 'createElement', version: '16.0' },
-			'preact-i18n': {
-				languageFiles: languageFilesAbsolute,
-				textComponents: i18nTextComponents
-			}
+			...(disableIntl
+				? {}
+				: {
+						'preact-i18n': {
+							languageFiles: languageFilesAbsolute,
+							textComponents: i18nTextComponents
+						}
+					})
 		}
 	}
 ];

package/src/configs/custom-config.js

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

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

@@ -4,7 +4,7 @@ import { i18nJsonRules } from '../rules/i18n.js';
 export default [
 	{
 		files: ['**/*.json'],
-		ignores: ['**/node_modules/*', '**/dist/*', '**/build/*'],
+		ignores: ['**/node_modules/**', '**/dist/**', '**/build/**'],
 		plugins: {
 			'i18n-json': pluginI18nJson
 		},

package/src/configs/preact-i18n-config.js

@@ -0,0 +1,31 @@
+import { fixupPluginRules } from '@eslint/compat';
+import path from 'node:path';
+
+import pluginPreactI18n from 'eslint-plugin-preact-i18n';
+
+import { i18nRules, LANGUAGE_FILES_RELATIVE, i18nTextComponents } from '../rules/i18n.js';
+
+const intlPath = process.env.ESLINT_INTL_PATH ?? 'src/intl';
+
+const languageFilesAbsolute = LANGUAGE_FILES_RELATIVE.map(entry => ({
+	name: entry.name,
+	path: path.join(intlPath, entry.filename)
+}));
+
+export default {
+	files: ['**/*.{js,jsx,mjs,cjs}'],
+
+	plugins: {
+		// TODO: Upgrade `pluginPreactI18n` to a modern version to ensure compatibility with current tooling and React/Preact best practices
+		'preact-i18n': fixupPluginRules(pluginPreactI18n)
+	},
+
+	rules: i18nRules,
+
+	settings: {
+		'preact-i18n': {
+			languageFiles: languageFilesAbsolute,
+			textComponents: i18nTextComponents
+		}
+	}
+};

package/src/configs/react-config.js

@@ -0,0 +1,26 @@
+import pluginReact from 'eslint-plugin-react';
+import pluginReactHooks from 'eslint-plugin-react-hooks';
+
+import reactRules from '../rules/react.js';
+import reactHooksRules from '../rules/react-hooks.js';
+
+export default {
+	files: ['**/*.{js,jsx,mjs,cjs}'],
+
+	plugins: {
+		react: pluginReact,
+		'react-hooks': pluginReactHooks
+	},
+
+	rules: {
+		...pluginReact.configs.recommended.rules,
+		...pluginReactHooks.configs.recommended.rules,
+		...reactRules,
+		...reactHooksRules
+	},
+
+	settings: {
+		// Requires exactly version 16.0. See: https://github.com/jsx-eslint/eslint-plugin-react/issues/1754
+		react: { pragma: 'createElement', version: '16.0' }
+	}
+};