Skip to content

Commit

Permalink
Improve check script to allow running just some checks.
Browse files Browse the repository at this point in the history
  • Loading branch information
orium committed Nov 10, 2024
1 parent 6b84286 commit e3ac198
Show file tree
Hide file tree
Showing 4 changed files with 124 additions and 35 deletions.
23 changes: 21 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,15 @@ jobs:
- name: Install cargo plugins
run: |
cargo install cargo-rdme
cargo install cargo-machete
cargo install taplo-cli
cargo install cargo-deadlinks
- name: Checkout repository
uses: actions/checkout@v4

- name: Check everything
run: bash ./tools/check.sh
run: bash ./tools/check.sh basic doc_url_links unused_deps packaging fmt toml_fmt readme

msrv:
runs-on: ubuntu-latest
Expand All @@ -54,4 +56,21 @@ jobs:
uses: actions/checkout@v4

- name: Check the minimum supported rust version
run: cargo msrv verify
run: bash ./tools/check.sh msrv

clippy:
runs-on: ubuntu-latest

steps:
- name: Install dependencies
run: |
sudo apt-get install -y libpango1.0-dev libgraphene-1.0-dev libgtk-4-dev
- name: Install rust
uses: dtolnay/rust-toolchain@stable

- name: Checkout repository
uses: actions/checkout@v4

- name: Run clippy
run: bash ./tools/check.sh clippy
17 changes: 17 additions & 0 deletions .taplo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
include = ["**/*.toml"]
exclude = ["target/**"]

[formatting]
column_width = 100
indent_string = ' '
allowed_blank_lines = 1

[[rule]]
formatting = { reorder_keys = true }
keys = [
"workspace.dependencies",
"dependencies",
"dev-dependencies",
"build-dependencies",
"lints.clippy",
]
25 changes: 11 additions & 14 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,9 @@ repository = "https://github.com/orium/shrug"
documentation = "https://docs.rs/shrug"
readme = "README.md"

keywords = [
"shortcut",
"strings",
"clipboard",
]
keywords = ["shortcut", "strings", "clipboard"]

categories = [
"gui",
]
categories = ["gui"]

license = "MPL-2.0"

Expand All @@ -39,25 +33,28 @@ include = [
codecov = { repository = "orium/shrug", branch = "main", service = "github" }

[dependencies]
gtk4 = { version = "0.9.1", features = ["v4_6"] }
async-channel = "2.3.1"
dirs = "5.0.1"
gdk4 = { version = "0.9.0", features = ["v4_6"] }
gio = { version = "0.20.1", features = ["v2_70"] }
glib = "0.20.2"
toml = "0.8.19"
dirs = "5.0.1"
gtk4 = { version = "0.9.1", features = ["v4_6"] }
rayon = "1.10.0"
serde = "1.0.209"
serde_derive = "1.0.209"
sublime_fuzzy = "0.7.0"
rayon = "1.10.0"
async-channel = "2.3.1"
toml = "0.8.19"

[features]
fatal-warnings = []

[package.metadata.cargo-machete]
ignored = ["serde"]

[lints.clippy]
all = { level = "warn", priority = -2 }
pedantic = { level = "warn", priority = -2 }
correctness = { level = "deny", priority = -1 }
pedantic = { level = "warn", priority = -2 }

match-bool = "allow"
needless-for-each = "allow"
Expand Down
94 changes: 75 additions & 19 deletions tools/check.sh
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,84 @@ function on_failure {
echo -e "${RED}Whoopsie-daisy: something failed!$NC" >&2
}

assert_installed "cargo-deadlinks"
assert_installed "cargo-fmt"
assert_installed "cargo-rdme"
assert_installed "cargo"

trap on_failure ERR

echo 'Building:'
cargo build --features fatal-warnings --all-targets
echo 'Testing:'
cargo test --features fatal-warnings --all-targets
echo 'Checking documentation:'
cargo doc --features fatal-warnings --no-deps --document-private-items

echo 'Checking links:'
cargo deadlinks

echo 'Checking packaging:'
cargo package --allow-dirty
echo 'Checking code style:'
cargo fmt -- --check
echo 'Checking readme:'
cargo rdme --check
function check_basic {
echo 'Building:'
cargo build --features fatal-warnings --all-targets
echo 'Testing:'
cargo test --features fatal-warnings --all-targets
echo 'Checking the benchmarks:'
cargo bench --features fatal-warnings -- --test
echo 'Checking documentation:'
cargo doc --features fatal-warnings --no-deps --document-private-items
}

function check_doc_url_links {
assert_installed "cargo-deadlinks"

echo 'Checking doc url links:'
cargo deadlinks
}

function check_unused_deps {
assert_installed "cargo-machete"

echo 'Checking unused dependencies:'
cargo machete
}

function check_packaging {
echo 'Checking packaging:'
cargo package --allow-dirty
}

function check_fmt {
assert_installed "cargo-fmt"

echo 'Checking code format:'
cargo fmt -- --check
}

function check_toml_fmt {
assert_installed "taplo"

echo 'Checking toml format:'
taplo fmt --check
}

function check_readme {
assert_installed "cargo-rdme"

echo 'Checking readme:'
cargo rdme --check
}

function check_msrv {
assert_installed "cargo-msrv"

echo 'Checking the minimum supported rust version:'
cargo msrv verify
}

function check_clippy {
assert_installed "cargo-clippy"

echo 'Checking with clippy:'
cargo clippy --all-targets -- -D warnings
}

to_run=(basic doc_url_links unused_deps packaging fmt toml_fmt readme msrv clippy)

if [ $# -ge 1 ]; then
to_run=("$@")
fi

for check in "${to_run[@]}"; do
check_$check
done

echo
echo -e "${GREEN}Everything looks lovely!$NC"
Expand Down

0 comments on commit e3ac198

Please sign in to comment.