Improve CI: cargo cranky + pinned wasm-bindgen-cli (#17)

emilk · web-flow · commit 91c1663d942c · 2022-07-26T11:08:56.000+02:00
* Use cargo cranky cargo cranky (https://github.com/ericseppanen/cargo-cranky) is a new tool that passes lints specified in a Cranky.toml to cargo clippy. This is a possible solution to rust-lang/cargo#5034 * Use pinned version of wasm-bindgen-cli * Add bacon.toml for https://github.com/Canop/bacon
diff --git a/.cargo/config.toml b/.cargo/config.toml
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -92,8 +92,8 @@ jobs:
           command: fmt
           args: --all -- --check
 
-  clippy:
-    name: Clippy
+  cranky:
+    name: cargo cranky
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -103,11 +103,11 @@ jobs:
           toolchain: 1.62.0
           override: true
       - run: sudo apt-get update && sudo apt-get install libgtk-3-dev
-      - run: rustup component add clippy
+      - run: cargo install cargo-cranky
       - uses: actions-rs/cargo@v1
         with:
-          command: clippy
-          args: --all-features -- -D warnings
+          command: cranky
+          args: --workspace --all-targets --all-features --  -D warnings
 
   cargo-deny:
     name: cargo deny
@@ -143,5 +143,5 @@ jobs:
           toolchain: 1.62.0
           override: true
       - run: rustup target add wasm32-unknown-unknown
-      - run: cargo install wasm-bindgen-cli
+      - run: ./crates/re_viewer/setup_web.sh
       - run: ./crates/re_viewer/wasm_bindgen_check.sh
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cranky.toml b/Cranky.toml
@@ -0,0 +1,106 @@
+# https://github.com/ericseppanen/cargo-cranky
+# cargo install cargo-cranky && cargo cranky
+
+deny = [
+  "unsafe_code",
+]
+
+warn = [
+    "clippy::all",
+    "clippy::await_holding_lock",
+    "clippy::char_lit_as_u8",
+    "clippy::checked_conversions",
+    "clippy::dbg_macro",
+    "clippy::debug_assert_with_mut_call",
+    "clippy::disallowed_methods",
+    "clippy::disallowed_script_idents",
+    "clippy::doc_markdown",
+    "clippy::empty_enum",
+    "clippy::enum_glob_use",
+    "clippy::equatable_if_let",
+    "clippy::exit",
+    "clippy::expl_impl_clone_on_copy",
+    "clippy::explicit_deref_methods",
+    "clippy::explicit_into_iter_loop",
+    "clippy::fallible_impl_from",
+    "clippy::filter_map_next",
+    "clippy::flat_map_option",
+    "clippy::float_cmp_const",
+    "clippy::fn_params_excessive_bools",
+    "clippy::fn_to_numeric_cast_any",
+    "clippy::from_iter_instead_of_collect",
+    "clippy::if_let_mutex",
+    "clippy::implicit_clone",
+    "clippy::imprecise_flops",
+    "clippy::index_refutable_slice",
+    "clippy::inefficient_to_string",
+    "clippy::invalid_upcast_comparisons",
+    "clippy::iter_not_returning_iterator",
+    "clippy::large_digit_groups",
+    "clippy::large_stack_arrays",
+    "clippy::large_types_passed_by_value",
+    "clippy::let_unit_value",
+    "clippy::linkedlist",
+    "clippy::lossy_float_literal",
+    "clippy::macro_use_imports",
+    "clippy::manual_ok_or",
+    "clippy::map_err_ignore",
+    "clippy::map_flatten",
+    "clippy::map_unwrap_or",
+    "clippy::match_on_vec_items",
+    "clippy::match_same_arms",
+    "clippy::match_wild_err_arm",
+    "clippy::match_wildcard_for_single_variants",
+    "clippy::mem_forget",
+    "clippy::mismatched_target_os",
+    "clippy::missing_enforced_import_renames",
+    "clippy::missing_safety_doc",
+    "clippy::mut_mut",
+    "clippy::mutex_integer",
+    "clippy::needless_borrow",
+    "clippy::needless_continue",
+    "clippy::needless_for_each",
+    "clippy::needless_pass_by_value",
+    "clippy::negative_feature_names",
+    "clippy::nonstandard_macro_braces",
+    "clippy::option_option",
+    "clippy::path_buf_push_overwrite",
+    "clippy::ptr_as_ptr",
+    "clippy::rc_mutex",
+    "clippy::ref_option_ref",
+    "clippy::rest_pat_in_fully_bound_structs",
+    "clippy::same_functions_in_if_condition",
+    "clippy::semicolon_if_nothing_returned",
+    "clippy::single_match_else",
+    "clippy::str_to_string",
+    "clippy::string_add_assign",
+    "clippy::string_add",
+    "clippy::string_lit_as_bytes",
+    "clippy::string_to_string",
+    "clippy::todo",
+    "clippy::trailing_empty_array",
+    "clippy::trait_duplication_in_bounds",
+    "clippy::unimplemented",
+    "clippy::unnecessary_wraps",
+    "clippy::unnested_or_patterns",
+    "clippy::unused_self",
+    "clippy::useless_transmute",
+    "clippy::verbose_file_reads",
+    "clippy::zero_sized_map_values",
+    "future_incompatible",
+    "nonstandard_style",
+    "rust_2018_idioms",
+    "rustdoc::missing_crate_level_docs",
+    "semicolon_in_expressions_from_macros",
+    "trivial_numeric_casts",
+    "unused_extern_crates",
+    "unused_import_braces",
+    # "clippy::cloned_instead_of_copied",
+    # "clippy::missing_errors_doc",
+    # "clippy::mod_module_files",
+    # "trivial_casts",
+    # "unused_qualifications",
+]
+
+allow = [
+]
diff --git a/bacon.toml b/bacon.toml
@@ -0,0 +1,46 @@
+# This is a configuration file for the bacon tool
+# More info at https://github.com/Canop/bacon
+
+default_job = "cranky"
+
+[jobs]
+
+[jobs.cranky]
+command = ["cargo", "cranky", "--all-targets", "--all-features", "--color", "always"]
+need_stdout = false
+watch = ["tests", "benches", "examples"]
+
+[jobs.test]
+command = ["cargo", "test", "--color", "always"]
+need_stdout = true
+watch = ["tests"]
+
+[jobs.doc]
+command = ["cargo", "doc", "--color", "always", "--all-features", "--no-deps"]
+need_stdout = false
+
+# if the doc compiles, then it opens in your browser and bacon switches
+# to the previous job
+[jobs.doc-open]
+command = ["cargo", "doc", "--color", "always", "--all-features", "--no-deps", "--open"]
+need_stdout = false
+on_success = "back" # so that we don't open the browser at each change
+
+# You can run your application and have the result displayed in bacon,
+# *if* it makes sense for this crate. You can run an example the same
+# way. Don't forget the `--color always` part or the errors won't be
+# properly parsed.
+[jobs.run]
+command = ["cargo", "run", "--color", "always"]
+need_stdout = true
+
+# You may define here keybindings that would be specific to
+# a project, for example a shortcut to launch a specific job.
+# Shortcuts to internal functions (scrolling, toggling, etc.)
+# should go in your personal prefs.toml file instead.
+[keybindings]
+i = "job:initial"
+c = "job:cranky"
+d = "job:doc-open"
+t = "job:test"
+r = "job:run"
diff --git a/check.sh b/check.sh
@@ -2,14 +2,16 @@
 # This scripts runs various CI-like checks in a convenient way.
 set -eux
 
+cargo install cargo-cranky # Uses lints defined in Cranky.toml. See https://github.com/ericseppanen/cargo-cranky
+
 RUSTFLAGS="-D warnings"
 RUSTDOCFLAGS="-D warnings" # https://github.com/emilk/egui/pull/1454
 
 cargo build --all-features
 cargo check --workspace --all-targets --all-features
 cargo check -p re_viewer --all-features --lib --target wasm32-unknown-unknown
 cargo fmt --all -- --check
-cargo clippy --workspace --all-targets --all-features --  -D warnings -W clippy::all
+cargo cranky --workspace --all-targets --all-features -- -D warnings
 cargo test --workspace --all-targets --all-features
 cargo test --workspace --doc --all-features
 
diff --git a/crates/re_viewer/build_web.sh b/crates/re_viewer/build_web.sh
@@ -3,6 +3,8 @@ set -eu
 script_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
 cd "$script_path/../.."
 
+./crates/re_viewer/setup_web.sh
+
 OPEN=false
 FAST=false
 
diff --git a/crates/re_viewer/setup_web.sh b/crates/re_viewer/setup_web.sh
@@ -5,8 +5,7 @@ cd "$script_path/../.."
 
 # Pre-requisites:
 rustup target add wasm32-unknown-unknown
-cargo install wasm-bindgen-cli
-cargo update -p wasm-bindgen
+cargo install wasm-bindgen-cli --version 0.2.82
 
 # Required by build_web.sh:
 packagesNeeded='binaryen jq'
diff --git a/crates/re_viewer/wasm_bindgen_check.sh b/crates/re_viewer/wasm_bindgen_check.sh
