Mirrors/ratatui
2
0
Fork 0
mirror of https://github.com/ratatui-org/ratatui synced 2024-11-22 12:43:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore(make): add task descriptions to Makefile.toml (#398)

Browse source
This commit is contained in:
Orhun Parmaksız 2023-08-12 21:48:00 +02:00 committed by GitHub
parent f63ac72305
commit 268bbed17e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
Makefile.toml
View file

@ -11,6 +11,7 @@ ALL_FEATURES = "all-widgets,macros,serde"
alias = "ci" alias = "ci"
[tasks.ci] [tasks.ci]
description = "Run continuous integration tasks"
dependencies = [ dependencies = [
"style-check", "style-check",
"clippy", "clippy",
@ -19,18 +20,22 @@ dependencies = [
] ]
[tasks.style-check] [tasks.style-check]
description = "Check code style"
dependencies = ["fmt", "typos"] dependencies = ["fmt", "typos"]
[tasks.fmt] [tasks.fmt]
description = "Format source code"
toolchain = "nightly" toolchain = "nightly"
command = "cargo" command = "cargo"
args = ["fmt", "--all", "--check"] args = ["fmt", "--all", "--check"]
[tasks.typos] [tasks.typos]
description = "Run typo checks"
install_crate = { crate_name = "typos-cli", binary = "typos", test_arg = "--version" } install_crate = { crate_name = "typos-cli", binary = "typos", test_arg = "--version" }
command = "typos" command = "typos"
[tasks.check] [tasks.check]
description = "Check code for errors and warnings"
command = "cargo" command = "cargo"
args = [ args = [
"check", "check",
@ -46,6 +51,7 @@ args = [
] ]
[tasks.build] [tasks.build]
description = "Compile the project"
command = "cargo" command = "cargo"
args = [ args = [
"build", "build",
@ -61,6 +67,7 @@ args = [
] ]
[tasks.clippy] [tasks.clippy]
description = "Run Clippy for linting"
command = "cargo" command = "cargo"
args = [ args = [
"clippy", "clippy",
@ -86,6 +93,7 @@ args = [
] ]
[tasks.test] [tasks.test]
description = "Run tests"
dependencies = [ dependencies = [
"test-doc", "test-doc",
] ]
@ -98,6 +106,7 @@ args = [
[tasks.test-windows] [tasks.test-windows]
description = "Run tests on Windows"
dependencies = [ dependencies = [
"test-doc", "test-doc",
] ]
@ -108,6 +117,7 @@ args = [
] ]
[tasks.test-doc] [tasks.test-doc]
description = "Run documentation tests"
command = "cargo" command = "cargo"
args = [ args = [
"test", "--doc", "test", "--doc",
@ -122,6 +132,7 @@ args = [
[tasks.test-backend] [tasks.test-backend]
# takes a command line parameter to specify the backend to test (e.g. "crossterm") # takes a command line parameter to specify the backend to test (e.g. "crossterm")
description = "Run backend-specific tests"
command = "cargo" command = "cargo"
args = [ args = [
"test", "test",
@ -131,6 +142,7 @@ args = [
[tasks.coverage] [tasks.coverage]
description = "Generate code coverage report"
command = "cargo" command = "cargo"
args = [ args = [
"llvm-cov", "llvm-cov",
@ -156,10 +168,12 @@ command = "cargo"
args = ["run", "--release", "--example", "${TUI_EXAMPLE_NAME}", "--features", "all-widgets"] args = ["run", "--release", "--example", "${TUI_EXAMPLE_NAME}", "--features", "all-widgets"]
[tasks.build-examples] [tasks.build-examples]
description = "Compile project examples"
command = "cargo" command = "cargo"
args = ["build", "--examples", "--release", "--features", "all-widgets"] args = ["build", "--examples", "--release", "--features", "all-widgets"]
[tasks.run-examples] [tasks.run-examples]
description = "Run project examples"
dependencies = ["build-examples"] dependencies = ["build-examples"]
script = ''' script = '''
#!@duckscript #!@duckscript