Code Quality : Linting and formatting

[ezehlivinus]

Description

This defined coding standards (code quality) and formatting styles. This was done to help collaborators follow the same style to avoid inconsistency and quality of code.
To do this, ESLint was used as a linting tool for code quality and prettier was used as a formatting tool. The standard extended is the Airbnb JavaScript style guide.
As a result, ESLint and its peer dependencies.

Fixes #60 (issue)

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Chore: update coding style/standard

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[ezehlivinus]

I have tested this in a separate branch. Review, if it is okay, then you can run npm run lint:format. Why I did not do this myself is because most of the existing code would be formatted. As a result, it would show that I made changes in all the files at least for the first time. This will help see the small changes that were made without lifting and formatting the whole code.

After your review, we can lint it.

[ezehlivinus]

Note that the lint and format are run by the developer. If the person forgets, then the code still gets pushed. No pre-hook like the one described here or some kind of CI automation.

@anomic30

[anomic30]

Should we include a prettierignore file to ignore node modules when linting?

[ezehlivinus]

Should we include a prettierignore file to ignore node modules when linting?

Yes yes. I didn't add that because prettier ignores that by default... But we can excilicitly ignore that.

@anomic30

[ezehlivinus]

Also @ezehlivinus, can you add a pre-commit hook so that the code is formatted properly? Maybe use husky

Okay fine.

I am trying to finish or fix up #71 ...PR

[anomic30]

LGTM!

[anomic30]

Also @ezehlivinus, can you add a pre-commit hook so that the code is formatted properly? Maybe use husky

Okay fine.

I am trying to finish or fix up #71 ...PR

We can set it up later.