CI(pre-commit hooks): Enforce rules with Husky

[EandrewJones]

Problem

We do not enforce any coding conventions on the project. Which, over time, leads to inconsistencies across the code base, code smells, etc.

Solution

• linting (eslint)
• formatting (prettier)
• TS rules

Enforce then prior to commit (pre-commit) via Husky.

[rc10house]

Assigned to me

[EandrewJones]

@rc10house

Decent blog for setting up eslint and prettier:
https://blog.logrocket.com/linting-typescript-eslint-prettier/

Example of a pre-commit script from my previous start up:

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

echo '🏗️👷 Styling, testing and building your project before committing'

# Check Prettier standards
yarn run check-format ||
(
    echo "🙈 Afraid to look! Your styling needs fixing. 🙈
    Prettier Check Failed. Run yarn run format, add changes and try commit again.";
    false;
)

# Check ESLint Standards
yarn run check-lint ||
(
    echo '😤😡😤 Your failure to adhere to our standards is disappointing. Try again. 😤😡😤
    ESLint Check Failed. Make the required changes listed above, add changes and try to commit again.'
    false;
)

# Check tsconfig standards
yarn run check-types ||
(
    echo '❌🔍 Upon closer inspection, your Types failed. 🔎❌
    Are you seriously trying to write that? Make the changes required above.'
    false;
)

# If everything passes... Now we can commit
echo '🤔🤔🤔🤔... Alright... Code looks good to me... Trying to build now. 🤔🤔🤔🤔'

yarn run build ||
(
    echo '❌👷🔨❌ Better call Bob... Because your build failed ❌👷🔨❌
            Vite build failed: View the errors above to see why.
    '
    false;
)

# After build, run unit tests
# Right now, runs all tests. Later scope to just unit tets, we can add e2e/integration as github actions on merge
yarn run test ||
(
     echo '🧪💥🧪💥 Uh oh! Looks like you broke something or failed to write tests 🧪💥🧪💥
             Cypress tests failed: View the logs to see what broke and fix it before re-committing.
    '
    false;
)

# If everything passes... Now we can commit
echo '✅🚀✅🚀 QuestStudio approves... Your contribution is appreciated and accepted for commit. ✅🚀✅🚀'

Obviously, need to switch from yarn --> npm and change some of the messaging/comments.