Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Code Quality with Linting and Formatting Tools #2043

Open
Mil4n0r opened this issue Jul 23, 2024 · 1 comment
Open

Enhance Code Quality with Linting and Formatting Tools #2043

Mil4n0r opened this issue Jul 23, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request jira This task is referenced in a story of Jira non-closable This task is exempt from becoming stale or automatically closed.

Comments

@Mil4n0r
Copy link
Collaborator

Mil4n0r commented Jul 23, 2024

Describe the solution you'd like
We want to follow the best practices and achieve a higher code quality by using the following automatic tools:

  • ESLint: A tool for identifying and reporting on patterns found in JS/TS code.
  • Prettier: An opinionated code formatter that enforces a consistent style by parsing code and reprinting it.
  • Husky: A tool that allows running scripts at various stages of the Git lifecycle, ensuring quality checks are performed before commits.
  • lint-staged: A tool that runs linters on staged files, ensuring only the relevant files are checked during commits.

Describe alternatives you've considered

  • Manual Code Reviews: Relying solely on manual code reviews for enforcing coding standards. However, this can be time-consuming and prone to human error.
  • Other Linting Tools: Considering alternatives such as JSHint or TSLint. ESLint was chosen due to its wide adoption and flexibility.
  • Pre-commit Scripts Without Husky: Implementing custom pre-commit scripts without using Husky. While possible, Husky simplifies the setup and maintenance of Git hooks.

Additional context
For more information, there is a DSDR called "Code and commit quality improvement" in Halstack Wiki

Copy link

Thank you for opening an issue! 🚀

Our team will review it as soon as possible. In the meantime, please make sure that you've provided all the necessary details to help us understand and address the issue effectively.

Feel free to contribute and participate in discussions!

@Mil4n0r Mil4n0r mentioned this issue Jul 23, 2024
5 tasks
@Mil4n0r Mil4n0r self-assigned this Jul 24, 2024
@Mil4n0r Mil4n0r added enhancement New feature or request jira This task is referenced in a story of Jira non-closable This task is exempt from becoming stale or automatically closed. labels Jul 24, 2024
@Mil4n0r Mil4n0r mentioned this issue Aug 13, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request jira This task is referenced in a story of Jira non-closable This task is exempt from becoming stale or automatically closed.
Projects
None yet
Development

No branches or pull requests

1 participant