search

LinusU / emoji-commit

44 stars 6 forks source link

Validate #12

Closed cstruct closed 3 years ago

cstruct commented 3 years ago

Help text:

emoji-commit 0.1.5
Make your git logs beautiful and readable with the help of emojis 🎉

USAGE:
    emoji-commit [OPTIONS] [--] [out-path]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --validate <refspecs>...    Validate the provided refspecs against the commit rules. Refspecs can be passed as
                                    is or in the special notation defined in git-rev-list.

ARGS:
    <out-path>    Path passed by Git where commit message should be written to. Path will be passed through to
                  $EDITOR if doing a interactive rebase.

Passing invalid <out-path>:

❯ emoji-commit foo
error: Invalid value for '<out-path>': Must end with one of .git/COMMIT_EDITMSG and .git/rebase-merge/git-rebase-todo

Using mutually exclusive options:

❯ emoji-commit foo --validate main...HEAD
error: The argument '<out-path>' cannot be used with one or more of the other specified arguments

USAGE:
    emoji-commit <out-path|--validate <refspecs>...>

For more information try --help

Help text: image

Validate:

❯ emoji-commit --validate HEAD~3..HEAD

Commit:
    WIP

Validation Errors:
    ✖ Commit message has to begin with one of the following emojis: 💥, 🎉, 🐛, 🔥, 🌹

Commit:
    🎉 frobnicate bar

Validation Errors:
    ✖ Capitalize the subject line

Error: ValidationError
❯ echo $status
1
LinusU commented 3 years ago

Thanks for this!

Release as 🚢 0.1.6 / 2021-06-08