ApprovalTests.cpp/to_do.txt at master · DimRochette/ApprovalTests.cpp · GitHub

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
BUGS

. arguments member in DiffInfo is unused after construction - beware - will need to handle arguments differently on cygwin (which currently assumes all arguments are file paths)

IMPROVE USABILITY OF CURRENT FEATURES

. use a disposer for GoogleConfiguration::addIgnorableTestCaseNameSuffix() - to make it reversible

NEW FEATURES

. add a non-gui reporter, e.g. for use in CI systems
. catch reporter
. tortoise git diff reporter
. maps
. reports
. asJson
. loggers
. scrubbers
. make SystemLauncher on Windows use the 'where' command
. more linux diff programs (https://www.tecmint.com/best-linux-file-diff-tools-comparison/)
. support visual studio's in-built diff

TESTS

. add tests of images (and verify that this works in Araxis Merge too - use Type::TEXT_AND_IMAGE)
. try using C++17's filesystem to simplify tests - may need to support <experimental/filesystem> too - and may need -lstdc++fs

DOCUMENTATION

. short video intro - from downloading to running the first test - like https://www.youtube.com/watch?v=jeDecsGVbc4
. document use of converter objects - see comment in #6
. hook Simon Cropp's code mechanism into github pre-commit mechanism

RELEASES

. try Markdown Navigator to allow checkboxes in build steps
. get cmake to generate build from command line (to remove requirement that CLion needs to have built starter project)
. see if we can streamline setup of relnotes files for next release
. include licence in released header

FORMATTING OF CODE

. tabs to spaces
. add pre-commit check to detect tabs
. Implement auto-formatting of code to match style guide

CODE QUALITY

. Clean up CIBuildOnlyReporter
. run through Qt Creator analysis tools
. memory leaks in our tests

ENVIRONMENT AND BUILDS

. fix Appveyor builds for Starter Project
. set up a git tab policy
. fix issues in source code with eol warnings in clion on PC (little red crlf warnings)

FUTURE DEVELOPMENT

. review directory and file structure of other popular C++ testing libraries, to look for ways to improve the structure of this project, e.g. add a single header file in source that mimics the released single header, e.g. put Catch and Google headers into an integration folder???