-
-
Notifications
You must be signed in to change notification settings - Fork 301
feat(cz_check): cz check can read commit message from pipe #267
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
Conversation
Codecov Report
@@ Coverage Diff @@ ## master #267 +/- ## ========================================== + Coverage 96.60% 96.62% +0.02% ========================================== Files 33 33 Lines 912 919 +7 ========================================== + Hits 881 888 +7 Misses 31 31
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, it looks great 🙂 I've also tested it on my local machine. But this feature is not obvious enough for users to find it. Could you please add some example to the documentation? Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The naming sources
does not look straightforward to me. Currently, I do not have a better name for it. But we could at least add some comments to it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it's the amount/number of params provided, so something like params_amount
or number_params_provided
could be
Nice work! Looks great, I'm not much an user of check
so Lee can decide when to merge this. But I have to say, this PR would be super cool and I'd start using something like echo "fix: bfoo bar" | cz check
.
Docs would be highly appreciated.
As #255 is merged, we can close this one
Description
As mentioned in #200, this PR makes
cz check
can read message from pipe. In this mode, "--message" option is used.Checklist
./script/format
and./script/test
locally to ensure this change passes linter check and testExpected behavior
String input from pipe can be read by
cz check
Steps to Test This Pull Request
echo COMMIT_MESSAGE | cz check
cat COMMIT_FILE | cz check
Additional context
#200