This template sets up a coding environment for C++20 with VSCode, GitHub, and Clang.

• Bazel

The recommended way to use Bazel is to install Bazelisk, which will automatically download Bazel as required. To install:

1. Navigate to the Bazelisk releases page: https://github.com/bazelbuild/bazelisk/releases
2. Download the latest release, and install it as ~/bin/bazel
3. chmod +x ~/bin/bazel
4. Update your ~/.bashrc (or equivalent) to add this directory to your path:

   export PATH=$PATH:$HOME/bin
   

On Linux, this workspace is configured to automatically download Clang and configure it as a toolchain, but that mode does not support Apple Silicon yet. So to enable building for macOS, the system toolchain is used instead.

Note that on macOS fuzzing builds are not yet supported.

Verify that you can build with

bazel build //...

All other dependencies will be downloaded on-demand.

This repository is set up with gtest and a simple cc_fuzzer wrapper. To run tests:

bazel test //...

To run the fuzzer:

bazel build --config=asan-fuzzer //sample:sample_fuzzer
bazel-bin/sample/sample_fuzzer

Coverage support is included based on the built-in bazel coverage sub-command, and a helper is included to wrap functionality and generate a coverage report.

To run it, first ensure that java and lcov are installed, and then run:

build/coverage.sh

These dependencies are automatically installed in the devcontainer. Outside of the devcontainer, this is the Ubuntu install command:

sudo apt-get openjdk-11-jdk lcov

To enable uploading Code Coverage to https://codecov.io, find your repositories upload token, see the instructions in the Codecov FAQ: Where is the repository upload token found?.

Then set it as a GitHub Actions Secret using the GitHub Creating encrypted secrets for a repository instructions.

See this template's code coverage report for an example: https://codecov.io/gh/jwmcglynn/bazel-cpp20

To use the devcontainer, install the VSCode Remote - Containers extension.

Command history syncing hooks, based on the Advanced Containers: Persist bash history docs, are included. Final registration is required to enable them, so it is recommended to use Dotfiles and add the following registration:

# See https://code.visualstudio.com/remote/advancedcontainers/persist-bash-history
if [ -d /commandhistory ]; then
  touch /commandhistory/.zsh_history
  export HISTFILE="/commandhistory/.zsh_history"
else
  echo "Warning: Could not enable history sharing, there is no /commandhistory directory."
fi

# See https://code.visualstudio.com/remote/advancedcontainers/persist-bash-history
if [ -d /commandhistory ]; then
  touch /commandhistory/.bash_history
  export PROMPT_COMMAND='history -a'
  export HISTFILE="/commandhistory/.bash_history"
else
  echo "Warning: Could not enable history sharing, there is no /commandhistory directory."
fi