mirror of
https://github.com/n0-computer/noq.git
synced 2026-09-24 12:13:05 +00:00
Floris Bruynooghe
db9bf72ac4
## Description This enables the auto-formatting to automatically format and wrap comments so they do not exceed the length of the code. This is still an experimental feature it seems, but we've had good results with the import ordering so this might work out as well. ## Breaking Changes none ## Notes & open questions This is quite the bloodbath, probably should have been expected. Partially I wish we could enable this only for new code but hey. I've fixed up the worst things, let me know if there's still anything else that needs fixing up. I'd secretly like to set this to 92 rather than 100. But I guess that would be pushing my personal preferences too far. It this works we should probably also do this on iroh. I love the irony that the line in the Makefile.toml is now well over 100 characters long. I'd prefer to only merge this by consensus, vetos are also accepted. ## Change checklist - [x] Self-review. - [x] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant.
119 lines
3.6 KiB
TOML
119 lines
3.6 KiB
TOML
# Use cargo-make to run tasks here: https://crates.io/crates/cargo-make
|
|
|
|
[config]
|
|
skip_core_tasks = true
|
|
default_to_workspace = false
|
|
|
|
[env]
|
|
CARGO_BUILD_WARNINGS = "deny"
|
|
CARGO_MAKE_EXTEND_WORKSPACE_MAKEFILE = true
|
|
# Workspace members to exclude when setting `workspace = true` for a task.
|
|
# Must live at global env (not task-level) so it's read before workspace iteration
|
|
# is generated. Only the `check-external-types` task uses this.
|
|
CARGO_MAKE_WORKSPACE_SKIP_MEMBERS = ["bench", "fuzz", "perf", "docs/book"]
|
|
|
|
[tasks.default]
|
|
alias = "dev-flow"
|
|
|
|
[tasks.dev-flow]
|
|
description = "Fast local sub-set of all CI checks"
|
|
dependencies = [
|
|
"format-check",
|
|
"check",
|
|
"clippy",
|
|
"doc",
|
|
"test",
|
|
"proptests-extralight",
|
|
]
|
|
|
|
|
|
[tasks.format]
|
|
description = "Format the rust files following style rules"
|
|
command = "cargo"
|
|
args = [
|
|
"fmt",
|
|
"--all",
|
|
"--",
|
|
"--config",
|
|
"unstable_features=true",
|
|
"--config",
|
|
"imports_granularity=Crate,group_imports=Preserve,reorder_imports=false,format_code_in_doc_comments=true,comment_width=100,wrap_comments=true",
|
|
]
|
|
|
|
[tasks.format-check]
|
|
description = "Check the rust files for formatting style"
|
|
command = "cargo"
|
|
args = [
|
|
"fmt",
|
|
"--all",
|
|
"--check",
|
|
"--",
|
|
"--config",
|
|
"unstable_features=true",
|
|
"--config",
|
|
"imports_granularity=Crate,group_imports=Preserve,reorder_imports=false,format_code_in_doc_comments=true,comment_width=100,wrap_comments=true",
|
|
]
|
|
|
|
[tasks.check]
|
|
description = "Run cargo-check for entire project"
|
|
# Allows us to use CARGO_BUILD_WARNINGS instead of
|
|
# RUSTFLAGS=-Dwarnings which breaks the build cache.
|
|
toolchain = { channel = "stable", min_version = "1.97.0" }
|
|
command = "cargo"
|
|
args = ["check", "--workspace", "--all-features", "--all-targets"]
|
|
|
|
[tasks.clippy]
|
|
description = "Run cargo-clippy for entire project"
|
|
# Allows us to use CARGO_BUILD_WARNINGS instead of
|
|
# RUSTFLAGS=-Dwarnings which breaks the build cache.
|
|
toolchain = { channel = "stable", min_version = "1.97.0" }
|
|
command = "cargo"
|
|
args = ["clippy", "--workspace", "--all-features", "--all-targets"]
|
|
|
|
[tasks.doc]
|
|
description = "Check the documentation build"
|
|
# Allows us to use CARGO_BUILD_WARNINGS instead of
|
|
# RUSTDOCFLAGS=-Dwarnings which breaks the build cache.
|
|
toolchain = { channel = "stable", min_version = "1.97.0" }
|
|
command = "cargo"
|
|
args = ["doc", "--workspace", "--all-features", "--no-deps", "--document-private-items"]
|
|
|
|
[tasks.test]
|
|
description = "Run unit tests"
|
|
command = "cargo"
|
|
args = [
|
|
"nextest",
|
|
"run",
|
|
"--workspace",
|
|
"--all-features",
|
|
"--exclude=fuzz",
|
|
"--lib",
|
|
"--bins",
|
|
"--tests",
|
|
"--no-fail-fast",
|
|
]
|
|
|
|
[tasks.proptests-long]
|
|
description = "Run proptests with high case count (runs for ~10 minutes)"
|
|
command = "cargo"
|
|
args = ["nextest", "run", "--package=noq-proto", "-P", "proptests", "--cargo-profile=proptests", "--no-fail-fast", "${@}"]
|
|
env = { "PROPTEST_CASES" = "100000" }
|
|
|
|
[tasks.proptests-light]
|
|
description = "Run proptests for CI (~1 minute)"
|
|
command = "cargo"
|
|
args = ["nextest", "run", "--package=noq-proto", "-P", "proptests", "--cargo-profile=proptests", "--no-fail-fast", "${@}"]
|
|
env = { "PROPTEST_CASES" = "10000" }
|
|
|
|
[tasks.proptests-extralight]
|
|
description = "Run proptests in regression-only mode (runs for <5 seconds)"
|
|
command = "cargo"
|
|
args = ["nextest", "run", "--package=noq-proto", "-P", "proptests", "--no-fail-fast", "${@}"]
|
|
|
|
[tasks.check-external-types]
|
|
description = "Run cargo check-external-types on workspace crates"
|
|
workspace = true
|
|
toolchain = "${TOOLCHAIN:nightly-2025-10-18}"
|
|
command = "cargo"
|
|
args = ["check-external-types", "--features", "__all_without_fips"]
|