cargo-mate 1.8.0

Rust development companion that enhances cargo with intelligent workflows, state management, performance optimization, and comprehensive project monitoring.
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
## View Commands

The view command system provides comprehensive access to build results, artifacts, errors, warnings, and build history. This system integrates with the enhanced display system to provide detailed information about your builds in an organized, easy-to-access format.

### Key Features
- **Comprehensive Results**: Access errors, warnings, artifacts, scripts, and history
- **Organized Storage**: Results automatically saved to `~/.shipwreck/` directory
- **Multiple View Options**: Different ways to access build information
- **Real-Time Updates**: Results updated automatically after each build
- **Easy Navigation**: Simple commands to access different result types

### Result Storage System

All build results are automatically stored in the `~/.shipwreck/` directory:

- **Errors**: `~/.shipwreck/errors/latest.txt`
- **Warnings**: `~/.shipwreck/warnings/latest.txt`
- **Artifacts**: `~/.shipwreck/artifacts/latest.txt`
- **Build Scripts**: `~/.shipwreck/scripts/latest.txt`
- **History**: Integrated with existing history system

### `cm view errors`
**Description**: View all build errors

**Usage**:
```bash
cm view errors
```

**Output**:
```
🔴 Latest Errors:
══════════════════════════════════════════════════
error[E0308]: mismatched types
  --> src/main.rs:42:5
  |
42 |     let result: String = 42;
  |         ^^^^^ expected String, found integer
  |
  = note: expected due to previous error

error[E0433]: failed to resolve: use of undeclared crate
  --> src/main.rs:7:5
  |
7 | use nonexistent_crate;
  |     ^^^^^^^^^^^^^^^^
══════════════════════════════════════════════════
```

---

### `cm view warnings`
**Description**: View all build warnings

**Usage**:
```bash
cm view warnings
```

---

### `cm view artifacts`
**Description**: View generated files and locations

**Usage**:
```bash
cm view artifacts
```

**Output**:
```
📦 Generated Artifacts:
══════════════════════════════════════════════════
🔨 Build Scripts:
  cargo-mate -> libs: 0, paths: 0, cfgs: 0

📁 Target Directory: target/
  ├── debug/
  │   ├── cm (executable)
  │   └── deps/
  └── release/
      ├── cm (executable)
      └── deps/

📋 Cargo.toml: Updated to version 1.0.1
══════════════════════════════════════════════════
```

---

### `cm view scripts`
**Description**: View build script outputs

**Usage**:
```bash
cm view scripts
```

---

### `cm view history`
**Description**: View detailed build history

**Usage**:
```bash
cm view history
```

---

### `cm view checklist`
**Description**: View checklist and fixes

**Usage**:
```bash
cm view checklist
```

---

### `cm view all`
**Description**: View all results in one place

**Usage**:
```bash
cm view all
```

**Output**:
```
🔍 Complete Build Results View:
══════════════════════════════════════════════════

🔴 ERRORS (2):
error[E0308]: mismatched types
  --> src/main.rs:42:5
  |
42 |     let result: String = 42;
  |         ^^^^^ expected String, found integer

⚠️  WARNINGS (1):
warning: unused variable
  --> src/main.rs:15:5
  |
15 |     let unused = "hello";
  |     ^^^^^^^^^

📦 ARTIFACTS:
🔨 Build Scripts:
  cargo-mate -> libs: 0, paths: 0, cfgs: 0

📁 Target Directory: target/
  ├── debug/
  │   ├── cm (executable)
  │   └── deps/
  └── release/
      ├── cm (executable)
      └── deps/

📋 Cargo.toml: Updated to version 1.0.1
══════════════════════════════════════════════════
```

---

### `cm view latest`
**Description**: Quick view of latest issues

**Usage**:
```bash
cm view latest
```

---

### `cm view open`
**Description**: Open results in file explorer

**Usage**:
```bash
cm view open
---

### `cm view all`
**Description**: View all results in one place

**Usage**:
```bash
cm view all
```

**Output**:
```
🔍 Complete Build Results View:
══════════════════════════════════════════════════

🔴 ERRORS (2):
error[E0308]: mismatched types
  --> src/main.rs:42:5
  |
42 |     let result: String = 42;
  |         ^^^^^ expected String, found integer

error[E0433]: failed to resolve: use of undeclared crate
  --> src/main.rs:7:5
  |
