Prettier precommit hook

[josh-lester]

Purpose

• ...

Adds initial setup for running prettier during commit so that code styles are always followed

#35

Does this introduce a breaking change?

[ ] Yes
[ x] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ x] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[ ] Other... Please describe:

How to Test

• Get the code

git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install

• Test the code

What to Check

Verify that the following are valid

• ...

Other Information

adding prettier styling to the repo.

Also adds a nice prettier configuration badge to the readme file to show that prettier is used

[josh-lester]

@johnpapa I figured if i went ahead and opened a PR then you can pull it down and play around if you wanted until we find what works best

[johnpapa]

thanks!

[johnpapa]

change to 80 please

[josh-lester]

sure, if you want me to switch the staged files over to the add script you pointed out, i can change that too while im at it

[johnpapa]

not sure we need this file. there are some files outside of src which are fine to pretty. let's make this file blank

[josh-lester]

👍

[johnpapa]

update to 80 chars and i think we're good.

@wardbell should try this out before we merge

[johnpapa]

do we also need this?

  "precommit": ["precommit"],

[josh-lester]

it looks like pretty-quick is using husky according to the documentation. looking to see if i can find any more information about that

[josh-lester]

Husky can prevent bad git commit, git push and more

this is from the husky repo...
i could be wrong but it sounds like husky purpose is to prevent you from committing if your precommit fails.

Honestly i was just following the docs on prettier site and installed the things they said to install.

I can remove if wanted

[johnpapa]

i think we are good. i tested this elsewhere and here is hwat I have:

npm i husky prettier pretty-quick -D

Then i added this to the package.json, inside of scripts

    "pretty-quick": "pretty-quick",
    "precommit": "pretty-quick --staged"

The first one is for formatting the entire project, the latter for the hook that husky calls

[johnpapa]

@wardbell - please take a look. if you like this, let's merge

[johnpapa]

thanks for the PR!