Skip to content

Commit f7842a4

Browse files
committed
Fix formatting across workspace
1 parent 737c81f commit f7842a4

File tree

7 files changed

+56
-56
lines changed

7 files changed

+56
-56
lines changed

.github/workflows/optimized-ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ jobs:
7676
path: target
7777
key: ${{ runner.os }}-cargo-build-${{ hashFiles('**/Cargo.lock') }}
7878
- name: Clippy CLI crate
79-
run: cargo clippy -p code-guardian-cli --all-targets --all-features -- -D warnings
79+
run: cargo clippy -p code_guardian_cli --all-targets --all-features -- -D warnings
8080

8181
clippy-core:
8282
runs-on: ubuntu-latest
@@ -143,7 +143,7 @@ jobs:
143143
path: target
144144
key: ${{ runner.os }}-cargo-test-${{ hashFiles('**/Cargo.lock') }}
145145
- name: Test CLI crate
146-
run: cargo test -p code-guardian-cli
146+
run: cargo test -p code_guardian_cli
147147

148148
test-core:
149149
runs-on: ubuntu-latest

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ cd code-guardian
4242
cargo build --release
4343
```
4444

45-
The binary will be available at `target/release/code-guardian-cli`.
45+
The binary will be available at `target/release/code_guardian_cli`.
4646

4747
## Usage
4848

docs/tutorials/advanced-usage.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -94,18 +94,18 @@ jobs:
9494
uses: dtolnay/rust-toolchain@stable
9595

9696
- name: Build Code-Guardian
97-
run: cargo build --release --bin code-guardian-cli
97+
run: cargo build --release --bin code_guardian_cli
9898

9999
- name: Scan for TODOs
100100
run: |
101-
./target/release/code-guardian-cli scan . --db /tmp/scans.db
101+
./target/release/code_guardian_cli scan . --db /tmp/scans.db
102102
103103
- name: Check TODO count
104104
run: |
105-
SCAN_ID=$(./target/release/code-guardian-cli history --db /tmp/scans.db | tail -1 | awk '{print $2}' | tr -d ',')
106-
COUNT=$(./target/release/code-guardian-cli report "$SCAN_ID" --db /tmp/scans.db --format json | jq '.matches | length')
105+
SCAN_ID=$(./target/release/code_guardian_cli history --db /tmp/scans.db | tail -1 | awk '{print $2}' | tr -d ',')
106+
COUNT=$(./target/release/code_guardian_cli report "$SCAN_ID" --db /tmp/scans.db --format json | jq '.matches | length')
107107
echo "Found $COUNT TODO/FIXME items"
108-
./target/release/code-guardian-cli report "$SCAN_ID" --db /tmp/scans.db --format markdown >> $GITHUB_STEP_SUMMARY
108+
./target/release/code_guardian_cli report "$SCAN_ID" --db /tmp/scans.db --format markdown >> $GITHUB_STEP_SUMMARY
109109
110110
# Optional: fail if too many TODOs
111111
if [ "$COUNT" -gt 50 ]; then
@@ -125,14 +125,14 @@ pipeline {
125125
steps {
126126
sh '''
127127
# Build Code-Guardian
128-
cargo build --release --bin code-guardian-cli
128+
cargo build --release --bin code_guardian_cli
129129

130130
# Run scan
131-
./target/release/code-guardian-cli scan . --db scans.db
131+
./target/release/code_guardian_cli scan . --db scans.db
132132

133133
# Get scan ID and generate report
134-
SCAN_ID=$(./target/release/code-guardian-cli history --db scans.db | tail -1 | awk '{print $2}' | tr -d ',')
135-
./target/release/code-guardian-cli report $SCAN_ID --db scans.db --format html > scan-report.html
134+
SCAN_ID=$(./target/release/code_guardian_cli history --db scans.db | tail -1 | awk '{print $2}' | tr -d ',')
135+
./target/release/code_guardian_cli report $SCAN_ID --db scans.db --format html > scan-report.html
136136
'''
137137
138138
publishHTML(target: [

docs/tutorials/automation.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,20 @@ Add a pre-commit hook to prevent commits with too many new TODOs:
2323
# .git/hooks/pre-commit
2424

2525
# Build code-guardian if needed
26-
# cargo build --release --bin code-guardian-cli
26+
# cargo build --release --bin code_guardian_cli
2727

2828
DB_PATH=".code-guardian.db"
2929
SCAN_DIR="."
3030

3131
# Run scan
32-
./target/release/code-guardian-cli scan "$SCAN_DIR" --db "$DB_PATH" > /dev/null 2>&1
32+
./target/release/code_guardian_cli scan "$SCAN_DIR" --db "$DB_PATH" > /dev/null 2>&1
3333

3434
# Get latest scan ID
35-
SCAN_ID=$(./target/release/code-guardian-cli history --db "$DB_PATH" 2>/dev/null | tail -1 | awk '{print $2}' | tr -d ',')
35+
SCAN_ID=$(./target/release/code_guardian_cli history --db "$DB_PATH" 2>/dev/null | tail -1 | awk '{print $2}' | tr -d ',')
3636

3737
if [ -n "$SCAN_ID" ]; then
3838
# Count matches
39-
COUNT=$(./target/release/code-guardian-cli report "$SCAN_ID" --db "$DB_PATH" --format json 2>/dev/null | jq '.matches | length' 2>/dev/null || echo "0")
39+
COUNT=$(./target/release/code_guardian_cli report "$SCAN_ID" --db "$DB_PATH" --format json 2>/dev/null | jq '.matches | length' 2>/dev/null || echo "0")
4040

4141
echo "Found $COUNT TODO/FIXME items in this commit"
4242

@@ -74,20 +74,20 @@ jobs:
7474
uses: dtolnay/rust-toolchain@stable
7575

7676
- name: Build Code-Guardian
77-
run: cargo build --release --bin code-guardian-cli
77+
run: cargo build --release --bin code_guardian_cli
7878

7979
- name: Scan codebase
80-
run: ./target/release/code-guardian-cli scan . --db /tmp/scans.db
80+
run: ./target/release/code_guardian_cli scan . --db /tmp/scans.db
8181

8282
- name: Generate report
8383
run: |
84-
SCAN_ID=$(./target/release/code-guardian-cli history --db /tmp/scans.db | tail -1 | awk '{print $2}' | tr -d ',')
85-
./target/release/code-guardian-cli report $SCAN_ID --db /tmp/scans.db --format markdown >> $GITHUB_STEP_SUMMARY
84+
SCAN_ID=$(./target/release/code_guardian_cli history --db /tmp/scans.db | tail -1 | awk '{print $2}' | tr -d ',')
85+
./target/release/code_guardian_cli report $SCAN_ID --db /tmp/scans.db --format markdown >> $GITHUB_STEP_SUMMARY
8686
8787
- name: Check thresholds
8888
run: |
89-
SCAN_ID=$(./target/release/code-guardian-cli history --db /tmp/scans.db | tail -1 | awk '{print $2}' | tr -d ',')
90-
COUNT=$(./target/release/code-guardian-cli report $SCAN_ID --db /tmp/scans.db --format json | jq '.matches | length')
89+
SCAN_ID=$(./target/release/code_guardian_cli history --db /tmp/scans.db | tail -1 | awk '{print $2}' | tr -d ',')
90+
COUNT=$(./target/release/code_guardian_cli report $SCAN_ID --db /tmp/scans.db --format json | jq '.matches | length')
9191
9292
if [ "$COUNT" -gt 100 ]; then
9393
echo "❌ Too many TODO/FIXME items: $COUNT"
@@ -121,23 +121,23 @@ jobs:
121121
uses: dtolnay/rust-toolchain@stable
122122

123123
- name: Build Code-Guardian
124-
run: cargo build --release --bin code-guardian-cli
124+
run: cargo build --release --bin code_guardian_cli
125125

126126
- name: Scan and analyze
127127
run: |
128128
# Use persistent database
129-
./target/release/code-guardian-cli scan . --db scans.db
129+
./target/release/code_guardian_cli scan . --db scans.db
130130
131131
# Get all scan IDs
132-
SCAN_IDS=$(./target/release/code-guardian-cli history --db scans.db | awk '{print $2}' | tr -d ',' | tail -10)
132+
SCAN_IDS=$(./target/release/code_guardian_cli history --db scans.db | awk '{print $2}' | tr -d ',' | tail -10)
133133
134134
echo "# Code-Guardian Trend Report" >> trend-report.md
135135
echo "" >> trend-report.md
136136
echo "| Scan ID | Date | TODO Count | FIXME Count | Total |" >> trend-report.md
137137
echo "|---------|------|------------|-------------|-------|" >> trend-report.md
138138
139139
for id in $SCAN_IDS; do
140-
JSON=$(./target/release/code-guardian-cli report $id --db scans.db --format json)
140+
JSON=$(./target/release/code_guardian_cli report $id --db scans.db --format json)
141141
DATE=$(echo "$JSON" | jq -r '.timestamp | strftime("%Y-%m-%d")')
142142
TODO_COUNT=$(echo "$JSON" | jq '.matches | map(select(.pattern == "TODO")) | length')
143143
FIXME_COUNT=$(echo "$JSON" | jq '.matches | map(select(.pattern == "FIXME")) | length')
@@ -169,15 +169,15 @@ pipeline {
169169
steps {
170170
sh '''
171171
# Build tool
172-
cargo build --release --bin code-guardian-cli
172+
cargo build --release --bin code_guardian_cli
173173

174174
# Run scan
175-
./target/release/code-guardian-cli scan . --db scans.db
175+
./target/release/code_guardian_cli scan . --db scans.db
176176

177177
# Generate reports
178-
SCAN_ID=$(./target/release/code-guardian-cli history --db scans.db | tail -1 | awk '{print $2}' | tr -d ',')
179-
./target/release/code-guardian-cli report $SCAN_ID --db scans.db --format html > scan-report.html
180-
./target/release/code-guardian-cli report $SCAN_ID --db scans.db --format json > scan-data.json
178+
SCAN_ID=$(./target/release/code_guardian_cli history --db scans.db | tail -1 | awk '{print $2}' | tr -d ',')
179+
./target/release/code_guardian_cli report $SCAN_ID --db scans.db --format html > scan-report.html
180+
./target/release/code_guardian_cli report $SCAN_ID --db scans.db --format json > scan-data.json
181181
'''
182182
183183
publishHTML(target: [
@@ -229,13 +229,13 @@ FROM rust:1.70-slim as builder
229229

230230
WORKDIR /app
231231
COPY . .
232-
RUN cargo build --release --bin code-guardian-cli
232+
RUN cargo build --release --bin code_guardian_cli
233233

234234
FROM debian:bullseye-slim
235235

236236
RUN apt-get update && apt-get install -y ca-certificates && rm -rf /var/lib/apt/lists/*
237237

238-
COPY --from=builder /app/target/release/code-guardian-cli /usr/local/bin/code-guardian
238+
COPY --from=builder /app/target/release/code_guardian_cli /usr/local/bin/code-guardian
239239

240240
CMD ["code-guardian", "--help"]
241241
```

