|
4 | 4 |
|
5 | 5 | | Command | Description | |
6 | 6 | |---------|-------------| |
7 | | -| `make help` | Show all available make targets | |
8 | | -| `make build` | Build the project with all features | |
9 | | -| `make test` | Run unit tests | |
10 | | -| `make check` | Run format check + clippy linting | |
11 | | -| `make fmt` | Format code (requires nightly) | |
12 | | -| `make ci` | Full CI pipeline (format, lint, test, doc-check) | |
| 7 | +| `cargo build --workspace --all-features` | Build the project with all features | |
| 8 | +| `cargo test --lib` | Run unit tests | |
| 9 | +| `cargo +nightly fmt --all` | Format code (requires nightly) | |
| 10 | +| `cargo clippy --workspace --all-targets -- -D warnings` | Run clippy linting | |
| 11 | +| `cargo doc --workspace --no-deps --open` | Build and open documentation | |
| 12 | + |
| 13 | +## Setup (One-Time) |
| 14 | + |
| 15 | +```bash |
| 16 | +mise trust && mise install |
| 17 | +rustup component add rustfmt clippy |
| 18 | +rustup toolchain install nightly --component rustfmt |
| 19 | +``` |
13 | 20 |
|
14 | 21 | ## Build Commands |
15 | 22 |
|
16 | 23 | ```bash |
17 | 24 | # Build all workspace crates with all features |
18 | | -make build |
19 | | -# Or directly: |
20 | 25 | cargo build --workspace --all-features |
21 | 26 | ``` |
22 | 27 |
|
23 | 28 | ## Test Commands |
24 | 29 |
|
25 | 30 | ```bash |
26 | 31 | # Unit tests only |
27 | | -make test |
28 | | -# Or: cargo test --lib |
| 32 | +cargo test --lib |
29 | 33 |
|
30 | 34 | # Integration tests (requires local InferaDB via inferadb/deploy) |
31 | | -make test-integration |
32 | | -# Or: cargo test --test integration |
| 35 | +cargo test --test integration |
33 | 36 |
|
34 | 37 | # All tests |
35 | | -make test-all |
36 | | -# Or: cargo test --lib --test integration |
| 38 | +cargo test --lib --test integration |
37 | 39 | ``` |
38 | 40 |
|
39 | 41 | ## Code Quality |
40 | 42 |
|
41 | 43 | ```bash |
42 | 44 | # Format code (requires nightly toolchain) |
43 | | -make fmt |
44 | | -# Or: cargo +nightly fmt --all |
| 45 | +cargo +nightly fmt --all |
45 | 46 |
|
46 | 47 | # Check formatting without modifying |
47 | | -make fmt-check |
48 | | -# Or: cargo +nightly fmt --all -- --check |
| 48 | +cargo +nightly fmt --all -- --check |
49 | 49 |
|
50 | 50 | # Run clippy linter |
51 | | -make clippy |
52 | | -# Or: cargo clippy --workspace --all-targets -- -D warnings |
53 | | - |
54 | | -# Both format check and clippy |
55 | | -make check |
| 51 | +cargo clippy --workspace --all-targets -- -D warnings |
56 | 52 | ``` |
57 | 53 |
|
58 | 54 | ## Documentation |
59 | 55 |
|
60 | 56 | ```bash |
61 | 57 | # Build docs |
62 | | -make doc |
63 | | -# Or: cargo doc --workspace --no-deps |
| 58 | +cargo doc --workspace --no-deps |
64 | 59 |
|
65 | 60 | # Build and open in browser |
66 | | -make doc-open |
67 | | -# Or: cargo doc --workspace --no-deps --open |
| 61 | +cargo doc --workspace --no-deps --open |
68 | 62 |
|
69 | 63 | # Check docs for warnings |
70 | | -make doc-check |
71 | | -# Or: RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps |
| 64 | +RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps |
72 | 65 | ``` |
73 | 66 |
|
74 | 67 | ## Coverage |
75 | 68 |
|
76 | 69 | ```bash |
77 | 70 | # Run tests with coverage |
78 | | -make coverage |
79 | | -# Or: cargo llvm-cov --lib --ignore-filename-regex 'proto|inferadb\.authorization\.v1' |
| 71 | +cargo llvm-cov --lib --ignore-filename-regex 'proto|inferadb\.authorization\.v1' |
80 | 72 |
|
81 | 73 | # Generate HTML coverage report |
82 | | -make coverage-html |
| 74 | +cargo llvm-cov --lib --ignore-filename-regex 'proto|inferadb\.authorization\.v1' --html |
83 | 75 | ``` |
84 | 76 |
|
85 | 77 | ## Code Generation |
86 | 78 |
|
87 | 79 | ```bash |
88 | 80 | # Regenerate protobuf code from proto/inferadb.proto |
89 | | -make proto |
90 | | -``` |
91 | | - |
92 | | -## Setup & CI |
93 | | - |
94 | | -```bash |
95 | | -# One-time development setup (installs toolchain and tools) |
96 | | -make setup |
97 | | - |
98 | | -# Full CI pipeline |
99 | | -make ci |
| 81 | +rm -f src/transport/proto/inferadb.authorization.v1.rs |
| 82 | +cargo build --features grpc |
| 83 | +cargo +nightly fmt --all |
100 | 84 | ``` |
101 | 85 |
|
102 | 86 | ## Running Examples |
|
0 commit comments