Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update installation and examples #960

Merged
merged 1 commit into from Apr 2, 2021
Merged

Conversation

typicode
Copy link
Contributor

@typicode typicode commented Apr 1, 2021

Husky 6 has been released and is MIT. It's only 6 kB now with the same main features as husky 4.
mrm-lint-staged-task has been updated too.

@iiroj
Copy link
Member

iiroj commented Apr 1, 2021

It's a bit back-and-forth, but I assume this fixes #958

@typicode
Copy link
Contributor Author

typicode commented Apr 1, 2021

I assume this fixes #958

Yes, hooks can directly be edited in .husky without having to re-run/generate anything (just like husky 4 actually).
And husky install is only used to tell Git where hooks are (it doesn't generate anything, just configures Git).

Copy link
Member

@iiroj iiroj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this means npx mrm lint-staged also runs husky install, does it mean re-running it in an existing repo will migrate and install the hooks?

Should there be something in the README about running npx husky install?

Anyways, look good to me. 👍

EDIT: that is to say, if someone upgrades a repo with multiple collaborators back to husky v6 using this, will others have to run something on their end?

@typicode
Copy link
Contributor Author

typicode commented Apr 1, 2021

will others have to run something on their end?

Besides running npm install to get the new dependency (husky 6), no.
prepare will be triggered by npm install and will take care of setting the correct Git hooks directory. Hooks will in turn work for others automatically.

Does that answer your question or you meant something else?

@iiroj
Copy link
Member

iiroj commented Apr 1, 2021

@typicode yes, thanks. It seems the migration to simple-git-hooks In mrm had some broken behaviour related to this, so just wanted to make sure.

@iiroj
Copy link
Member

iiroj commented Apr 1, 2021

@okonet any thoughts?

EDIT: It seems GitHub Actions are having troubles with the macOS tests.

@codecov
Copy link

codecov bot commented Apr 2, 2021

Codecov Report

Merging #960 (d88d62f) into master (d1207d2) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #960   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           18        18           
  Lines          611       611           
  Branches       144       144           
=========================================
  Hits           611       611           

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 d1207d2...d88d62f. Read the comment docs.

@iiroj
Copy link
Member

iiroj commented Apr 2, 2021

Well, I'll merge this in any case, since the mrm package has already been updated. Thanks, @typicode!

@iiroj iiroj merged commit 101ad5e into lint-staged:master Apr 2, 2021
@okonet
Copy link
Collaborator

okonet commented Apr 2, 2021

Thanks for submitting and merging! I’m good with this PR and sorry for being silent. Too many things going on right now.

@github-actions
Copy link
Contributor

github-actions bot commented May 7, 2021

🎉 This PR is included in version 11.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

npx simple-git-hooks npx mrm lint-staged does not work after husky v5+
3 participants