bootstrap/specs/clang/template/README.md

45 lines
1.7 KiB
Markdown
Raw Normal View History

2023-11-26 21:51:41 +00:00
# Clang Flake Template
This is a template for constructing a working environment for C development with
2023-11-26 21:54:42 +00:00
the [clang](https://clang.llvm.org/) (version 16.0.6) toolchain. [direnv](https://direnv.net/)
can be used to launch a dev shell upon entering this directory (refer to
`.envrc`). Otherwise run via:
2023-11-26 21:51:41 +00:00
```bash
$> nix develop
2023-11-26 21:51:41 +00:00
```
## Language Server
The [clangd](https://clangd.llvm.org/) LSP (version 14.0.6) is included in this
flake. The [codelldb](https://github.com/vadimcn/codelldb) VSCode plugin is also
included to interface with the LSP. Note this plugin, despite its name, is
compatible with other editors (e.g. neovim). To configure, refer to your
2023-11-26 21:54:42 +00:00
editor's documentation. To use the LSP across files, a [compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html)
2023-11-26 21:51:41 +00:00
must be generated. For this reason, [bear](https://github.com/rizsotto/Bear)
(version 3.1.3) is included in this flake. Use as follows to generate a
`compile_commands.json` file:
```bash
$> bear -- <your-build-command>
```
## Documentation
Documentation is generated using [Doxygen](https://www.doxygen.nl/index.html)
2023-11-26 21:54:42 +00:00
(version 1.9.7). (Re)generate documentation by editing the `Doxyfile` and
running:
2023-11-26 21:51:41 +00:00
```bash
$> doxygen
```
## Formatting
Formatting depends on the [clang-format](https://clang.llvm.org/docs/ClangFormat.html)
(version 14.0.6) tool. Refer to `.clang-format` for default formatting options.
A `pre-commit` hook is included in `.githooks` that can be used to format all
2023-11-26 21:54:42 +00:00
`*.c` and `*.h` files prior to commit. Install via:
2023-11-26 21:51:41 +00:00
```bash
$> git config --local core.hooksPath .githooks/
```
2023-11-26 21:54:42 +00:00
If running [direnv](https://direnv.net/), this hook is installed automatically
when entering the directory.