chore: more precommit hooks (#1325)

jjmaestro · James Sharpe · web-flow · commit be14ccaec581 · 2024-11-27T01:20:16.000Z
Co-authored-by: James Sharpe &lt;james.sharpe@zenotech.com&gt;
diff --git a/.github/workflows/release_prep.sh b/.github/workflows/release_prep.sh
@@ -8,8 +8,8 @@ TAG=${GITHUB_REF_NAME}
 # The prefix is chosen to match what GitHub generates for source archives
 PREFIX="rules_foreign_cc-${TAG}"
 ARCHIVE="rules_foreign_cc-$TAG.tar.gz"
-git archive --format=tar --prefix=${PREFIX}/ ${TAG} | gzip > $ARCHIVE
-SHA=$(shasum -a 256 $ARCHIVE | awk '{print $1}')
+git archive --format=tar --prefix="${PREFIX}"/ "${TAG}" | gzip > "$ARCHIVE"
+SHA="$(shasum -a 256 "$ARCHIVE" | awk '{print $1}')"
 
 cat << EOF
 ## Using Bzlmod with Bazel 6
@@ -23,7 +23,7 @@ bazel_dep(name = "rules_foreign_cc", version = "${TAG}")
 
 ## Using WORKSPACE
 
-Paste this snippet into your `WORKSPACE.bazel` file:
+Paste this snippet into your \`WORKSPACE.bazel\` file:
 
 \`\`\`starlark
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
@@ -43,4 +43,4 @@ EOF
 
 # TODO: add example of how to configure for bzlmod
 # awk 'f;/--SNIP--/{f=1}' e2e/smoke/WORKSPACE.bazel
-echo "\`\`\`" 
+echo "\`\`\`"
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,10 +1,23 @@
 # See CONTRIBUTING.md for instructions.
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+exclude: >-
+  (?x)^(
+    bazel-.*/.*
+    |.*\.patch
+    |.*\.diff
+    |test/(expected|.*/expected)/.*\.txt
+    |examples/(?!.*CMakeLists\.txt$).*\.txt
+  )$
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
       - id: check-yaml
 
   - repo: https://github.com/keith/pre-commit-buildifier
@@ -21,16 +34,22 @@ repos:
     rev: v0.6.0
     hooks:
       - id: action-validator
-        files: >-
-          (?x)^(
-            .github/workflows/pages.yaml
-          )$
 
   - repo: https://github.com/rhysd/actionlint
     rev: v1.7.4
     hooks:
       - id: actionlint
-        files: >-
+
+  - repo: https://github.com/mrtazz/checkmake.git
+    rev: 0.2.2
+    hooks:
+      - id: checkmake
+
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+        exclude: >-
           (?x)^(
-            .github/workflows/pages.yaml
+            examples/.*
           )$
diff --git a/docs/index.md b/docs/index.md
@@ -25,7 +25,7 @@ load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 
 http_archive(
     name = "rules_foreign_cc",
-    # TODO: Get the latest sha256 value from a bazel debug message or the latest 
+    # TODO: Get the latest sha256 value from a bazel debug message or the latest
     #       release on the releases page: https://github.com/bazel-contrib/rules_foreign_cc/releases
     #
     # sha256 = "...",
diff --git a/docs/tools/workspace_status.sh b/docs/tools/workspace_status.sh
@@ -4,4 +4,4 @@ set -euo pipefail
 
 echo STABLE_SCM_SHORT_VERSION "$(git rev-parse --short HEAD)"
 echo STABLE_SCM_VERSION "$(git rev-parse HEAD)"
-echo STABLE_RELEASE "$(cat ../version.bzl | grep VERSION | sed 's/VERSION = "//' | sed 's/"//')"
+echo STABLE_RELEASE "$(grep VERSION ../version.bzl | sed 's/VERSION = "//' | sed 's/"//')"
diff --git a/examples/cmake_android/hello_lib-example.cpp b/examples/cmake_android/hello_lib-example.cpp
@@ -5,4 +5,4 @@ int main(int argc, char* argv[])
 {
   hello_func();
   return 0;
-}
+}
diff --git a/examples/cmake_android/res/mipmap-anydpi-v26/ic_launcher.xml b/examples/cmake_android/res/mipmap-anydpi-v26/ic_launcher.xml
@@ -2,4 +2,4 @@
 <adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
     <background android:drawable="@drawable/ic_launcher_background" />
     <foreground android:drawable="@drawable/ic_launcher_foreground" />
-</adaptive-icon>
+</adaptive-icon>
diff --git a/examples/cmake_android/res/mipmap-anydpi-v26/ic_launcher_round.xml b/examples/cmake_android/res/mipmap-anydpi-v26/ic_launcher_round.xml
@@ -2,4 +2,4 @@
 <adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
     <background android:drawable="@drawable/ic_launcher_background" />
     <foreground android:drawable="@drawable/ic_launcher_foreground" />
-</adaptive-icon>
+</adaptive-icon>
diff --git a/examples/cmake_android/zlib-example.cpp b/examples/cmake_android/zlib-example.cpp
@@ -77,4 +77,4 @@ int main(int argc, char* argv[])
     assert(strcmp(a,c)==0);
 
     return 0;
-}
+}
diff --git a/examples/cmake_crosstool/.bazelrc b/examples/cmake_crosstool/.bazelrc
@@ -1,2 +1,2 @@
 build --crosstool_top=//tools/arm_compiler:toolchain --cpu=armeabi-v7a --spawn_strategy=standalone --experimental_cc_skylark_api_enabled_packages=@rules_foreign_cc//tools/build_defs,tools/build_defs,@foreign_cc_impl
-test --crosstool_top=//tools/arm_compiler:toolchain --cpu=armeabi-v7a --spawn_strategy=standalone --experimental_cc_skylark_api_enabled_packages=@rules_foreign_cc//tools/build_defs,tools/build_defs,@foreign_cc_impl
+test --crosstool_top=//tools/arm_compiler:toolchain --cpu=armeabi-v7a --spawn_strategy=standalone --experimental_cc_skylark_api_enabled_packages=@rules_foreign_cc//tools/build_defs,tools/build_defs,@foreign_cc_impl
diff --git a/examples/cmake_crosstool/static/CMakeLists.txt b/examples/cmake_crosstool/static/CMakeLists.txt
@@ -5,4 +5,4 @@ cmake_minimum_required(VERSION 2.8.4)
 
 project(hellolib)
 
-add_subdirectory(src)
+add_subdirectory(src)
diff --git a/examples/cmake_crosstool/static/hello_client.c b/examples/cmake_crosstool/static/hello_client.c
@@ -4,4 +4,4 @@ int main(int argc, char* argv[])
 {
   hello_func();
   return 0;
-}
+}
diff --git a/examples/cmake_crosstool/static/hello_client_version123.c b/examples/cmake_crosstool/static/hello_client_version123.c
@@ -4,4 +4,4 @@ int main(int argc, char* argv[])
 {
   hello_func();
   return 0;
-}
+}
diff --git a/examples/cmake_crosstool/static/src/CMakeLists.txt b/examples/cmake_crosstool/static/src/CMakeLists.txt
@@ -13,4 +13,4 @@ set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)
 
 install(TARGETS hello_static ARCHIVE DESTINATION lib)
 
-install(FILES hello.h DESTINATION include/version123)
+install(FILES hello.h DESTINATION include/version123)
diff --git a/examples/cmake_crosstool/static/src/hello.c b/examples/cmake_crosstool/static/src/hello.c
@@ -4,4 +4,4 @@ void hello_func(void) {
 	printf("Hello World!\n");
 
 	return;
-}
+}
diff --git a/examples/cmake_crosstool/static/src/hello.h b/examples/cmake_crosstool/static/src/hello.h
@@ -5,4 +5,4 @@
 
 void hello_func(void);
 
-#endif
+#endif
diff --git a/examples/cmake_crosstool/static/test_hello.sh b/examples/cmake_crosstool/static/test_hello.sh
@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 
-$(rlocation rules_foreign_cc/examples/cmake_hello_world_lib/$1)
+$(rlocation rules_foreign_cc/examples/cmake_hello_world_lib/$1)
diff --git a/examples/cmake_defines/lib_a/CMakeLists.txt b/examples/cmake_defines/lib_a/CMakeLists.txt
@@ -1,4 +1,4 @@
 project(cmake_defines)
 
 add_library(lib_a lib_a.cpp)
-install(TARGETS lib_a ARCHIVE DESTINATION lib)
+install(TARGETS lib_a ARCHIVE DESTINATION lib)
diff --git a/examples/cmake_defines/lib_b/CMakeLists.txt b/examples/cmake_defines/lib_b/CMakeLists.txt
@@ -1,4 +1,4 @@
 project(cmake_defines)
 
 add_library(lib_b lib_b.cpp)
-install(TARGETS lib_b ARCHIVE DESTINATION lib)
+install(TARGETS lib_b ARCHIVE DESTINATION lib)
diff --git a/examples/cmake_hello_world_lib/binary/CMakeLists.txt b/examples/cmake_hello_world_lib/binary/CMakeLists.txt
@@ -5,4 +5,4 @@ cmake_minimum_required(VERSION 2.8.4)
 
 project(hellolib LANGUAGES C)
 
-add_subdirectory(src)
+add_subdirectory(src)
diff --git a/examples/cmake_hello_world_lib/binary/src/CMakeLists.txt b/examples/cmake_hello_world_lib/binary/src/CMakeLists.txt
@@ -34,4 +34,4 @@ install(
   TARGETS myapp DESTINATION bin
 )
 
-install(FILES hello.h DESTINATION include)
+install(FILES hello.h DESTINATION include)
diff --git a/examples/cmake_hello_world_lib/binary/src/hello.c b/examples/cmake_hello_world_lib/binary/src/hello.c
@@ -2,4 +2,4 @@
 
 void hello_func(char* name) {
 	printf("Hello, %s!", name);
-}
+}
diff --git a/examples/cmake_hello_world_lib/binary/src/hello.h b/examples/cmake_hello_world_lib/binary/src/hello.h
@@ -5,4 +5,4 @@
 
 void hello_func(char*);
 
-#endif
+#endif
diff --git a/examples/cmake_hello_world_lib/binary/src/main.c b/examples/cmake_hello_world_lib/binary/src/main.c
@@ -4,4 +4,4 @@ int main(int argc, char* argv[])
 {
   hello_func(argv[1]);
   return 0;
-}
+}
diff --git a/examples/cmake_hello_world_lib/shared/CMakeLists.txt b/examples/cmake_hello_world_lib/shared/CMakeLists.txt
@@ -7,4 +7,4 @@ set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
 
 project(hellolib LANGUAGES C)
 
-add_subdirectory(src)
+add_subdirectory(src)
diff --git a/examples/cmake_hello_world_lib/shared/hello_client.c b/examples/cmake_hello_world_lib/shared/hello_client.c
@@ -4,4 +4,4 @@ int main(int argc, char* argv[])
 {
   hello_func();
   return 0;
-}
+}
diff --git a/examples/cmake_hello_world_lib/shared/src/CMakeLists.txt b/examples/cmake_hello_world_lib/shared/src/CMakeLists.txt
@@ -21,4 +21,4 @@ install(
  LIBRARY DESTINATION lib
 )
 
-install(FILES hello.h DESTINATION include)
+install(FILES hello.h DESTINATION include)
diff --git a/examples/cmake_hello_world_lib/shared/src/hello.c b/examples/cmake_hello_world_lib/shared/src/hello.c
@@ -4,4 +4,4 @@ void hello_func(void) {
 	printf("Hello World!\n");
 
 	return;
-}
+}
diff --git a/examples/cmake_hello_world_lib/shared/src/hello.h b/examples/cmake_hello_world_lib/shared/src/hello.h
@@ -5,4 +5,4 @@
 
 void hello_func(void);
 
-#endif
+#endif
diff --git a/examples/cmake_hello_world_lib/static/CMakeLists.txt b/examples/cmake_hello_world_lib/static/CMakeLists.txt
@@ -5,4 +5,4 @@ cmake_minimum_required(VERSION 2.8.4)
 
 project(hellolib)
 
-add_subdirectory(src)
+add_subdirectory(src)
diff --git a/examples/cmake_hello_world_lib/static/hello_client.c b/examples/cmake_hello_world_lib/static/hello_client.c
@@ -4,4 +4,4 @@ int main(int argc, char* argv[])
 {
   hello_func();
   return 0;
-}
+}
diff --git a/examples/cmake_hello_world_lib/static/hello_client_version123.c b/examples/cmake_hello_world_lib/static/hello_client_version123.c
@@ -4,4 +4,4 @@ int main(int argc, char* argv[])
 {
   hello_func();
   return 0;
-}
+}
diff --git a/examples/cmake_hello_world_lib/static/src/hello.c b/examples/cmake_hello_world_lib/static/src/hello.c
@@ -4,4 +4,4 @@ void hello_func(void) {
 	printf("Hello World!\n");
 
 	return;
-}
+}
diff --git a/examples/cmake_synthetic/liba/CMakeLists.txt b/examples/cmake_synthetic/liba/CMakeLists.txt
@@ -2,4 +2,4 @@ cmake_minimum_required(VERSION 2.8.4)
 
 project(liba)
 
-add_subdirectory(src)
+add_subdirectory(src)
diff --git a/examples/cmake_synthetic/liba/src/CMakeLists.txt b/examples/cmake_synthetic/liba/src/CMakeLists.txt
@@ -28,4 +28,4 @@ target_include_directories(liba_static INTERFACE
 
 install(EXPORT liba_targets
   DESTINATION lib/cmake/liba
-  FILE liba-config.cmake)
+  FILE liba-config.cmake)
diff --git a/examples/cmake_synthetic/liba/src/liba.cpp b/examples/cmake_synthetic/liba/src/liba.cpp
@@ -2,4 +2,4 @@
 
 std::string hello_liba(void) {
 	return "Hello from LIBA!";
-}
+}
diff --git a/examples/cmake_synthetic/liba/src/liba.h b/examples/cmake_synthetic/liba/src/liba.h
@@ -6,4 +6,4 @@
 
 std::string hello_liba(void);
 
-#endif
+#endif
diff --git a/examples/cmake_synthetic/libb/src/CMakeLists.txt b/examples/cmake_synthetic/libb/src/CMakeLists.txt
@@ -21,4 +21,4 @@ set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)
 
 install(TARGETS libb_static ARCHIVE DESTINATION lib)
 
-install(FILES libb.h DESTINATION include)
+install(FILES libb.h DESTINATION include)
diff --git a/examples/cmake_synthetic/libb/src/libb.cpp b/examples/cmake_synthetic/libb/src/libb.cpp
@@ -2,4 +2,4 @@
 
 std::string hello_libb(void) {
   return hello_liba() + " Hello from LIBB!";
-}
+}
diff --git a/examples/cmake_synthetic/libb/src/libb.h b/examples/cmake_synthetic/libb/src/libb.h
@@ -7,4 +7,4 @@
 
 std::string hello_libb(void);
 
-#endif
+#endif
diff --git a/examples/cmake_synthetic/libc/src/CMakeLists.txt b/examples/cmake_synthetic/libc/src/CMakeLists.txt
@@ -25,4 +25,4 @@ set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)
 
 install(TARGETS libc_static ARCHIVE DESTINATION lib)
 
-install(FILES libc.h DESTINATION include)
+install(FILES libc.h DESTINATION include)
diff --git a/examples/cmake_synthetic/libc/src/libc.cpp b/examples/cmake_synthetic/libc/src/libc.cpp
@@ -2,4 +2,4 @@
 
 std::string hello_libc(void) {
   return hello_liba() + " " + hello_libb() + " Hello from LIBC!";
-}
+}
diff --git a/examples/cmake_synthetic/libc/src/libc.h b/examples/cmake_synthetic/libc/src/libc.h
@@ -8,4 +8,4 @@
 
 std::string hello_libc(void);
 
-#endif
+#endif
diff --git a/examples/cmake_synthetic/test_libb.cpp b/examples/cmake_synthetic/test_libb.cpp
@@ -11,4 +11,4 @@ int main(int argc, char* argv[])
     throw std::runtime_error("Wrong result: " + result);
   }
   std::cout << "Everything's fine!";
-}
+}
diff --git a/examples/cmake_with_bazel_transitive/libb/src/CMakeLists.txt b/examples/cmake_with_bazel_transitive/libb/src/CMakeLists.txt
@@ -21,4 +21,4 @@ set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)
 
 install(TARGETS libb_static ARCHIVE DESTINATION lib)
 
-install(FILES libb.h DESTINATION include)
+install(FILES libb.h DESTINATION include)
diff --git a/examples/cmake_with_bazel_transitive/libb/src/libb.cpp b/examples/cmake_with_bazel_transitive/libb/src/libb.cpp
@@ -2,4 +2,4 @@
 
 std::string hello_libb(void) {
   return hello_liba() + " Hello from LIBB!";
-}
+}
diff --git a/examples/cmake_with_bazel_transitive/libb/src/libb.h b/examples/cmake_with_bazel_transitive/libb/src/libb.h
@@ -7,4 +7,4 @@
 
 std::string hello_libb(void);
 
-#endif
+#endif
diff --git a/examples/cmake_with_bazel_transitive/test_libb.cpp b/examples/cmake_with_bazel_transitive/test_libb.cpp
@@ -11,4 +11,4 @@ int main(int argc, char* argv[])
     throw std::runtime_error("Wrong result: " + result);
   }
   std::cout << "Everything's fine!";
-}
+}
diff --git a/examples/cmake_working_dir/source_root/cmake_dir/CMakeLists.txt b/examples/cmake_working_dir/source_root/cmake_dir/CMakeLists.txt
@@ -30,4 +30,4 @@ target_include_directories(liba_static INTERFACE
 
 install(EXPORT liba_targets
   DESTINATION lib/cmake/liba
-  FILE liba-config.cmake)
+  FILE liba-config.cmake)
diff --git a/examples/cmake_working_dir/source_root/src/liba.h b/examples/cmake_working_dir/source_root/src/liba.h
diff --git a/examples/cmake_working_dir/test_liba.cpp b/examples/cmake_working_dir/test_liba.cpp
diff --git a/examples/configure_modify_input_source/simple_lib/Makefile.in b/examples/configure_modify_input_source/simple_lib/Makefile.in
diff --git a/examples/configure_modify_input_source/simple_lib/include/simple.h b/examples/configure_modify_input_source/simple_lib/include/simple.h
diff --git a/examples/configure_modify_input_source/simple_lib/src/simple.c b/examples/configure_modify_input_source/simple_lib/src/simple.c
diff --git a/examples/configure_with_bazel_transitive/builtWithBazel.c b/examples/configure_with_bazel_transitive/builtWithBazel.c
diff --git a/examples/configure_with_bazel_transitive/builtWithBazel.h b/examples/configure_with_bazel_transitive/builtWithBazel.h
diff --git a/examples/configure_with_bazel_transitive/simple_lib/Makefile.in b/examples/configure_with_bazel_transitive/simple_lib/Makefile.in
diff --git a/examples/configure_with_bazel_transitive/simple_lib/include/simple.h b/examples/configure_with_bazel_transitive/simple_lib/include/simple.h
diff --git a/examples/configure_with_bazel_transitive/simple_lib/src/simple.c b/examples/configure_with_bazel_transitive/simple_lib/src/simple.c
diff --git a/examples/configure_with_bazel_transitive/testSimple.c b/examples/configure_with_bazel_transitive/testSimple.c
diff --git a/examples/make_simple/code/Makefile b/examples/make_simple/code/Makefile
diff --git a/examples/ninja_simple/code/liba.cpp b/examples/ninja_simple/code/liba.cpp
diff --git a/examples/ninja_simple/code/liba.h b/examples/ninja_simple/code/liba.h
diff --git a/examples/third_party/.gitignore b/examples/third_party/.gitignore
diff --git a/examples/third_party/cares/c-ares-test.cpp b/examples/third_party/cares/c-ares-test.cpp
diff --git a/examples/third_party/libpng/libpng_usage_example.cpp b/examples/third_party/libpng/libpng_usage_example.cpp
diff --git a/examples/third_party/zlib/test_shared_zlib.sh b/examples/third_party/zlib/test_shared_zlib.sh
diff --git a/examples/third_party/zlib/test_zlib.sh b/examples/third_party/zlib/test_zlib.sh
diff --git a/examples/third_party/zlib/zlib-example.cpp b/examples/third_party/zlib/zlib-example.cpp
diff --git a/foreign_cc/private/runnable_binary_wrapper.sh b/foreign_cc/private/runnable_binary_wrapper.sh
diff --git a/test/dir1/include/header1.h b/test/dir1/include/header1.h
diff --git a/test/dir2/include/header2.h b/test/dir2/include/header2.h
diff --git a/toolchains/native_tools/native_tools_toolchain.bzl b/toolchains/native_tools/native_tools_toolchain.bzl

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ int main(int argc, char* argv[])`
`5`	`5`	`{`
`6`	`6`	`hello_func();`
`7`	`7`	`return 0;`
`8`		`-}`
	`8`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`build --crosstool_top=//tools/arm_compiler:toolchain --cpu=armeabi-v7a --spawn_strategy=standalone --experimental_cc_skylark_api_enabled_packages=@rules_foreign_cc//tools/build_defs,tools/build_defs,@foreign_cc_impl`
`2`		`-test --crosstool_top=//tools/arm_compiler:toolchain --cpu=armeabi-v7a --spawn_strategy=standalone --experimental_cc_skylark_api_enabled_packages=@rules_foreign_cc//tools/build_defs,tools/build_defs,@foreign_cc_impl`
	`2`	`+test --crosstool_top=//tools/arm_compiler:toolchain --cpu=armeabi-v7a --spawn_strategy=standalone --experimental_cc_skylark_api_enabled_packages=@rules_foreign_cc//tools/build_defs,tools/build_defs,@foreign_cc_impl`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ cmake_minimum_required(VERSION 2.8.4)`
`5`	`5`
`6`	`6`	`project(hellolib)`
`7`	`7`
`8`		`-add_subdirectory(src)`
	`8`	`+add_subdirectory(src)`