Configure ESLint Rules for Streamlined Code Quality Checks

[addynoven]

Context

As developers, we want to configure ESLint rules in our project to maintain code quality without relying on the VSCode ESLint extension, ensuring that checks run on file save or when the program is executed. Currently, our project does not have a properly configured ESLint setup, leading to inconsistencies in code quality and style. By configuring ESLint to run automatically on save or during program execution, we can ensure that our code adheres to predefined standards without being hindered by VSCode's ESLint extension.

Tasks

• Research and select appropriate ESLint rules that fit our coding standards.
• Set up ESLint configuration files (.eslintrc.js or .eslintrc.json) in the project.
• Install ESLint and any necessary plugins as dev dependencies.
• Configure ESLint to run automatically on file save using scripts or tools like husky or lint-staged.
• Ensure ESLint runs as part of the build or test process.
• Update the documentation to reflect the new ESLint setup and usage instructions.

Acceptance Criteria (Checks)

• ESLint is installed and listed as a dev dependency in package.json.
• ESLint configuration file is created and contains relevant rules.
• ESLint checks run automatically on file save or program execution.
• The documentation is updated to include instructions on how to use ESLint in the project.
• The team is informed about the ESLint setup and how to use it.

Additional Information and Useful Links

• ESLint Documentation
• ESLint Configuration File Format
• Husky Documentation
• Lint-Staged Documentation
• Best Practices for ESLint Configuration