pre-commit improvements (#112)

* improve pre-commit setup

* automatic changes

* manual fixes

* Update tests to work with newly cleaned up code

* updated tests to expect new calls (w/o redundant default arguments passed in)
* made pydantic happy by explicitly defaulting an int | None arg to None
* Mocking for instruction in assembler tests is now done with `spec` instead of overwriting `isinstance`

* Update graph.h

* revert use of union type in isinstance

* insert-license: warn if fuzzy match found

* remove duplicate license headers

* allow prior years in license headers

* remove redundant pytest.ini files

---------

Co-authored-by: Alexander Viand <alexander.viand@intel.com>
Co-authored-by: Jose Rojas Chaves <jose.rojas.chaves@intel.com>

Author: 3 people

.clang-format

@@ -1,5 +1,4 @@
 ---
----
 Language:        Cpp
 BasedOnStyle:  Microsoft
 AccessModifierOffset: -4

.github/workflows/format.yml

@@ -13,24 +13,12 @@ jobs:
     runs-on: ubuntu-24.04
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
           python-version: '3.10'
 
-      - name: Install Development Dependencies
-        run: pip install -r requirements-dev.txt
-
-      - name: Installing Component-specific Dependencies
-        run: pip install -r assembler_tools/hec-assembler-tools/requirements.txt
-
-      - name: Install Apt Dependencies
-        run: sudo apt install -y clang-format-14
-
-      - name: Fetch main branch for diff
-        run: git fetch origin main
-
-      - name: Run pre-commit on changed files only
-        run: pre-commit run --from-ref origin/main --to-ref HEAD
+      - name: Run pre-commit
+        uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 default_language_version:
-    # force all unspecified python hooks to run python3
+    # force all unspecified python hooks to run python3.10
     python: python3.10
 repos:
     - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -15,6 +15,7 @@ repos:
         - id: check-yaml
           args:
           - --allow-multiple-documents
+        - id: fix-byte-order-marker
     - repo: https://github.com/crate-ci/typos
       rev: v1.33.1 # Updated 2025/06
       hooks:
@@ -28,75 +29,45 @@ repos:
           name: insert-license-shell
           files: \.(sh|py)$
           args:
-          - --license-filepath
-          # defaults to: LICENSE.txt
-          - HEADER
+          - --license-filepath=HEADER
+          - --use-current-year
+          - --allow-past-years
+          - --detect-license-in-X-top-lines=10
+          - --fuzzy-ratio-cut-off=50
+          - --remove-header
         - id: insert-license
           name: insert-license-cpp
           files: \.(c|cc|cxx|cpp|h|hpp|hxx|inl|h.in)$
           args:
-          - --license-filepath
-          # defaults to: LICENSE.txt
-          - HEADER
-          - --comment-style
-          - //                   # defaults to: #
+          - --license-filepath=HEADER
+          - --comment-style=//
+          - --use-current-year
+          - --allow-past-years
+          - --detect-license-in-X-top-lines=10
+          - --fuzzy-ratio-cut-off=50
+          - --remove-header
         - id: remove-tabs
           name: remove-tabs
           files: \.(py)$
           args: [--whitespaces-count, '4']
-    - repo: https://github.com/psf/black-pre-commit-mirror
-      rev: 25.1.0 # Updated 2025/06
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.8.4
       hooks:
-        - id: black
-          language_version: python3.10
+        - id: ruff
+          args: [--fix]  # Automatically fix issues when possible
+        - id: ruff-format  # Replaces black
     - repo: https://github.com/pre-commit/mirrors-mypy
       rev: v1.16.0 # Last checked 2025/06
       hooks:
         - id: mypy
-          language: system
-          exclude: >-
-            ^(assembler_tools/hec-assembler-tools/assembler/common/run_config\.py|
-            *assembler_tools/hec-assembler-tools/assembler/instructions/|
-            *assembler_tools/hec-assembler-tools/assembler/memory_model/|
-            *assembler_tools/hec-assembler-tools/assembler/stages/asm_scheduler\.py|
-            *assembler_tools/hec-assembler-tools/assembler/stages/scheduler\.py|
-            *assembler_tools/hec-assembler-tools/debug_tools/main\.py|
-            *assembler_tools/hec-assembler-tools/debug_tools/xinst_timing_check/|
-            *assembler_tools/hec-assembler-tools/he_as\.py|
-            *assembler_tools/hec-assembler-tools/assembler/spec_config/isa_spec.py)
-          args: ["--follow-imports=skip", "--install-types", "--non-interactive"]
-    - repo: local
+          pass_filenames: false
+    -   repo: https://github.com/pre-commit/mirrors-clang-format
+        rev: "v18.1.2"
+        hooks:
+        -   id: clang-format
+            exclude_types: [json]   # skip *.json and *.JSON
+            args: ["--style=file"]
+    - repo: https://github.com/cpplint/cpplint
+      rev: "2.0.2"
       hooks:
-        - id: pylint
-          name: pylint
-          entry: pylint
-          language: system
-          types: [python]
-          exclude: >-
-            ^(assembler_tools/hec-assembler-tools/assembler/common/run_config\.py|
-            *assembler_tools/hec-assembler-tools/assembler/instructions/|
-            *assembler_tools/hec-assembler-tools/assembler/memory_model/|
-            *assembler_tools/hec-assembler-tools/assembler/stages/asm_scheduler\.py|
-            *assembler_tools/hec-assembler-tools/assembler/stages/scheduler\.py|
-            *assembler_tools/hec-assembler-tools/debug_tools/main\.py|
-            *assembler_tools/hec-assembler-tools/debug_tools/xinst_timing_check/|
-            *assembler_tools/hec-assembler-tools/he_as\.py|
-            *assembler_tools/hec-assembler-tools/assembler/spec_config/isa_spec.py)
-          args:
-          - -rn # Only display messages
-          - -sn # Don't display the score
-          - --source-roots=p-isa_tools/kerngen,assembler_tools/hec-assembler-tools
-        - id: clang-format-14
-          name: clang-format-14
-          entry: clang-format-14
-          language: system
-          files: \.(c|cc|cxx|cpp|h|hpp|hxx|inl)$
-          args: ["-i", "--style=file"]
         - id: cpplint
-          name: cpplint
-          entry: cpplint
-          language: system
-          files: \.(c|cc|cxx|cpp|h|hpp|hxx)$
-          args:
-          - --recursive
-          - --filter=-build/c++17

.pylintrc

@@ -8,3 +8,8 @@
 # variation of params
 parms = "parms"
 bload = "bload"
+
+[files]
+extend-exclude = [
+    "requirements-dev.txt",
+]

.typos.toml

@@ -1,2 +1,2 @@
-Copyright (C) 2025 Intel Corporation
+Copyright (C) {year} Intel Corporation
 SPDX-License-Identifier: Apache-2.0

HEADER

@@ -1,5 +1,9 @@
+# Copyright (C) 2025 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
 import os
 
+
 def makeUniquePath(path: str) -> str:
     """
     Returns a unique, normalized, and absolute version of the given file path.