ratatui/Makefile.toml

# configuration for https://github.com/sagiegurari/cargo-make

[config]
skip_core_tasks = true

[env]
# all features except the backend ones
ALL_FEATURES = "all-widgets,macros,serde"

[tasks.default]
alias = "ci"

[tasks.ci]
description = "Run continuous integration tasks"
dependencies = [
  "style-check",
  "clippy",
  "check",
  "test",
]

[tasks.style-check]
description = "Check code style"
dependencies = ["fmt", "typos", "check-doc"]

[tasks.fmt]
description = "Format source code"
toolchain = "nightly"
command = "cargo"
args = ["fmt", "--all", "--check"]

[tasks.typos]
description = "Run typo checks"
install_crate = { crate_name = "typos-cli", binary = "typos", test_arg = "--version" }
command = "typos"

[tasks.check-doc]
description = "Check documentation for errors and warnings"
toolchain = "nightly"
command = "cargo"
args = [
  "rustdoc",
  "--all-features",
  "--",
  "-Zunstable-options",
  "--check",
  "-Dwarnings"
]

[tasks.check]
description = "Check code for errors and warnings"
command = "cargo"
args = [
  "check",
  "--all-targets",
  "--all-features"
]

[tasks.check.windows]
args = [
  "check",
  "--all-targets",
  "--no-default-features", "--features", "${ALL_FEATURES},crossterm,termwiz"
]

[tasks.build]
description = "Compile the project"
command = "cargo"
args = [
  "build",
  "--all-targets",
  "--all-features",
]

[tasks.build.windows]
args = [
  "build",
  "--all-targets",
  "--no-default-features", "--features", "${ALL_FEATURES},crossterm,termwiz"
]

[tasks.clippy]
description = "Run Clippy for linting"
command = "cargo"
args = [
  "clippy",
  "--all-targets",
  "--tests",
  "--benches",
  "--all-features",
  "--",
  "-D",
  "warnings",
]

[tasks.clippy.windows]
args = [
  "clippy",
  "--all-targets",
  "--tests",
  "--benches",
  "--no-default-features", "--features", "${ALL_FEATURES},crossterm,termwiz",
  "--",
  "-D",
  "warnings",
]

[tasks.test]
description = "Run tests"
dependencies = [
  "test-doc",
]
command = "cargo"
args = [
  "test",
  "--all-targets",
  "--all-features",
]


[tasks.test-windows]
description = "Run tests on Windows"
dependencies = [
  "test-doc",
]
args = [
  "test",
  "--all-targets",
  "--no-default-features", "--features", "${ALL_FEATURES},crossterm,termwiz"
]

[tasks.test-doc]
description = "Run documentation tests"
command = "cargo"
args = [
  "test", "--doc",
  "--all-features",
]

[tasks.test-doc.windows]
args = [
  "test", "--doc",
  "--no-default-features", "--features", "${ALL_FEATURES},crossterm,termwiz"
]

[tasks.test-backend]
# takes a command line parameter to specify the backend to test (e.g. "crossterm")
description = "Run backend-specific tests"
command = "cargo"
args = [
  "test",
  "--all-targets",
  "--no-default-features", "--features", "${ALL_FEATURES},${@}"
]


[tasks.coverage]
description = "Generate code coverage report"
command = "cargo"
args = [
  "llvm-cov",
  "--lcov",
  "--output-path", "target/lcov.info",
  "--all-features",
]

[tasks.coverage.windows]
command = "cargo"
args = [
  "llvm-cov",
  "--lcov",
  "--output-path", "target/lcov.info",
  "--no-default-features",
  "--features", "${ALL_FEATURES},crossterm,termwiz",
]

[tasks.run-example]
private = true
condition = { env_set = ["TUI_EXAMPLE_NAME"] }
command = "cargo"
args = ["run", "--release", "--example", "${TUI_EXAMPLE_NAME}", "--features", "all-widgets"]

[tasks.build-examples]
description = "Compile project examples"
command = "cargo"
args = ["build", "--examples", "--release", "--features", "all-widgets"]

[tasks.run-examples]
description = "Run project examples"
dependencies = ["build-examples"]
script = '''
#!@duckscript
files = glob_array ./examples/*.rs
for file in ${files}
  name = basename ${file}
  name = substring ${name} -3
  set_env TUI_EXAMPLE_NAME ${name}
  cm_run_task run-example
end
'''