docs/tutorials/custom-detectors.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -228,22 +228,22 @@ jobs:
228228
uses: dtolnay/rust-toolchain@stable
229229

230230
- name: Build Code-Guardian
231-
run: cargo build --release --bin code-guardian-cli
231+
run: cargo build --release --bin code_guardian_cli
232232

233233
- name: Run Security Scan
234234
run: |
235-
./target/release/code-guardian-cli scan . \
235+
./target/release/code_guardian_cli scan . \
236236
--custom-detectors security_detectors.json \
237237
--db /tmp/security.db
238238
239239
- name: Check for Security Issues
240240
run: |
241-
SCAN_ID=$(./target/release/code-guardian-cli history --db /tmp/security.db | tail -1 | awk '{print $2}' | tr -d ',')
242-
COUNT=$(./target/release/code-guardian-cli report "$SCAN_ID" --db /tmp/security.db --format json | jq '.matches | length')
241+
SCAN_ID=$(./target/release/code_guardian_cli history --db /tmp/security.db | tail -1 | awk '{print $2}' | tr -d ',')
242+
COUNT=$(./target/release/code_guardian_cli report "$SCAN_ID" --db /tmp/security.db --format json | jq '.matches | length')
243243
244244
if [ "$COUNT" -gt 0 ]; then
245245
echo "🚨 Security issues found: $COUNT"
246-
./target/release/code-guardian-cli report "$SCAN_ID" --db /tmp/security.db --format markdown >> $GITHUB_STEP_SUMMARY
246+
./target/release/code_guardian_cli report "$SCAN_ID" --db /tmp/security.db --format markdown >> $GITHUB_STEP_SUMMARY
247247
exit 1
248248
else
249249
echo "✅ No security issues found"

