outfoxxed/tidyfox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

initial setup

Browse source 
Buildscripts, nix shell, skeleton project
This commit is contained in:
outfoxxed 2023-10-27 03:02:07 -07:00
commit f5c43c4fb4
Signed by: outfoxxed
GPG key ID: 4C88A185FB89301E
11 changed files with 284 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

28
README.md Normal file
View file

@ -0,0 +1,28 @@
# tidyfox
outfoxxed's clang-tidy lint collection. Lints I end up needing will go here.
# Installation
There is a nix package in `default.nix` which can be used to install tidyfox in `lib/libtidyfox.so`.
If you aren't running nix, use the provided Justfile.
Run `just release` to make a release build. You must have llvm and clang 16 dev packages in $PATH. (`FindClang.cmake` must exist)
# Usage
Tidyfox lints are supplied under the `tidyfox-` namespace. Currently there are no lints.
The plugin can be loaded via `clang-tidy -load=/path/to/libtidyfox.so`
# Contributing
There is a `shell.nix` file which will load all the necessary dependencies.
If not using nix the requirements are the same as in [Installation](#installation) above.
Run `just build` to create a debug build and a clang compilation database.
Run `just fmt` to format the sources.
Run `just lint` to run clang-tidy on tidyfox, with tidyfox itself as a plugin.
Run `just release` to create a release build.
Run `just pre-commit` before committing to catch anything.
When committing, follow [conventional commits](https://www.conventionalcommits.org).