build: Add commitzen and lint-staged

[f2prateek]

Adds commitzen as a dev dependency so we can write better commit messages. Also adds lint-staged as a dev dependency, which was overlooked from a previous commit when integrating Prettier.

[codecov-io]

Codecov Report

Merging #98 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #98   +/-   ##
=======================================
  Coverage   98.58%   98.58%           
=======================================
  Files          11       11           
  Lines         636      636           
=======================================
  Hits          627      627           
  Misses          9        9

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1187fc3...caa6d0b. Read the comment docs.

[fathyb]

nit: I think "path": "cz-conventional-changelog" should be enough.

[fathyb]

This means that precommit will be executed twice, the first time by npm before commit and the second time by husky after commit. See typicode/husky#99 for some workarounds.

[fathyb]

Also adds lint-staged as a dev dependency, which was overlooked from a previous commit when integrating Prettier.

I'm not sure to understand this part. I don't see anything related to lint-staged in the changes.

---

I'm a big commitizen fan but I'm not sure if this is the most adapted tool for this project. It's an excellent tool to help new contributors onbard with a project commit convention but may just end up slowing down some users (eg. I'm familiar with this convention and use it everywhere but like to commit using tig to review changes as I commit).

While I think we should keep it for new users we should use something like commitlint and husky's commitmsg hook to ensure any commit made using any client/tool (like commitizen, tig, GitKraken, etc...) is conform to our convention. It could also help check that PRs are conform to the convention. What do you think?

[f2prateek]

Re:lint-staged, this is because without adding it as a dev dependency, yarn commit will fail because the user may not have lint-staged installed. This likely wasn't exposed before because there was no reason to run yarn commit previously.

Down to try other tools here! My main goal is to be able to generate more friendly changelog from commit messages.

[fathyb]

Re:lint-staged, this is because without adding it as a dev dependency, yarn commit will fail because the user may not have lint-staged installed. This likely wasn't exposed before because there was no reason to run yarn commit previously.

I meant that there is no changes about lint-staged in the PR git diff, it's already in the devDependencies in master. Just wanted to be sure it was intentional and not a base branch problem or something like that.

[fathyb]

A remark about npm/husky hooks, but LGTM otherwise. Really like conventional commits 👍

[f2prateek]

You're right - not sure why lint-staged wasn't setup locally, I must have not pulled from master properly. I'll update the PR Description.

[f2prateek]

While I think we should keep it for new users we should use something like commitlint and husky's commitmsg hook to ensure any commit made using any client/tool (like commitizen, tig, GitKraken, etc...) is conform to our convention. It could also help check that PRs are conform to the convention. What do you think?

@fathyb I think we should do these! I'll close this one for now, but feel free to send a PR to set those up.