Add and apply pre-commit hooks (#6)

Adds our typical hooks so that style is standardized.

Authors:
  - Vyas Ramasubramani (https://github.com/vyasr)

Approvers:
  - Bradley Dice (https://github.com/bdice)

URL: #6

Author: vyasr

.clang-format

@@ -0,0 +1,167 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+# Refer to: https://releases.llvm.org/8.0.0/tools/clang/docs/ClangFormatStyleOptions.html
+---
+Language: Cpp
+# BasedOnStyle: Google
+AccessModifierOffset: -1
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: true
+AlignConsecutiveBitFields: true
+AlignConsecutiveDeclarations: false
+AlignConsecutiveMacros: true
+AlignEscapedNewlines: Left
+AlignOperands: true
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllConstructorInitializersOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: true
+AllowShortCaseLabelsOnASingleLine: true
+AllowShortEnumsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: true
+AllowShortLambdasOnASingleLine: true
+AllowShortLoopsOnASingleLine: false
+# This is deprecated
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments:  false
+BinPackParameters: false
+BraceWrapping:
+  AfterClass:            false
+  AfterControlStatement: false
+  AfterEnum:             false
+  AfterFunction:         false
+  AfterNamespace:        false
+  AfterObjCDeclaration:  false
+  AfterStruct:           false
+  AfterUnion:            false
+  AfterExternBlock:      false
+  BeforeCatch:           false
+  BeforeElse:            false
+  IndentBraces:          false
+  # disabling the below splits, else, they'll just add to the vertical length of source files!
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+  SplitEmptyNamespace: false
+BreakAfterJavaFieldAnnotations: false
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: WebKit
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakInheritanceList: BeforeColon
+BreakStringLiterals: true
+ColumnLimit: 100
+CommentPragmas: '(IWYU pragma:|SPDX-)'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+# Kept the below 2 to be the same as `IndentWidth` to keep everything uniform
+ConstructorInitializerIndentWidth: 2
+ContinuationIndentWidth: 2
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat: false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks: Regroup
+IncludeCategories:
+  - Regex:           '^"' # quoted includes
+    Priority:        1
+  - Regex:           '^<(thrust|cub|cuda)/' # CCCL includes
+    Priority:        2
+  - Regex:           '^<(cooperative_groups|cuco|cuda.h|cuda_runtime|device_types|math_constants|nvtx3)' # CUDA includes
+    Priority:        3
+  - Regex:           '^<.*\..*' # other system includes (e.g. with a '.')
+    Priority:        4
+  - Regex:           '^<[^.]+>' # STL includes (no '.')
+    Priority:        5
+IndentCaseLabels: true
+IndentPPDirectives: None
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Never
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PointerAlignment: Left
+QualifierAlignment: Right
+RawStringFormats:
+  - Language: Cpp
+    Delimiters:
+      - cc
+      - CC
+      - cpp
+      - Cpp
+      - CPP
+      - 'c++'
+      - 'C++'
+    CanonicalDelimiter: ''
+  - Language: TextProto
+    Delimiters:
+      - pb
+      - PB
+      - proto
+      - PROTO
+    EnclosingFunctions:
+      - EqualsProto
+      - EquivToProto
+      - PARSE_PARTIAL_TEXT_PROTO
+      - PARSE_TEST_PROTO
+      - PARSE_TEXT_PROTO
+      - ParseTextOrDie
+      - ParseTextProtoOrDie
+    CanonicalDelimiter: ''
+    BasedOnStyle: google
+# Enabling comment reflow causes doxygen comments to be messed up in their formats!
+ReflowComments: true
+SortIncludes: true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeSquareBrackets: false
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles: false
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard: c++20
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+# Be consistent with indent-width, even for people who use tab for indentation!
+TabWidth: 2
+UseTab: Never

.pre-commit-config.yaml

@@ -0,0 +1,70 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+ci:
+  autofix_commit_msg: "[pre-commit.ci] auto code formatting"
+  autofix_prs: false
+  autoupdate_branch: ""
+  autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
+  autoupdate_schedule: quarterly
+  skip: []
+  submodules: false
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v20.1.8
+    hooks:
+      - id: clang-format
+        types_or: [c, c++]
+        args: ["-fallback-style=none", "-style=file", "-i"]
+      - id: clang-format
+        name: clang-format (libcxx stubs)
+        files: '^libcxx/'
+        types: [file]
+        types_or: []
+        args: ["-fallback-style=none", "-style=file", "-i"]
+
+  - repo: https://github.com/sirosen/texthooks
+    rev: 0.7.1
+    hooks:
+      - id: fix-smartquotes
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.2
+    hooks:
+      - id: codespell
+        additional_dependencies: [tomli]
+        args: ["--toml", "pyproject.toml"]
+
+  - repo: https://github.com/rapidsai/pre-commit-hooks
+    rev: v1.5.1
+    hooks:
+      - id: verify-copyright
+        args: [--fix, --spdx]
+        files: '\.(cmake|cpp|hpp|sh)$'
+
+  - repo: https://github.com/zizmorcore/zizmor-pre-commit
+    rev: v1.25.2
+    hooks:
+      - id: zizmor
+
+  - repo: local
+    hooks:
+      - id: cmake-format
+        name: cmake-format
+        entry: ./ci/checks/run-cmake-format.sh cmake-format
+        language: python
+        types: [cmake]
+        additional_dependencies: [cmakelang==0.6.13]
+      - id: cmake-lint
+        name: cmake-lint
+        entry: ./ci/checks/run-cmake-format.sh cmake-lint
+        language: python
+        types: [cmake]
+        additional_dependencies: [cmakelang==0.6.13]

CMakeLists.txt

@@ -16,33 +16,24 @@ if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
   rapids_cpm_init()
 endif()
 
-project(
-  rtcx
-  VERSION 0.1.0
-  LANGUAGES CXX
-)
+project(rtcx VERSION 0.1.0 LANGUAGES CXX)
 
 option(RTCX_STATIC_LINK_NVRTC "Use static linking for NVRTC" OFF)
 option(RTCX_STATIC_LINK_NVJITLINK "Use static linking for nvJitLink" OFF)
 
-rapids_find_package(
-  CUDAToolkit REQUIRED
-  BUILD_EXPORT_SET rtcx-exports
-  INSTALL_EXPORT_SET rtcx-exports
-)
+rapids_find_package(CUDAToolkit REQUIRED BUILD_EXPORT_SET rtcx-exports
+                    INSTALL_EXPORT_SET rtcx-exports)
 
 if(NOT TARGET zstd)
   set(CPM_DOWNLOAD_zstd ON)
-  rapids_cpm_find(
-    zstd 1.5.7
-    GLOBAL_TARGETS zstd
-    CPM_ARGS
-    GIT_REPOSITORY https://github.com/facebook/zstd.git
-    GIT_TAG v1.5.7
-    GIT_SHALLOW FALSE SOURCE_SUBDIR build/cmake
-    OPTIONS "ZSTD_BUILD_STATIC ON" "ZSTD_BUILD_SHARED OFF" "ZSTD_BUILD_TESTS OFF"
-            "ZSTD_BUILD_PROGRAMS OFF" "BUILD_SHARED_LIBS OFF"
-  )
+  rapids_cpm_find(zstd 1.5.7
+                  GLOBAL_TARGETS zstd
+                  CPM_ARGS
+                  GIT_REPOSITORY https://github.com/facebook/zstd.git
+                  GIT_TAG v1.5.7
+                  GIT_SHALLOW FALSE SOURCE_SUBDIR build/cmake
+                  OPTIONS "ZSTD_BUILD_STATIC ON" "ZSTD_BUILD_SHARED OFF" "ZSTD_BUILD_TESTS OFF"
+                          "ZSTD_BUILD_PROGRAMS OFF" "BUILD_SHARED_LIBS OFF")
 
   if(zstd_ADDED)
     # disable weak symbols support to hide tracing APIs as well
@@ -63,20 +54,15 @@ endif()
 add_library(rtcx STATIC hash.cpp rtcx.cpp)
 add_library(rtcx::rtcx ALIAS rtcx)
 
-set_target_properties(
-  rtcx
-  PROPERTIES CXX_STANDARD 20
-             CXX_STANDARD_REQUIRED YES
-             CXX_VISIBILITY_PRESET hidden
-             VISIBILITY_INLINES_HIDDEN YES
-             POSITION_INDEPENDENT_CODE ON
-)
-
-target_include_directories(
-  rtcx
-  PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
-  PRIVATE ${CUDAToolkit_INCLUDE_DIRS}
-)
+set_target_properties(rtcx
+                      PROPERTIES CXX_STANDARD 20
+                                 CXX_STANDARD_REQUIRED YES
+                                 CXX_VISIBILITY_PRESET hidden
+                                 VISIBILITY_INLINES_HIDDEN YES
+                                 POSITION_INDEPENDENT_CODE ON)
+
+target_include_directories(rtcx PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+                           PRIVATE ${CUDAToolkit_INCLUDE_DIRS})
 
 target_link_libraries(rtcx PRIVATE zstd ${CMAKE_DL_LIBS} nvtx3::nvtx3-cpp)
 
@@ -112,56 +98,46 @@ include("${CMAKE_CURRENT_LIST_DIR}/embed.cmake")
 
 # Set rtcx_LIBCXX_DIR for consumers using embed_includes with libcxx headers.
 set(rtcx_LIBCXX_DIR "${PACKAGE_PREFIX_DIR}/share/rtcx/libcxx")
-]=]
-)
+]=])
 
