Merge #21: Add support for running crate specific extra_lints.sh

7c6233a Update README (Jamil Lambert, PhD)
856e83d Add support for running crate specific extra_lints (Jamil Lambert, PhD)
943ca06 Remove workspace no-default-features clippy run (Jamil Lambert, PhD)
14e5c1e Fix indentation (Jamil Lambert, PhD)

Pull request description:

  Some lints need to be run at the crate level, e.g. no-default-features dos not run correctly with clippy on a workspace. Other crate specific lints can also be useful in CI.

  - Fix indentation issues.
  - Remove the clippy run on workspace with no-default-features.
  - Add support for running crate specific extra_lints.sh scripts.

  This was all motivated by the issue rust-bitcoin/rust-bitcoin#5060

ACKs for top commit:
  apoelstra:
    utACK 7c6233a
  tcharding:
    ACK 7c6233a

Tree-SHA512: 912f5d5988a27c477b0a34e3e2c525e2d353ccac3c3c1eaa01b283a8a379dad785c3227541afacca7445e10981d28b3e58225c8101b94f1bfce56309c66d3aab

Author: tcharding

ci/README.md

@@ -31,6 +31,7 @@ And for each crate there should exist a directory `REPO_DIR/CRATE/contrib/` cont
 
 - `test_vars.sh`: Defines environment variables
 - Optional: `extra_tests.sh`: Additional test script.
+- Optional: `extra_lints.sh`: Additional lint script.
 
 If the repository is not a workspace then per crate files go directly in `REPO_ROOT/contrib/`.
 

ci/run_task.sh

@@ -72,40 +72,41 @@ main() {
     fi
 
     case $task in
-	stable)
-            # Test, run examples, do feature matrix.
-            # crate/contrib/test_vars.sh is sourced in this function.
-            build_and_test
-            ;;
-
-	nightly)
-            build_and_test
-            ;;
-
-	msrv)
-            build_and_test
-            ;;
-
-        lint)
-            do_lint
-            do_dup_deps
-            ;;
-
-	docs)
-            build_docs_with_stable_toolchain
-	    ;;
-
-	docsrs)
-            build_docs_with_nightly_toolchain
-	    ;;
-
-	bench)
-	    do_bench
-	    ;;
-
-        *)
-            err "Error: unknown task $task"
-            ;;
+    stable)
+        # Test, run examples, do feature matrix.
+        # crate/contrib/test_vars.sh is sourced in this function.
+        build_and_test
+        ;;
+
+    nightly)
+        build_and_test
+        ;;
+
+    msrv)
+        build_and_test
+        ;;
+
+    lint)
+        do_lint_workspace
+        do_lint_crates
+        do_dup_deps
+        ;;
+
+    docs)
+        build_docs_with_stable_toolchain
+        ;;
+
+    docsrs)
+        build_docs_with_nightly_toolchain
+        ;;
+
+    bench)
+        do_bench
+        ;;
+
+    *)
+        err "Error: unknown task $task"
+        ;;
     esac
 }
 
@@ -228,17 +229,22 @@ loop_features() {
 }
 
 # Lint the workspace.
-do_lint() {
+do_lint_workspace() {
     need_nightly
-
     $cargo clippy --workspace --all-targets --all-features --keep-going -- -D warnings
+    $cargo clippy --workspace --all-targets --keep-going -- -D warnings
+}
 
-    # Ugly hack to skip `corpec` because `node` does not build with no default features.
-    if echo "$REPO_DIR" | grep -viq "corepc"; then
-        # Lint various feature combinations to try and catch mistakes in feature gating.
-        $cargo clippy --workspace --all-targets --keep-going -- -D warnings
-        $cargo clippy --workspace --all-targets --no-default-features --keep-going -- -D warnings
-    fi
+# Run extra crate specific lints, e.g. clippy with no-default-features.
+do_lint_crates() {
+    need_nightly
+    for crate in $CRATES; do
+        pushd "$REPO_DIR/$crate" > /dev/null
+        if [ -e ./contrib/extra_lints.sh ]; then
+            ./contrib/extra_lints.sh
+        fi
+        popd > /dev/null
+    done
 }
 
 # We should not have any duplicate dependencies. This catches mistakes made upgrading dependencies
@@ -332,7 +338,7 @@ say_err() {
 
 verbose_say() {
     if [ "$flag_verbose" = true ]; then
-	say "$1"
+        say "$1"
     fi
 }