pre-commit: keep sorted lists in order (#9024)

Author: alexreinking

.clang-tidy

@@ -1,4 +1,5 @@
 ---
+# keep-sorted start skip_lines=10
 Checks: >
     *,
     -abseil-*,
@@ -159,6 +160,7 @@ Checks: >
     -readability-use-anyofallof,
     -readability-use-concise-preprocessor-directives,
     -readability-use-std-min-max,
+# keep-sorted end
 WarningsAsErrors: '*'
 HeaderFilterRegex: '.*'
 ExcludeHeaderFilterRegex: '\.fbs\.h|common/cmdline\.h|/mini_\w*\.h'

.pre-commit-config.yaml

@@ -67,6 +67,15 @@ repos:
     hooks:
       - id: gitleaks
 
+  - repo: https://github.com/google/keep-sorted
+    rev: v0.8.0
+    hooks:
+      - id: keep-sorted
+        args: [
+          --default-options,
+          "allow_yaml_lists=yes case=yes group=yes order=asc remove_duplicates=yes sticky_comments=no"
+        ]
+
   - repo: https://github.com/hukkin/mdformat
     rev: 1.0.0
     hooks:

Makefile

@@ -440,7 +440,7 @@ HEXAGON_RUNTIME_LIBS = \
   $(HEXAGON_RUNTIME_LIBS_DIR)/v65/libhalide_hexagon_remote_skel.so \
   $(HEXAGON_RUNTIME_LIBS_DIR)/v65/signed_by_debug/libhalide_hexagon_remote_skel.so
 
-# Keep this list sorted in alphabetical order.
+# keep-sorted start skip_lines=1 case=no
 SOURCE_FILES = \
   AbstractGenerator.cpp \
   AddAtomicMutex.cpp \
@@ -456,15 +456,15 @@ SOURCE_FILES = \
   AsyncProducers.cpp \
   AutoScheduleUtils.cpp \
   BoundaryConditions.cpp \
+  BoundConstantExtentLoops.cpp \
   Bounds.cpp \
   BoundsInference.cpp \
-  BoundConstantExtentLoops.cpp \
   BoundSmallAllocations.cpp \
   Buffer.cpp \
   Callable.cpp \
   CanonicalizeGPUVars.cpp \
-  Closure.cpp \
   ClampUnsafeAccesses.cpp \
+  Closure.cpp \
   CodeGen_ARM.cpp \
   CodeGen_C.cpp \
   CodeGen_D3D12Compute_Dev.cpp \
@@ -474,12 +474,12 @@ SOURCE_FILES = \
   CodeGen_LLVM.cpp \
   CodeGen_Metal_Dev.cpp \
   CodeGen_OpenCL_Dev.cpp \
-  CodeGen_Vulkan_Dev.cpp \
   CodeGen_Posix.cpp \
   CodeGen_PowerPC.cpp \
   CodeGen_PTX_Dev.cpp \
   CodeGen_PyTorch.cpp \
   CodeGen_RISCV.cpp \
+  CodeGen_Vulkan_Dev.cpp \
   CodeGen_WebAssembly.cpp \
   CodeGen_WebGPU_Dev.cpp \
   CodeGen_X86.cpp \
@@ -580,7 +580,6 @@ SOURCE_FILES = \
   Simplify_And.cpp \
   Simplify_Call.cpp \
   Simplify_Cast.cpp \
-  Simplify_Reinterpret.cpp \
   Simplify_Div.cpp \
   Simplify_EQ.cpp \
   Simplify_Exprs.cpp \
@@ -592,6 +591,7 @@ SOURCE_FILES = \
   Simplify_Mul.cpp \
   Simplify_Not.cpp \
   Simplify_Or.cpp \
+  Simplify_Reinterpret.cpp \
   Simplify_Select.cpp \
   Simplify_Shuffle.cpp \
   Simplify_Stmts.cpp \
@@ -626,6 +626,7 @@ SOURCE_FILES = \
   VectorizeLoops.cpp \
   WasmExecutor.cpp \
   WrapCalls.cpp
+# keep-sorted end
 
  C_TEMPLATE_FILES = \
    CodeGen_C_prologue \
@@ -639,7 +640,7 @@ HTML_TEMPLATE_FILES = \
 # The externally-visible header files that go into making Halide.h.
 # Don't include anything here that includes llvm headers.
 # Also *don't* include anything that's only used internally (eg SpirvIR.h).
-# Keep this list sorted in alphabetical order.
+# keep-sorted start skip_lines=1 case=no
 HEADER_FILES = \
   AbstractGenerator.h \
   AddAtomicMutex.h \
@@ -655,9 +656,9 @@ HEADER_FILES = \
   AsyncProducers.h \
   AutoScheduleUtils.h \
   BoundaryConditions.h \
+  BoundConstantExtentLoops.h \
   Bounds.h \
   BoundsInference.h \
-  BoundConstantExtentLoops.h \
   BoundSmallAllocations.h \
   Buffer.h \
   Callable.h \
@@ -671,17 +672,17 @@ HEADER_FILES = \
   CodeGen_LLVM.h \
   CodeGen_Metal_Dev.h \
   CodeGen_OpenCL_Dev.h \
-  CodeGen_Vulkan_Dev.h \
   CodeGen_Posix.h \
   CodeGen_PTX_Dev.h \
   CodeGen_PyTorch.h \
   CodeGen_Targets.h \
+  CodeGen_Vulkan_Dev.h \
   CodeGen_WebGPU_Dev.h \
   CompilerLogger.h \
   ConciseCasts.h \
-  CPlusPlusMangle.h \
   ConstantBounds.h \
   ConstantInterval.h \
+  CPlusPlusMangle.h \
   CSE.h \
   Debug.h \
   DebugArguments.h \
@@ -734,7 +735,6 @@ HEADER_FILES = \
   IROperator.h \
   IRPrinter.h \
   IRVisitor.h \
-  WasmExecutor.h \
   JITModule.h \
   Lambda.h \
   Lerp.h \
@@ -767,8 +767,8 @@ HEADER_FILES = \
   PythonExtensionGen.h \
   Qualify.h \
   Random.h \
-  Realization.h \
   RDom.h \
+  Realization.h \
   RealizationOrder.h \
   RebaseLoopsToZero.h \
   Reduction.h \
@@ -811,11 +811,14 @@ HEADER_FILES = \
   Util.h \
   Var.h \
   VectorizeLoops.h \
+  WasmExecutor.h \
   WrapCalls.h
+# keep-sorted end
 
 OBJECTS = $(SOURCE_FILES:%.cpp=$(BUILD_DIR)/%.o)
 HEADERS = $(HEADER_FILES:%.h=$(SRC_DIR)/%.h)
 
+# keep-sorted start skip_lines=1
 RUNTIME_CPP_COMPONENTS = \
   aarch64_cpu_features \
   alignment_128 \
@@ -895,6 +898,7 @@ RUNTIME_CPP_COMPONENTS = \
   to_string \
   trace_helper \
   tracing \
+  vulkan \
   wasm_cpu_features \
   webgpu_dawn \
   webgpu_emscripten \
@@ -912,9 +916,10 @@ RUNTIME_CPP_COMPONENTS = \
   windows_vulkan \
   windows_yield \
   write_debug_image \
-  vulkan \
   x86_cpu_features \
+# keep-sorted end
 
+# keep-sorted start skip_lines=1
 RUNTIME_LL_COMPONENTS = \
   aarch64 \
   arm \
@@ -931,6 +936,7 @@ RUNTIME_LL_COMPONENTS = \
   x86_avx2 \
   x86_avx512 \
   x86_sse41
+# keep-sorted end
 
 RUNTIME_EXPORTED_INCLUDES = $(INCLUDE_DIR)/HalideRuntime.h \
                             $(INCLUDE_DIR)/HalideRuntimeD3D12Compute.h \

apps/CMakeLists.txt

@@ -28,10 +28,7 @@ if (Halide_TARGET MATCHES "wasm")
     return()
 endif()
 
-# add_app(HelloAndroid)  # TODO(#5374): missing CMake build
-# add_app(HelloAndroidCamera2)  # TODO(#5374): missing CMake build
-# add_app(HelloPyTorch)  # TODO(#5374): missing CMake build
-# add_app(HelloiOS)  # TODO(#5374): missing CMake build
+# keep-sorted start case=no ignore_prefixes=#
 # add_app(auto_viz)  # TODO(#5374): missing CMake build
 add_app(bgu)
 add_app(bilateral_grid)
@@ -45,6 +42,11 @@ add_app(depthwise_separable_conv)
 add_app(fft)
 add_app(hannk)
 add_app(harris)
+# add_app(HelloAndroid)  # TODO(#5374): missing CMake build
+# add_app(HelloAndroidCamera2)  # TODO(#5374): missing CMake build
+add_app(HelloBaremetal)
+# add_app(HelloiOS)  # TODO(#5374): missing CMake build
+# add_app(HelloPyTorch)  # TODO(#5374): missing CMake build
 add_app(hexagon_benchmarks)
 # add_app(hexagon_dma)  # TODO(#5374): missing CMake build
 add_app(hist)
@@ -64,4 +66,4 @@ add_app(resize)
 add_app(stencil_chain)
 add_app(unsharp)
 add_app(wavelet)
-add_app(HelloBaremetal)
+# keep-sorted end

apps/hannk/CMakeLists.txt

@@ -117,6 +117,7 @@ endif ()
 # Tests
 
 set(TEST_FILES
+    # keep-sorted start
     inception_v2_224_quant/000.DEPTHWISE_CONV_2D.tflite
     inception_v4_299_quant/000.CONV_2D.tflite
     inception_v4_299_quant/001.CONV_2D.tflite
@@ -235,6 +236,7 @@ set(TEST_FILES
     mobilenet_v2_1.0_224_quant/059.DEPTHWISE_CONV_2D.tflite
     mobilenet_v2_1.0_224_quant/062.AVERAGE_POOL_2D.tflite
     mobilenet_v2_1.0_224_quant/064.RESHAPE.tflite
+    # keep-sorted end
 )
 list(TRANSFORM TEST_FILES PREPEND "${CMAKE_CURRENT_SOURCE_DIR}/test/")
 

apps/hannk/interpreter/ops.cpp

@@ -1887,6 +1887,7 @@ void UpsampleChannelsOp::execute() {
         };                                                          \
     }
 
+// keep-sorted start
 ACCEPT_AND_MUTATE_IMPL(BinaryOp)
 ACCEPT_AND_MUTATE_IMPL(ConcatenationOp)
 ACCEPT_AND_MUTATE_IMPL(ConvOp)
@@ -1896,16 +1897,17 @@ ACCEPT_AND_MUTATE_IMPL(GatherOp)
 ACCEPT_AND_MUTATE_IMPL(L2NormalizationOp)
 ACCEPT_AND_MUTATE_IMPL(PadOp)
 ACCEPT_AND_MUTATE_IMPL(Pool2DOp)
+ACCEPT_AND_MUTATE_IMPL(ReductionOp)
+ACCEPT_AND_MUTATE_IMPL(ReshapeOp)
 ACCEPT_AND_MUTATE_IMPL(ShapeOp)
 ACCEPT_AND_MUTATE_IMPL(SoftmaxOp)
 ACCEPT_AND_MUTATE_IMPL(SpaceDepthOp)
 ACCEPT_AND_MUTATE_IMPL(SplitOp)
-ACCEPT_AND_MUTATE_IMPL(ReductionOp)
-ACCEPT_AND_MUTATE_IMPL(ReshapeOp)
 ACCEPT_AND_MUTATE_IMPL(TileConvFilterOp)
 ACCEPT_AND_MUTATE_IMPL(TransposeOp)
-ACCEPT_AND_MUTATE_IMPL(UpsampleChannelsOp)
 ACCEPT_AND_MUTATE_IMPL(UnaryOp)
+ACCEPT_AND_MUTATE_IMPL(UpsampleChannelsOp)
+// keep-sorted end
 
 ACCEPT_AND_MUTATE_IMPL(OpGroup)
 

cmake/HalideGeneratorHelpers.cmake

@@ -174,6 +174,7 @@ function(_Halide_library_from_generator TARGET)
 
     ## "hash table" of extra outputs to extensions
     # Keep in sync with Module.cpp
+    # keep-sorted start ignore_prefixes=#
     set(assembly_extension ".s")
     set(bitcode_extension ".bc")
     # set(c_header_extension ".h")  # handled specially
@@ -195,6 +196,7 @@ function(_Halide_library_from_generator TARGET)
     # set(static_library_extension (is_windows_coff ? ".lib" : ".a"))  # handled specially
     set(stmt_extension ".stmt")
     set(stmt_html_extension ".stmt.html")
+    # keep-sorted end
 
     ## Validate TYPE
     if (NOT ARG_TYPE MATCHES "^(c_source|static_library|object)$")
@@ -452,6 +454,7 @@ function(add_halide_library TARGET)
     # - `object` is selected for CMake-target-compile
     # - `static_library` is selected for cross-compile
     set(extra_output_names
+        # keep-sorted start
         ASSEMBLY
         BITCODE
         COMPILER_LOG
@@ -469,6 +472,7 @@ function(add_halide_library TARGET)
         SCHEDULE
         STMT
         STMT_HTML
+        # keep-sorted end
     )
 
     ##

doc/CodeStyleCMake.md

@@ -197,9 +197,9 @@ that every `.c` and `.cpp` appears in the `CMakeLists.txt` file _on its own
 line_, possibly as a comment. This is to avoid globbing and also to ensure that
 added files are not missed.
 
-For most test types, it should be as simple as adding to the existing lists,
-which must remain in alphabetical order. Generator tests are trickier, but
-following the existing examples is a safe way to go.
+For most test types, it should be as simple as adding to the existing lists.
+Generator tests are trickier, but following the existing examples is a safe way
+to go.
 
 # Adding apps
 

python_bindings/test/correctness/CMakeLists.txt

@@ -7,6 +7,7 @@ add_library(the_sort_function MODULE the_sort_function.c)
 target_link_libraries(the_sort_function PRIVATE Halide::Runtime)
 
 set(tests
+    # keep-sorted start
     addconstant_test.py
     atomics.py
     autodiff.py
@@ -32,6 +33,7 @@ set(tests
     type.py
     user_context_test.py
     var.py
+    # keep-sorted end
     )
 
 set(PY_GENERATORS "${CMAKE_CURRENT_SOURCE_DIR}/../generators")

python_bindings/tutorial/CMakeLists.txt

@@ -4,6 +4,7 @@ if (Halide_TARGET MATCHES "webgpu")
 endif ()
 
 set(tests
+    # keep-sorted start
     lesson_01_basics.py
     lesson_02_input_image.py
     lesson_03_debugging_1.py
@@ -19,6 +20,7 @@ set(tests
     lesson_12_using_the_gpu.py
     lesson_13_tuples.py
     lesson_14_types.py
+    # keep-sorted end
 )
 
 set(PYPATH_lesson_10_aot_compilation_run "$<TARGET_FILE_DIR:lesson_10_halide>")