-string(
-  CONFIGURE
-    [=[
+string(CONFIGURE [=[
 # Embed functions (add_embed, embed_includes, embed_blob, embed)
 # are included automatically so consumers don't need explicit include().
 include("@CMAKE_CURRENT_SOURCE_DIR@/embed.cmake")
 
 # Set rtcx_LIBCXX_DIR for consumers using embed_includes with libcxx headers.
 set(rtcx_LIBCXX_DIR "@CMAKE_CURRENT_SOURCE_DIR@/libcxx")
 ]=]
-    rtcx_build_code_string
-  @ONLY
-)
+                 rtcx_build_code_string
+       @ONLY)
 
 if(NOT RTCX_INSTALL)
   set(rtcx_exclude_from_install EXCLUDE_FROM_ALL)
 endif()
 
-install(
-  TARGETS rtcx
-  EXPORT rtcx-exports
-  ARCHIVE DESTINATION ${lib_dir}
-  INCLUDES
-  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
-  ${rtcx_exclude_from_install}
-)
+install(TARGETS rtcx
+        EXPORT rtcx-exports
+        ARCHIVE DESTINATION ${lib_dir}
+        INCLUDES
+        DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+        ${rtcx_exclude_from_install})
 
 if(RTCX_INSTALL)
   install(FILES rtcx.hpp hash.hpp embed.hpp DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/rtcx)
   install(FILES embed.cmake DESTINATION ${lib_dir}/cmake/rtcx)
   install(DIRECTORY embed/ DESTINATION ${lib_dir}/cmake/rtcx/embed)
   install(DIRECTORY libcxx/ DESTINATION ${CMAKE_INSTALL_DATADIR}/rtcx/libcxx)
 
-  rapids_export(
-    INSTALL rtcx
-    EXPORT_SET rtcx-exports
-    GLOBAL_TARGETS rtcx
-    NAMESPACE rtcx::
-    FINAL_CODE_BLOCK rtcx_install_code_string
-  )
+  rapids_export(INSTALL rtcx
+                EXPORT_SET rtcx-exports
+                GLOBAL_TARGETS rtcx
+                NAMESPACE rtcx::
+                FINAL_CODE_BLOCK rtcx_install_code_string)
 endif()
 
 # Build-tree export (always, so CPM consumers can find_package from the build tree)
-rapids_export(
-  BUILD rtcx
-  EXPORT_SET rtcx-exports
-  GLOBAL_TARGETS rtcx
-  NAMESPACE rtcx::
-  FINAL_CODE_BLOCK rtcx_build_code_string
-)
+rapids_export(BUILD rtcx
+              EXPORT_SET rtcx-exports
+              GLOBAL_TARGETS rtcx
+              NAMESPACE rtcx::
+              FINAL_CODE_BLOCK rtcx_build_code_string)