docs/tutorials/getting-started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ cd code-guardian
1717
cargo build --release
1818
```
1919

20-
The binary will be at `target/release/code-guardian-cli` (or just `code-guardian` if installed).
20+
The binary will be at `target/release/code_guardian_cli` (or just `code-guardian` if installed).
2121

2222
## Step 2: Run Your First Scan
2323

2424
Let's scan the current directory for TODO and FIXME comments:
2525

2626
```bash
27-
./target/release/code-guardian-cli scan .
27+
./target/release/code_guardian_cli scan .
2828
```
2929

3030
You should see output like:
@@ -42,7 +42,7 @@ src/utils.rs:8:9 - TODO: Add documentation
4242
Check what scans you've run:
4343

4444
```bash
45-
./target/release/code-guardian-cli history
45+
./target/release/code_guardian_cli history
4646
```
4747

4848
Output:
@@ -57,13 +57,13 @@ Create a detailed report in different formats:
5757

5858
```bash
5959
# Text format (default)
60-
./target/release/code-guardian-cli report 1
60+
./target/release/code_guardian_cli report 1
6161

6262
# JSON format
63-
./target/release/code-guardian-cli report 1 --format json
63+
./target/release/code_guardian_cli report 1 --format json
6464

6565
# HTML format (save to file)
66-
./target/release/code-guardian-cli report 1 --format html > report.html
66+
./target/release/code_guardian_cli report 1 --format html > report.html
6767
```
6868

6969
## Step 5: Open the HTML Report

examples/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,22 @@ This directory contains examples of how to use the Code-Guardian CLI tool, inclu
66

77
### Scan a directory
88
```bash
9-
cargo run --bin code-guardian-cli -- scan ./src
9+
cargo run --bin code_guardian_cli -- scan ./src
1010
```
1111

1212
### View scan history
1313
```bash
14-
cargo run --bin code-guardian-cli -- history
14+
cargo run --bin code_guardian_cli -- history
1515
```
1616

1717
### Generate a report
1818
```bash
19-
cargo run --bin code-guardian-cli -- report 1 --format json
19+
cargo run --bin code_guardian_cli -- report 1 --format json
2020
```
2121

2222
### Compare two scans
2323
```bash
24-
cargo run --bin code-guardian-cli -- compare 1 2 --format markdown
24+
cargo run --bin code_guardian_cli -- compare 1 2 --format markdown
2525
```
2626

2727
## Sample Output
@@ -40,17 +40,17 @@ src/utils.rs:8:9 - TODO: Add documentation
4040

4141
### JSON Output
4242
```bash
43-
cargo run --bin code-guardian-cli -- report 1 --format json
43+
cargo run --bin code_guardian_cli -- report 1 --format json
4444
```
4545

4646
### HTML Output
4747
```bash
48-
cargo run --bin code-guardian-cli -- report 1 --format html > report.html
48+
cargo run --bin code_guardian_cli -- report 1 --format html > report.html
4949
```
5050

5151
### CSV Output
5252
```bash
53-
cargo run --bin code-guardian-cli -- report 1 --format csv > report.csv
53+
cargo run --bin code_guardian_cli -- report 1 --format csv > report.csv
5454
```
5555

5656
## Custom Detectors
@@ -59,13 +59,13 @@ cargo run --bin code-guardian-cli -- report 1 --format csv > report.csv
5959

6060
```bash
6161
# Create example custom detectors
62-
cargo run --bin code-guardian-cli -- custom-detectors create-examples --output custom_detectors.json
62+
cargo run --bin code_guardian_cli -- custom-detectors create-examples --output custom_detectors.json
6363