7 | use nonexistent_crate;
  |     ^^^^^^^^^^^^^^^^

⚠️  WARNINGS (1):
warning: unused variable
  --> src/main.rs:15:5
  |
15 |     let unused = "hello";
  |     ^^^^^^^^^

📦 ARTIFACTS:
🔨 Build Scripts:
  cargo-mate -> libs: 0, paths: 0, cfgs: 0

📁 Target Directory: target/
  ├── debug/
  │   ├── cm (executable)
  │   └── deps/
  └── release/
      ├── cm (executable)
      └── deps/

📋 Cargo.toml: Updated to version 1.0.1
══════════════════════════════════════════════════
```

---

### `cm view latest`
**Description**: Quick view of latest issues

**Usage**:
```bash
cm view latest
```

---

### `cm view open`
**Description**: Open results in file explorer

**Usage**:
```bash
cm view open
```

---

---

## Best Practices

### Regular Build Review

```bash
# After each build, review results
cm view all

# Check for errors first
cm view errors

# Review warnings
cm view warnings

# Check generated artifacts
cm view artifacts
```

### Quick Issue Check

```bash
# Quick view of latest issues
cm view latest

# Detailed error analysis
cm view errors | grep -A 5 "error\["

# Check build script issues
cm view scripts
```

### Build History Tracking

```bash
# View build history
cm view history

# Track build trends over time
cm view history | grep "Success\|Failed"
```

## Troubleshooting

### No Results Available

```bash
# Check if build has been run
cargo build

# Verify storage directory exists
ls -la ~/.shipwreck/

# Check file permissions
chmod -R 755 ~/.shipwreck/
```

### Results Not Updating

```bash
# Run a build to generate new results
cm build

# Check if results are being saved
ls -la ~/.shipwreck/errors/
ls -la ~/.shipwreck/artifacts/
```

### File Not Found Errors

```bash
# Create storage directories if missing
mkdir -p ~/.shipwreck/{errors,warnings,artifacts,scripts}

# Run a build to populate results
cm build
```

## Integration with Build System

### Automatic Result Collection

The view system automatically collects results during builds:

- **Error Collection**: Real-time error and warning collection during compilation
- **Artifact Tracking**: Monitors `CompilerArtifact` and `BuildScriptExecuted` messages
- **File Management**: Automatic creation of result storage directories
- **JSON Parsing**: Parses JSON-formatted cargo output for structured data

### Enhanced Display Integration

The view system integrates with the enhanced display system:

- **Live Updates**: Results updated in real-time during builds
- **Progress Tracking**: Live error counts and file processing
- **Summary Display**: Comprehensive build summary after completion
- **View Options**: Clear display of available viewing commands

## Advanced Usage

### Filtering Results

```bash
# View only specific error types
cm view errors | grep "E0308"

# Count errors
cm view errors | grep -c "error\["

# View artifacts for specific target
cm view artifacts | grep "release"
```

### Exporting Results

```bash
# Export errors to file
cm view errors > build-errors.txt

# Export artifacts list
cm view artifacts > artifacts-list.txt

# Export complete build summary
cm view all > build-summary.txt
```

### CI/CD Integration

```bash
# In CI pipeline
cm build
cm view errors > ci-errors.txt
cm view artifacts > ci-artifacts.txt

# Fail build if errors found
if [ -s ci-errors.txt ]; then
    echo "Build failed with errors"
    exit 1
fi
```

## Technical Details

### Data Collection

**Cargo Messages**:
- Parses JSON-formatted cargo output
- Monitors `CompilerArtifact` messages
- Tracks `BuildScriptExecuted` events
- Real-time error and warning collection

**File Management**:
- Automatic creation of result storage directories
- Timestamped result files
- Latest results always available
- Historical results preserved

### Error Handling

**Graceful Degradation**:
- Continues operation if view commands fail
- File validation before reading
- Clear error messages for missing files
- Non-blocking integration with builds

### Performance

**Fast Access**:
- Results stored locally for instant access
- Efficient file reading and parsing
- Minimal overhead on build operations
- Quick command execution

## Future Enhancements

Planned features:
- **Result Filtering**: Advanced filtering options for large result sets
- **Export Formats**: Support for JSON, CSV, or HTML export
- **Custom Views**: User-configurable view layouts
- **Result Archiving**: Automatic archiving of old build results
- **Search Functionality**: Search through historical results
- **Comparison Tools**: Compare results between builds

---