Collett (Experimental)

A rich text editor for novels written in Qt/C++.

The project is an alternative implementation of novelWriter. It is intended to be feature-compatible with novelWriter, but will have its own project file format and a different approach to tracking notes and meta data.

Note: This is an experimental repo for the time being. It is not a usable application yet.

Building

Dependencies

On Debian or Ubuntu:

sudo apt install cmake \
    qt6-base-dev qt6-svg-dev qt6-tools-dev qt6-l10n-tools \
    libnuspell-dev

Spell checking needs at least one Hunspell-compatible dictionary, for instance hunspell-en-gb or hunspell-nb. Coverage reports need gcovr, which can be installed with pip install gcovr.

Formatting checks need clang-format, which can be installed with:

sudo apt install clang-format

Build

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build
./build/collett

Use -DCMAKE_BUILD_TYPE=Debug for a debug build. Add -j to the build command to compile in parallel, for instance cmake --build build -j 8.

Tests

The tests are built by default as part of the normal build. Run them with:

cd build && ctest --output-on-failure

A single test executable can also be run directly, for instance ./build/tests/tst_spellcheck. Pass -DCOLLETT_BUILD_TESTS=OFF to CMake to skip building the tests.

Formatting

Source files are formatted according to the .clang-format file in the repository root. Requires clang-format to be installed. Run ./format.sh to format all source files in place before making a pull request, or ./format.sh --check to only check for violations without changing anything, as done in CI.

Coverage

The coverage build instruments the core library and adds a coverage target that runs the tests and writes a report to build_cov/coverage/index.html:

cmake -S . -B build_cov -DCMAKE_BUILD_TYPE=Debug -DCOLLETT_COVERAGE=ON
cmake --build build_cov --target coverage

CI runs the same coverage build on every push and pull request. The report is written to the job's summary page, and on pull requests it is also posted as an updating comment on the PR.