feat: configured husky/lint-staged/commitlint

emulsify-ds / compound

Compound is the default component collection for Emulsify

https://emulsify-ds.github.io/compound/

GNU General Public License v2.0

13 stars 11 forks source link

feat: configured husky/lint-staged/commitlint #12

Closed ModulesUnraveled closed 2 years ago

ModulesUnraveled commented 2 years ago

Summary This PR fixes/implements the following bugs/features

Husky
Lint-staged
Commitlint

How to review this PR

[x] Checkout this branch, and then nvm use && npm install
[x] Create errors in the js and/or css and try to commit them. Verify the commit is blocked because of the errors.
[x] Create a valid change, and try to commit with an invalid commit message git commit -am "awesome commit" and verify the commit is blocked because of the invalid message.
[x] Try again with a valid file change, and a valid commit message git commit -am "feat: awesome feature" and verify the commit succeeds

ryanhagerty commented 2 years ago

Everything seems to work great except bullet point two.

It successfully caught the broken JS I tried to commit, but not the broken CSS. Here's what I did: (no semi-colon, mismatched closing brackets)

.main-nav {
  display: none! @include medium {

ModulesUnraveled commented 2 years ago

@ryanhagerty After looking through the docs, I don't think this particular issue is something stylelint checks for. I search all of the "semicolon" related rules, and didn't find anything for this: https://stylelint.io/user-guide/rules/list/

An error like this should prevent the commit:

body .main-nav {
  display: block;
}

/* Nav */
.main-nav {
  display: none;
}

github-actions[bot] commented 2 years ago

:tada: This PR is included in version 1.0.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: