inklog 0.1.2

Enterprise-grade Rust logging infrastructure
Documentation 
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
95
96

# Pre-commit Hook

This directory contains the pre-commit hook for the Inklog project.

## Installation

Run the installation script to set up the pre-commit hook:

```bash
# From the project root directory
./scripts/install-pre-commit.sh
```

Or manually create the symlink:

```bash
ln -s ../../scripts/pre-commit .git/hooks/pre-commit
```

## What It Checks

Before each commit, the pre-commit hook automatically runs:

1. **Code Formatting** (`cargo fmt`)
   - Ensures all code follows the project's formatting standards
   - Uses `cargo fmt --all -- --check`

2. **Clippy Linting** (`cargo clippy`)
   - Performs static analysis to catch common mistakes
   - Uses strict warning level: `-D warnings`
   - Only checks library code (not test files)

3. **Compilation Check** (`cargo check`)
   - Verifies the code compiles successfully
   - Uses `cargo check --all-features`

4. **Unit Tests** (`cargo test`)
   - Runs the library unit tests
   - Uses `cargo test --lib --all-features`

## Skipping the Hook

To skip the pre-commit hook for a single commit:

```bash
git commit --no-verify -m "Your commit message"
```

Or use the short form:

```bash
git commit -n -m "Your commit message"
```

## Configuration

The pre-commit hook is located at `scripts/pre-commit`. You can modify it to:

- Add additional checks
- Adjust test timeout
- Change the number of test threads
- Skip specific checks

## Troubleshooting

### Hook not running

Ensure the pre-commit hook is executable:

```bash
chmod +x scripts/pre-commit
```

### Slow pre-commit checks

The hook runs a subset of tests by default. If it's still slow:

1. Reduce the number of test threads: Edit the `--test-threads` value
2. Skip tests temporarily: Comment out the test check

### False positives

If you're seeing false positives from clippy, ensure you're using the latest stable Rust:

```bash
rustup update stable
cargo update
```

## Integration with CI

The pre-commit hook mirrors the checks performed by the GitHub CI pipeline:

- CI Workflow: [`.github/workflows/ci.yml`](../../.github/workflows/ci.yml)
- Pre-commit checks are a fast subset of CI checks
- Full CI runs on every push to `main` and `develop` branches