Skip to content

docs: simplify lint and format guidance #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
megabyde merged 1 commit into from
Jul 27, 2026
Merged

docs: simplify lint and format guidance #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ TIDY_SOURCES = $(shell find src tests -type f -name '*.cpp')
# Conan's, not prettier's.
PRETTIER_SOURCES = $(shell git ls-files '*.md' '*.json' '*.yml' '*.yaml' ':!conan.lock')
MARKDOWN_SOURCES = $(shell git ls-files '*.md')
# Lint and format conanfile.py alongside the first-party Python scripts
PYTHON_SOURCES = scripts/ conanfile.py

define require-tool
Expand Down
15 changes: 5 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,20 +221,15 @@ make lint
```

`make format` and `make format-check` cover C++ sources (clang-format), `CMakeLists.txt`
(cmake-format, from the [cmakelang](https://cmake-format.readthedocs.io) package), Python sources in
`scripts/` and `conanfile.py` ([ruff](https://docs.astral.sh/ruff/) format), and tracked
Markdown/JSON/YAML files ([prettier](https://prettier.io); `conan.lock` is excluded because Conan
owns its formatting). `make lint` runs clang-tidy against the debug compilation database,
`cmake-lint` on `CMakeLists.txt`, `ruff check` on those Python sources, and
(cmake-format, from the [cmakelang](https://cmake-format.readthedocs.io) package), `scripts/` and
`conanfile.py` ([ruff](https://docs.astral.sh/ruff/) format), and tracked Markdown/JSON/YAML files
([prettier](https://prettier.io); `conan.lock` is excluded because Conan owns its formatting).
`make lint` runs clang-tidy against the debug compilation database, `cmake-lint` on
`CMakeLists.txt`, `ruff check` on `scripts/` and `conanfile.py`, and
[markdownlint](https://github.com/DavidAnson/markdownlint-cli2) on Markdown files. Any reported
finding fails the target. CI pins all lint and format tool versions in
[`.github/ci.env`](.github/ci.env).

[`ruff.toml`](ruff.toml) extends Ruff's `E4`, `E7`, `E9`, and `F` defaults to all `E` checks, then
adds import ordering (`I`), Python modernization (`UP`), likely bugs (`B`), simplification (`SIM`),
Ruff-specific rules (`RUF`), and annotations (`ANN`). As with `.clang-tidy`, every finding fails the
lint target.

## Coverage

Build, test, and generate an HTML coverage report with an enforced line floor:
Expand Down
3 changes: 0 additions & 3 deletions ruff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
line-length = 100

[lint]
# Ruff enables E4, E7, E9, and F by default. Add all E checks plus import ordering, Python
# modernization, likely bugs, simplification, Ruff-specific rules, and annotations. As with
# clang-tidy, every finding is an error. ANN keeps existing type annotations complete.
select = ["E", "F", "I", "UP", "B", "SIM", "RUF", "ANN"]

[lint.isort]
Expand Down
Loading