Add-ESLint-rules-for-code-quality-enforcement

[Habibah371]

PR Description

Summary

This PR strengthens the project's linting and static analysis configuration by introducing a comprehensive ESLint ruleset focused on code quality, maintainability, and consistency. The update enforces stricter coding standards, reduces technical debt, and helps catch common issues early during development.

Changes Implemented

✅ Enhanced ESLint Configuration

• Updated ESLint setup with stricter code quality rules.
• Added recommended TypeScript and best-practice linting rules.
• Standardized project-wide coding conventions.

✅ Complexity Enforcement

• Added cyclomatic complexity checks with a maximum complexity threshold of 10.
• Configured linting rules to flag overly complex functions and encourage code decomposition.

✅ Dead Code Detection

• Enabled detection of:

  • Unused variables
  • Unused imports
  • Unused function parameters
  • Unreachable code paths

• Helps keep the codebase clean and maintainable.

✅ Type Safety Improvements

• Disallowed usage of any through TypeScript ESLint rules.
• Enforced explicit typing patterns to improve reliability and developer experience.

✅ Naming Convention Standards

• Added naming convention rules for:

  • Variables
  • Functions
  • Classes
  • Interfaces
  • Enums
  • Constants

• Ensures consistent and predictable code structure across the project.

✅ Developer Documentation

• Added documentation describing:

  • Configured ESLint rules
  • Rule rationale
  • Examples of compliant and non-compliant code

• Included guidance for resolving common lint violations.

✅ IDE Support

• Added/recommended IDE configuration files and settings to provide:

  • Real-time lint feedback
  • Automatic formatting integration
  • Consistent developer experience across environments

Benefits

• Improves overall code quality and consistency.
• Prevents common bugs and anti-patterns from reaching production.
• Encourages maintainable, readable code.
• Reduces review overhead by automating style and quality checks.
• Provides a standardized development experience for all contributors.

Testing

• Verified ESLint runs successfully across the codebase.
• Confirmed complexity, naming convention, dead code, and any type violations are correctly detected.
• Validated IDE integration and linting workflow documentation.

Acceptance Criteria Checklist

• ESLint configuration updated with strict rules
• Complexity limits enforced (max 10)
• Dead code detection enabled
• No any types allowed
• Naming conventions enforced
• Documentation of all rules added
• IDE configuration provided
  Closes Add ESLint rules for code quality enforcement #535

[RUKAYAT-CODER]

Kindly resolve conflict.

[drips-wave]

@Habibah371 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

[RUKAYAT-CODER]

LGTM
Thank you for contributing to the project.