submodule-hook 0.1.0

submodules check pre commit hook
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

[![Crates.io](https://img.shields.io/crates/v/submodule-hook.svg)](https://crates.io/crates/submodule-hook)

# Pre Commit Submodule Hook

This pre-commit hook asks you to confirm when submodules are either:
* modified and not staged for commit
* modified and staged for commit

It looks like this (YMMV) if you configure it as your pre-commit hook:

```
? The following submodules are modified but not staged for commit:
* sub2 (`git add sub2` to add submodule to staging)
The following submodules are modified and staged for commit:
* sub (`git restore --staged sub` to remove submodule from staging)
Do you wish to continue anyway? (y/n) › no
```

## How to build it so that it runs with minimal dependencies (statically)

Build using musl

```
cargo build --target=x86_64-unknown-linux-musl
```

and then

```
❯ ldd target/x86_64-unknown-linux-musl/debug/submodule-hook
        statically linked
```

## How to install and configure it as my `pre-commit` hook ?

### From source

1. compile it: `cargo build --target=x86_64-unknown-linux-musl --release`
2. install it as your `pre-commit` hook: `cp target/x86_64-unknown-linux-musl/release/submodule-hook .git/hooks/pre-commit`

### From crates.io

1. install it: `cargo install submodule-hook`
2. install it as your `pre-commit` hook: `cp $(which submodule-hook) .git/hooks/pre-commit`


## How to uninstall it ?

Remove the hook using: `rm .git/hooks/pre-commit`

If you installed it from crates.io, you can remove the binary from your `~/.cargo/bin` directory using: `cargo uninstall submodule-hook`

## Can I try it without setting it as my `pre-commit` hook ?

Yes, you can run it manually:

```
submodule-hook --repo <path-to-your-repo>
```

## Configuration

Configuration is evaluated in this order:

1. global `~/.gitconfig`
2. local `.git/config`
3. CLI parameters cf `cargo run -- --help`
4. if no configuration is found it assumes `strict = false`, `staging = true`, `notstaging = true`

Edit local `.git/config` or global `~/.gitconfig`

```toml
[submodulehook]
    # if true the hook will fail when opening repository or submodule fails
    strict = false
    # if true also ask for confirmation before commit when a submodule is modified and staged
    staging = true
    # if true also ask for confirmation before commit when a submodule is modified and not staged
    notstaging = true
```

> if both `staging` and `notstaging` are set to `false` then the hook will be disabled

Or use `git config`:

```
git config submodulehook.strict false
git config submodulehook.staging true
git config submodulehook.notstaging true
```

## CHANGELOG

Please see the [CHANGELOG](CHANGELOG.md) for a release history.