Style Guide

Xyris uses a modified version of the WebKit style guide, which is also used by SerenityOS. We believe it provides the best looking code while also being the simplest to understand. In order to help new Xyris contributors, a .clang-format file is provided so that clang-tidy can be run on Xyris source to have it comply with the style guide.

Please note that not all Xyris source complies with this style guide due to the fact that for a significant amount of time, a style guide was not used. If you are working with non-conforming code, please update it to conform to the style guide.

VSCode and CLion both include extensions (either internal or external) that allow in-IDE formatting of source using clang-tidy.

WebKit Style Guide

.clang-format

---
Language: Cpp
BasedOnStyle: WebKit
SpaceAfterTemplateKeyword: false
AlignEscapedNewlines: Left
AlignTrailingComments: true
BreakBeforeInheritanceComma: true
BreakConstructorInitializers: BeforeComma
IndentPPDirectives: AfterHash
BreakBeforeBraces: Custom
BraceWrapping:
    AfterFunction: true
NamespaceIndentation: None

IDE Extensions

• Visual Studio Code: clang-format
  • First time setup:
    1. Right click within the code editor view to view the context menu.
    2. Click "Format Document With..."
    3. Click "Configure Default Formatter..."
    4. Click "Clang-Format"
  • Usage:
    1. Right click within the code editor view to view the context menu.
    2. Click "Format Document"
• Vim Family:
  • First time setup:
    1. Install clang-tidy package
    2. wget https://raw.githubusercontent.com/llvm/llvm-project/main/clang/tools/clang-format/clang-format.py
    3. mv clang-format.py /usr/local/bin/clang-format.py
    4. Add the following lines to .vimrc
       • map <C-K> :py3f /usr/local/bin/clang-format.py<cr>
       • imap <C-K> <c-o>:py3f /usr/local/bin/clang-format.py<cr>
  • Usage:
    1. Format current line with Ctrl+K
    2. Format multiple lines with Ctrl+K in visual mode
    3. Format entire file with ggvG<CTRL+K>