docs: update eslint config and document choices

- Set `func-style` to 'off' to allow developer flexibility
- Document key ESLint configuration choices in `best-practices.md`
- Enhance ESLint rules for better code quality and consistency

Author: tim-sh

docs/best-practices.md

@@ -120,3 +120,15 @@ When adding new code to the project, follow these guidelines:
 5. Perform a self-review before submitting your code for review
 
 Remember, the goal is to write code that is easy to understand, maintain, and extend. When in doubt, prioritize readability and simplicity over cleverness.
+
+## ESLint Configuration
+
+Key configuration choices:
+
+- `func-style`: Off. Use the most appropriate function style for each situation.
+- `no-nested-ternary`: Removed. Use newlines for readability in nested ternaries.
+- `no-param-reassign`: Warn. Consider alternatives to parameter reassignment.
+- `object-shorthand`: Warn. Use concise object literal syntax when possible.
+- `require-await`: Warn. Ensure async functions use `await`.
+
+These rules guide code quality and consistency. Use good judgment in their application.

eslint.config.mjs

@@ -12,7 +12,20 @@ export default [
         },
         rules: {
             'no-unused-vars': ['warn', { argsIgnorePattern: 'lazy' }],
-            'no-extra-semi': 1,
+            'no-extra-semi': 'warn',
+            'max-len': ['warn', { 'code': 120 }],
+            'complexity': ['warn', 15],
+            'max-params': ['warn', 4],
+            'no-param-reassign': 'warn',
+            'prefer-const': 'warn',
+            'no-var': 'error',
+            'object-shorthand': 'warn',
+            'prefer-template': 'warn',
+            'func-style': ['off'],
+            'no-else-return': 'warn',
+            'prefer-arrow-callback': 'warn',
+            'require-await': 'warn',
+            'no-duplicate-imports': 'error',
         },
     }
-]
+]