Holllo/hooked
Holllo
/
hooked
1
Fork 0
Code Issues 3 Releases 1 Activity

Compare commits

base: Holllo:651699c40aeff48c6af797c7182bcd3f83171d31
Branches Tags
Holllo:main
Holllo:0.1.0
...
compare: Holllo:4a4974fa3526cdd831914ac2b8572527008ea3b8
Branches Tags
Holllo:main
Holllo:0.1.0

2 Commits
651699c40a ... 4a4974fa35

Author SHA1 Message Date
Bauke 4a4974fa35
Add git_staged documentation. 2022-11-20 13:07:32 +01:00
Bauke e4ed623e64
Skip hook if no globs are matched. 2022-11-20 12:57:58 +01:00
2 changed files with 10 additions and 9 deletions
Show Stats Expand all files Collapse all files

3
hooked-book/source/configuration/README.md
View File

@ -29,6 +29,7 @@ Pre-commit hooks are defined using `pre_commit` [arrays of tables][toml-arrays-o
| command[^command-and-script] | String | | A command to run when the hook is called. | | command[^command-and-script] | String | | A command to run when the hook is called. |
| script[^command-and-script] | String | | A script to run when the hook is called. This script should be executable and be located inside the configured general directory. | | script[^command-and-script] | String | | A script to run when the hook is called. This script should be executable and be located inside the configured general directory. |
| on_failure | String | stop | What to do when the hook task returns a non-zero status code. Can be either "continue" or "stop". | | on_failure | String | stop | What to do when the hook task returns a non-zero status code. Can be either "continue" or "stop". |
| git_staged | Optional list of strings | | A list of [globs][globset-docs] that will be checked against staged files. If none of the globs match the hook will be skipped. With no globs defined at all the hook will always run. |
```toml ```toml
[[pre_commit]] [[pre_commit]]
@ -39,6 +40,7 @@ command = "echo \"Hey, $USER!\""
name = "Script Example" name = "Script Example"
script = "example.sh" script = "example.sh"
on_failure = "continue" on_failure = "continue"
git_staged = ["*.txt"]
``` ```
## Footnotes ## Footnotes
@ -46,5 +48,6 @@ on_failure = "continue"
[^command-and-script]: When both a command and script are defined in a hook, *only* the command will be run. [^command-and-script]: When both a command and script are defined in a hook, *only* the command will be run.
[cli-install]: ../cli/install.md [cli-install]: ../cli/install.md
[globset-docs]: https://docs.rs/globset/0.4.9/globset/#syntax
[toml-table]: https://toml.io/en/v1.0.0#table [toml-table]: https://toml.io/en/v1.0.0#table
[toml-arrays-of-tables]: https://toml.io/en/v1.0.0#array-of-tables [toml-arrays-of-tables]: https://toml.io/en/v1.0.0#array-of-tables

16
hooked-cli/source/cli/run.rs
View File

@ -53,15 +53,13 @@ pub fn hooked_run(config: Config, hook_type: String) -> Result<()> {
.args(&["diff", "--name-only", "--cached"]) .args(&["diff", "--name-only", "--cached"])
.capture()? .capture()?
.stdout_str(); .stdout_str();
for line in staged_files.lines() { if !staged_files.lines().any(|line| globs.is_match(line)) {
if globs.is_match(line) { println!(
println!( "\t{} {}",
"\t{} {}", "≫".style(skipped_style),
"≫".style(skipped_style), hook_name.style(skipped_style)
hook_name.style(skipped_style) );
); continue 'hook_loop;
continue 'hook_loop;
}
} }
} }