Skip to content

Commit 6f81d74

Browse files
committed
[Fix]: Set CMAKE_POLICY_VERSION_MINIMUM to suppress dependency errors
1 parent 5b7402e commit 6f81d74

5 files changed

Lines changed: 35 additions & 62 deletions

File tree

CMakeLists.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
55
set(CMAKE_CXX_STANDARD 17)
66
set(CMAKE_CXX_STANDARD_REQUIRED ON)
77

8+
# TODO: Remove this when upgrading to a newer version of backward-cpp (newer than v1.6)
9+
set(CMAKE_POLICY_VERSION_MINIMUM 3.14 CACHE STRING "" FORCE)
10+
811
if(MSVC)
912
# Ensure debug symbols are generated and linked
1013
add_compile_options(/Zi)

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ That's it! Run your tests and see the enhanced output.
5656
5757
## Features
5858
59-
- 🎯 **Grid Visualization** - See all tests progress in real-time
60-
- 🛡️ **Crash Handling** - Get stack traces when tests crash
61-
- 🎨 **Color Support** - Automatic terminal detection
62-
- 🔍 **Test Filtering** - Run specific tests or suites
63-
- 📦 **Zero Config** - Works out of the box with Google Test
59+
- **Grid Visualization** - See all tests progress in real-time
60+
- **Crash Handling** - Get stack traces when tests crash
61+
- **Color Support** - Automatic terminal detection
62+
- **Test Filtering** - Run specific tests or suites
63+
- **Zero Config** - Works out of the box with Google Test
6464
6565
## Examples
6666

docs/ARCHITECTURE.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,22 @@ testcoe enhances Google Test by intercepting test events and providing visual fe
77
## Component Architecture
88

99
```
10-
┌─────────────────────────────────────┐
11-
│ Test Application
12-
│ (Your Google Tests)
13-
└────────────────────────────────────┘
14-
15-
┌────────────────────────────────────┐
16-
testcoe
17-
│ (Main Interface & API)
18-
└────────────────────────────────────┘
19-
20-
┌────────────────────────────┐
21-
22-
┌───────▼────────┐ ┌─────▼──────┐ ┌────────────┐
23-
│ GridListener │SignalHandler│ │TerminalUtils│
24-
│ (Visual Grid) │ (Crashes) │ │ (Terminal)
25-
└────────────────┘ └────────────┘ └──────────────┘
10+
┌─────────────────────────────────────┐
11+
Test Application │
12+
(Your Google Tests) │
13+
└────────────────────────────────────┘
14+
15+
┌────────────────────────────────────┐
16+
testcoe
17+
(Main Interface & API) │
18+
└────────────────────────────────────┘
19+
20+
┌──────────────────│──────────────────┐
21+
22+
┌───────▼───────┌─────▼──────┐ ┌────────────┐
23+
│ GridListener │SignalHandler│ │TerminalUtils│
24+
│ (Visual Grid) │ (Crashes) │ │ (Terminal) │
25+
└───────────────└─────────────┘ └─────────────┘
2626
```
2727

2828
## Core Components
@@ -90,7 +90,7 @@ testcoe enhances Google Test by intercepting test events and providing visual fe
9090
- [**backward-cpp**](https://github.com/bombela/backward-cpp) (v1.6) - Stack trace generation
9191

9292
### Platform Dependencies
93-
- **Windows**: DbgHelp.dll (for symbol resolution)
93+
- **Windows**: dbghelp, psapi and imagehlp
9494
- **Unix/Linux**: Standard POSIX signal handling
9595
- **macOS**: Standard POSIX signal handling
9696

docs/CONTRIBUTING.md

Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ The CI runs the following checks:
6161
## Making Changes
6262

6363
### Code Style
64-
- Use 4 spaces for indentation
6564
- Follow existing naming conventions
6665
- Keep lines under 120 characters
6766
- Add comments for complex logic
@@ -74,29 +73,17 @@ The CI runs the following checks:
7473
### Pull Request Process
7574

7675
1. Fork the repository
77-
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
76+
2. Create a feature branch
7877
3. Make your changes
7978
4. Run tests locally
8079
5. Commit with clear messages
81-
6. Push to your fork (`git push origin feature/amazing-feature`)
80+
6. Push to your fork
8281
7. Open a Pull Request from your fork to the main repository
8382

8483
### Commit Messages
85-
- Use present tense ("Add feature" not "Added feature")
86-
- Keep first line under 50 characters
87-
- Reference issues if applicable
88-
89-
## Platform-Specific Considerations
90-
91-
### Windows
92-
- Test with both MSVC and MinGW
93-
- Ensure DbgHelp.dll linking works correctly
94-
- Verify SEH handling functions properly
95-
96-
### Linux/macOS
97-
- Test signal handlers work correctly
98-
- Verify ANSI color detection
99-
- Check terminal clearing functions
84+
- Use prefix for PR title `[Subject]: <PR title>`
85+
- PR description should describe the major changes in bullet-points
86+
- Sqaushed commit title should be the PR title, and the message should be PR description
10087

10188
## Adding New Features
10289

@@ -107,20 +94,13 @@ When adding features:
10794
4. Add tests covering the new functionality
10895
5. Update documentation
10996

110-
## Debugging Tips
111-
112-
### Debugging Grid Display
113-
- Set breakpoints in `GridListener::printGrid()`
114-
- Check stream redirection in `OnTestStart/End`
97+
## Questions?
11598

116-
### Debugging Crashes
117-
- Test signal handlers with example crash tests
118-
- Verify backward-cpp integration
119-
- Check platform-specific code paths
99+
Feel free to reach out at nircoe@gmail.com
120100

121-
## Questions?
101+
I'm here to help make contributing to logcoe as smooth as possible!
122102

123-
Feel free to open an issue for:
103+
Please open an issue for:
124104
- Bug reports
125105
- Feature requests
126106
- Questions about the codebase

docs/ROADMAP.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,11 @@
1717
- ⏳ Customizable grid layout and colors
1818
- ⏳ JSON/XML test report generation
1919
- ⏳ Test execution time tracking and reporting
20-
- ⏳ Parallel test execution visualization
21-
- ⏳ Interactive test selection mode
22-
- ⏳ Test history and trend analysis
23-
- ⏳ Integration with popular IDEs
24-
- ⏳ Support for Google Test's sharding feature
25-
- ⏳ Custom test status indicators
26-
- ⏳ Test dependency visualization
27-
- ⏳ Performance profiling integration
28-
- ⏳ Remote test execution monitoring
29-
- ⏳ Test coverage visualization
30-
- ⏳ Support for other test frameworks
3120

3221
## Feature Requests
3322

3423
Have an idea for testcoe? Please open an issue on GitHub with the "enhancement" label.
24+
And of course, feel free to reach out at nircoe@gmail.com
3525

3626
## Versioning
3727

0 commit comments

Comments
 (0)