6464
# Scan with custom detectors
65-
cargo run --bin code-guardian-cli -- scan ./src --custom-detectors custom_detectors.json
65+
cargo run --bin code_guardian_cli -- scan ./src --custom-detectors custom_detectors.json
6666

6767
# List available custom detectors
68-
cargo run --bin code-guardian-cli -- custom-detectors list
68+
cargo run --bin code_guardian_cli -- custom-detectors list
6969
```
7070

7171
### Configuration Files
@@ -75,15 +75,15 @@ cargo run --bin code-guardian-cli -- custom-detectors list
7575
Use `custom_config.toml` for basic custom patterns:
7676

7777
```bash
78-
cargo run --bin code-guardian-cli -- scan ./src --config custom_config.toml
78+
cargo run --bin code_guardian_cli -- scan ./src --config custom_config.toml
7979
```
8080

8181
#### Advanced Custom Detectors
8282

8383
Use `custom_detectors.json` for full-featured custom detectors with severity levels, categories, and file filtering:
8484

8585
```bash
86-
cargo run --bin code-guardian-cli -- scan ./src --custom-detectors custom_detectors.json
86+
cargo run --bin code_guardian_cli -- scan ./src --custom-detectors custom_detectors.json
8787
```
8888

8989
### Example Files

0 commit comments

Comments
 (0)