Skip to content

Commit

Permalink
chore(make): add task descriptions to Makefile.toml (#398)
Browse files Browse the repository at this point in the history
  • Loading branch information
orhun authored Aug 12, 2023
1 parent f63ac72 commit 268bbed
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions Makefile.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ ALL_FEATURES = "all-widgets,macros,serde"
alias = "ci"

[tasks.ci]
description = "Run continuous integration tasks"
dependencies = [
"style-check",
"clippy",
Expand All @@ -19,18 +20,22 @@ dependencies = [
]

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

[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]
description = "Check code for errors and warnings"
command = "cargo"
args = [
"check",
Expand All @@ -46,6 +51,7 @@ args = [
]

[tasks.build]
description = "Compile the project"
command = "cargo"
args = [
"build",
Expand All @@ -61,6 +67,7 @@ args = [
]

[tasks.clippy]
description = "Run Clippy for linting"
command = "cargo"
args = [
"clippy",
Expand All @@ -86,6 +93,7 @@ args = [
]

[tasks.test]
description = "Run tests"
dependencies = [
"test-doc",
]
Expand All @@ -98,6 +106,7 @@ args = [


[tasks.test-windows]
description = "Run tests on Windows"
dependencies = [
"test-doc",
]
Expand All @@ -108,6 +117,7 @@ args = [
]

[tasks.test-doc]
description = "Run documentation tests"
command = "cargo"
args = [
"test", "--doc",
Expand All @@ -122,6 +132,7 @@ args = [

[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",
Expand All @@ -131,6 +142,7 @@ args = [


[tasks.coverage]
description = "Generate code coverage report"
command = "cargo"
args = [
"llvm-cov",
Expand All @@ -156,10 +168,12 @@ 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
Expand Down

0 comments on commit 268bbed

Please sign in to comment.