Add additional linters

nateinaction · nateinaction · commit 587efdf22934 · 2025-08-24T17:28:26.000-05:00
diff --git a/.clang-format b/.clang-format
@@ -2,4 +2,4 @@
 BasedOnStyle: Chromium
 IndentWidth: 4
 ColumnLimit: 120
-AccessModifierOffset: -2
+AccessModifierOffset: -2
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -7,18 +7,24 @@ on:
       - main
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Lint
+        run: |
+          make fmt
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - name: Build
         run: |
-          make
+          make build
       - name: Archive
         uses: actions/upload-artifact@v4
         with:
           name: artifacts
           path: |
             build-artifacts/zephyr.uf2
             build-artifacts/zephyr/fprime-zephyr-deployment/dict/ReferenceDeploymentTopologyDictionary.json
-
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,4 +1,18 @@
 repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-json
+    - id: check-added-large-files
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.4.1
+  hooks:
+    - id: codespell
+
 - repo: https://github.com/pre-commit/mirrors-clang-format
   rev: v20.1.8
   hooks:
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -11,8 +11,8 @@ endif()
 find_package(Zephyr HINTS "${CMAKE_CURRENT_LIST_DIR}/lib/zephyr-workspace")
 project(fprime-zephyr-reference C CXX)
 
-# Put in an option to force the device back into programable state for automated testing
-option(FPRIME_CI_FAILSAFE_ENABLED "Cycle count before a forced reset to programable state" OFF)
+# Put in an option to force the device back into programmable state for automated testing
+option(FPRIME_CI_FAILSAFE_ENABLED "Cycle count before a forced reset to programmable state" OFF)
 if (FPRIME_CI_FAILSAFE_ENABLED)
     set(FPRIME_CI_FAILSAFE_CYCLE_COUNT 6000 CACHE STRING "Cycles before a forced reset")
     add_compile_definitions(FPRIME_CI_FAILSAFE_CYCLE_COUNT=${FPRIME_CI_FAILSAFE_CYCLE_COUNT})
diff --git a/CMakePresets.json b/CMakePresets.json
@@ -1,22 +1,22 @@
 {
-    "version": 4,
     "configurePresets": [
         {
-            "name": "fprime-zephyr-teensy41",
-            "displayName": "F´ Zephyr (teensy41)",
-            "description": "F´ release build using local fprime-venv",
             "binaryDir": "${sourceDir}/build-fprime-automatic-zephyr",
-            "environment": {
-                "VIRTUAL_ENV": "${fileDir}/fprime-venv",
-                "PATH": "$env{VIRTUAL_ENV}/bin:$penv{PATH}"
-            },
             "cacheVariables": {
-                "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
+                "BOARD": "teensy41",
                 "CMAKE_BUILD_TYPE": "Release",
-                "BOARD": "teensy41"
+                "CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
             },
-            "toolchainFile": "${fileDir}/lib/fprime-zephyr/cmake/toolchain/zephyr.cmake",
-            "generator": "Ninja"
+            "description": "F\u00b4 release build using local fprime-venv",
+            "displayName": "F\u00b4 Zephyr (teensy41)",
+            "environment": {
+                "PATH": "$env{VIRTUAL_ENV}/bin:$penv{PATH}",
+                "VIRTUAL_ENV": "${fileDir}/fprime-venv"
+            },
+            "generator": "Ninja",
+            "name": "fprime-zephyr-teensy41",
+            "toolchainFile": "${fileDir}/lib/fprime-zephyr/cmake/toolchain/zephyr.cmake"
         }
-    ]
+    ],
+    "version": 4
 }
diff --git a/FprimeZephyrReference/Components/Led/CMakeLists.txt b/FprimeZephyrReference/Components/Led/CMakeLists.txt
@@ -22,4 +22,3 @@ register_fprime_library(
 #   DEPENDS
 #       MyPackage_MyOtherModule
 )
-
diff --git a/FprimeZephyrReference/Components/Led/Led.cpp b/FprimeZephyrReference/Components/Led/Led.cpp
@@ -84,4 +84,4 @@ void Led ::SET_BLINK_INTERVAL_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, U32 in
     this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
 }
 
-}  // namespace Components
+}  // namespace Components
diff --git a/FprimeZephyrReference/Components/Led/Led.fpp b/FprimeZephyrReference/Components/Led/Led.fpp
@@ -64,4 +64,4 @@ module Components {
         telemetry port tlmOut
 
     }
-}
+}
diff --git a/FprimeZephyrReference/Components/Led/Led.hpp b/FprimeZephyrReference/Components/Led/Led.hpp
@@ -68,4 +68,4 @@ class Led : public LedComponentBase {
 
 }  // namespace Components
 
-#endif
+#endif
diff --git a/FprimeZephyrReference/ReferenceDeployment/CMakeLists.txt b/FprimeZephyrReference/ReferenceDeployment/CMakeLists.txt
@@ -1,8 +1,8 @@
 #####
 # 'ReferenceDeployment' Deployment:
 #
-# This registers the 'ReferenceDeployment' deployment to the build system. 
-# Custom components that have not been added at the project-level should be added to 
+# This registers the 'ReferenceDeployment' deployment to the build system.
+# Custom components that have not been added at the project-level should be added to
 # the list below.
 #
 #####
diff --git a/FprimeZephyrReference/ReferenceDeployment/README.md b/FprimeZephyrReference/ReferenceDeployment/README.md
@@ -31,7 +31,7 @@ fprime-gds
 
 - **CdhCore**: Command & Data Handling
   - Command dispatching and event management
-  - Event logging and telemetry collection  
+  - Event logging and telemetry collection
   - Health monitoring system
   - Fatal error handling
 
@@ -48,4 +48,4 @@ fprime-gds
 - **DataProducts**: Data Product Management
   - Data product cataloging
   - Storage and retrieval capabilities
-  - Product metadata management
+  - Product metadata management
diff --git a/FprimeZephyrReference/ReferenceDeployment/Top/instances.fpp b/FprimeZephyrReference/ReferenceDeployment/Top/instances.fpp
@@ -35,7 +35,7 @@ module ReferenceDeployment {
     queue size Default.QUEUE_SIZE \
     stack size Default.STACK_SIZE \
     priority 4
-  
+
   instance led: Components.Led base id 0x10003000 \
     queue size Default.QUEUE_SIZE \
     stack size Default.STACK_SIZE \
diff --git a/FprimeZephyrReference/ReferenceDeployment/Top/topology.fpp b/FprimeZephyrReference/ReferenceDeployment/Top/topology.fpp
@@ -16,7 +16,7 @@ module ReferenceDeployment {
   # ----------------------------------------------------------------------
     import CdhCore.Subtopology
     import ComCcsds.Subtopology
-    
+
   # ----------------------------------------------------------------------
   # Instances used in the topology
   # ----------------------------------------------------------------------
@@ -58,18 +58,18 @@ module ReferenceDeployment {
       # Router to Command Dispatcher
       ComCcsds.fprimeRouter.commandOut -> CdhCore.cmdDisp.seqCmdBuff
       CdhCore.cmdDisp.seqCmdStatus -> ComCcsds.fprimeRouter.cmdResponseIn
-      
+
     }
 
     connections Communications {
       # ComDriver buffer allocations
       comDriver.allocate      -> ComCcsds.commsBufferManager.bufferGetCallee
       comDriver.deallocate    -> ComCcsds.commsBufferManager.bufferSendIn
-      
+
       # ComDriver <-> ComStub (Uplink)
       comDriver.$recv                     -> ComCcsds.comStub.drvReceiveIn
       ComCcsds.comStub.drvReceiveReturnOut -> comDriver.recvReturnIn
-      
+
       # ComStub <-> ComDriver (Downlink)
       ComCcsds.comStub.drvSendOut      -> comDriver.$send
       comDriver.ready         -> ComCcsds.comStub.drvConnected
@@ -92,7 +92,7 @@ module ReferenceDeployment {
     }
 
     connections LedBlinker {
-      # Rate Group 1 (1Hz cycle) ouput is connected to led's run input
+      # Rate Group 1 (1Hz cycle) output is connected to led's run input
       rateGroup1Hz.RateGroupMemberOut[4] -> led.run
       # led's gpioSet output is connected to gpioDriver's gpioWrite input
       led.gpioSet -> gpioDriver.gpioWrite
diff --git a/FprimeZephyrReference/project/config/CdhCoreConfig.fpp b/FprimeZephyrReference/project/config/CdhCoreConfig.fpp
@@ -1,14 +1,14 @@
 module CdhCoreConfig {
     #Base ID for the CdhCore Subtopology, all components are offsets from this base ID
     constant BASE_ID = 0x01000000
-    
+
     module QueueSizes {
         constant cmdDisp     = 10
         constant events      = 25
         constant tlmSend     = 5
         constant $health     = 10
     }
-    
+
 
     module StackSizes {
         constant cmdDisp     = 8 * 1024 # Must match prj.conf thread stack size
diff --git a/FprimeZephyrReference/project/config/CdhCoreTlmConfig.fpp b/FprimeZephyrReference/project/config/CdhCoreTlmConfig.fpp
@@ -10,8 +10,8 @@ module CdhCore{
        # This name will need to be updated if wishing to use this in a custom deployment
        phase Fpp.ToCpp.Phases.configComponents """
        CdhCore::tlmSend.setPacketList(
-           ReferenceDeployment::ReferenceDeployment_ReferenceDeploymentPacketsTlmPackets::packetList, 
-           ReferenceDeployment::ReferenceDeployment_ReferenceDeploymentPacketsTlmPackets::omittedChannels, 
+           ReferenceDeployment::ReferenceDeployment_ReferenceDeploymentPacketsTlmPackets::packetList,
+           ReferenceDeployment::ReferenceDeployment_ReferenceDeploymentPacketsTlmPackets::omittedChannels,
            1
        );
        """
diff --git a/FprimeZephyrReference/project/config/ComCcsdsConfig.fpp b/FprimeZephyrReference/project/config/ComCcsdsConfig.fpp
@@ -1,11 +1,11 @@
 module ComCcsdsConfig {
     #Base ID for the ComCcsds Subtopology, all components are offsets from this base ID
     constant BASE_ID = 0x02000000
-    
+
     module QueueSizes {
         constant comQueue    = 10
     }
-    
+
     module StackSizes {
         constant comQueue   = 8 * 1024 # Must match prj.conf thread stack size
     }
@@ -16,15 +16,15 @@ module ComCcsdsConfig {
 
     # Queue configuration constants
     module QueueDepths {
-        constant events      = 20             
-        constant tlm         = 20           
-        constant file        = 1            
+        constant events      = 20
+        constant tlm         = 20
+        constant file        = 1
     }
 
     module QueuePriorities {
-        constant events      = 0                 
-        constant tlm         = 2                 
-        constant file        = 1                   
+        constant events      = 0
+        constant tlm         = 2
+        constant file        = 1
     }
 
     # Buffer management constants
diff --git a/Kconfig b/Kconfig
@@ -22,4 +22,4 @@ config FPRIME
 config APP_WIPE_STORAGE
 	bool "Option to clear the flash area before mounting"
 	help
-	  Use this to force an existing file system to be created.
+	  Use this to force an existing file system to be created.
diff --git a/Makefile b/Makefile
@@ -11,7 +11,7 @@ help: ## Display this help.
 submodules: ## Initialize and update git submodules
 	@echo "Initializing and updating git submodules..."
 	git submodule update --init --recursive
-	
+
 export VIRTUAL_ENV ?= $(shell pwd)/fprime-venv
 fprime-venv: uv ## Create a virtual environment
 	@test -s $(VIRTUAL_ENV) || { \
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Proves Core Reference Project
 
-This is a reference software implementation for the [Proves Kit](https://docs.proveskit.space/en/latest/). 
+This is a reference software implementation for the [Proves Kit](https://docs.proveskit.space/en/latest/).
 
 ## System Requirements
 - F Prime System Requirements listed [here](https://fprime.jpl.nasa.gov/latest/docs/getting-started/installing-fprime/#system-requirements)
@@ -28,7 +28,7 @@ Run generate from the `proves-core-reference` directory. This generates the buil
 make generate
 ```
 
-Then, and everytime you change code, run
+Then, and every time you change code, run
 
 ```shell
 make build
@@ -63,7 +63,7 @@ Now you want to install the firmware to the board.
 make install BOARD_DIR=[path-to-your-board]
 ```
 
-Finally, run the fprime-gds.  
+Finally, run the fprime-gds.
 ```shell
 make gds
 ```
diff --git a/docs/additional-resources/board-list.md b/docs/additional-resources/board-list.md
@@ -8,11 +8,11 @@ The following boards were able to successfully deploy this reference deployment.
 | Board Name        | Chip              | Toolchain     | Date Tested   | Board Config  | Upload Guide          | Notes                        |
 | ----------------- | ----------------- | ------------- | ------------- | ------------- | --------------------- | ---------------------------- |
 | teensy41          | ARM Cortex-M7     | teensy41      | 08/01/2025    | supported     | [README][teensy]      |                              |
-| NUCLEO-H723ZG     | ARM Cortex-M7     | nucleo_h723zg | 08/01/2025    | supported     | [README][stm32]       | Requires two USB Connecitons |
+| NUCLEO-H723ZG     | ARM Cortex-M7     | nucleo_h723zg | 08/01/2025    | supported     | [README][stm32]       | Requires two USB Connections |
 
 
 
 
 <!-- Links -->
 [stm32]: ../uploading/stm32/stm32.md
-[teensy]: ../uploading/teensy.md
+[teensy]: ../uploading/teensy.md
diff --git a/docs/additional-resources/specifying-board-configuration.md b/docs/additional-resources/specifying-board-configuration.md
@@ -1,5 +1,5 @@
 # Specifying Zephyr Board Configuration
-This reference deployent can be used for any board running zephyr so long as the correct zephyr board configuration is provided. 
+This reference deployent can be used for any board running zephyr so long as the correct zephyr board configuration is provided.
 
 ## Update the Zephyr West Configuration File
 
@@ -25,7 +25,7 @@ More information on West Configuration files can be found [here](https://docs.ze
 ## Using Custom Board Configurations
 
 <!-- Commented out for now. Not sure if this will confuse users -->
-<!-- Using a custom board configuration may require updating the CMakeLists.txt file depending on where the board folder is loacted. This example appends the board root of a board that in another directory/repository.
+<!-- Using a custom board configuration may require updating the CMakeLists.txt file depending on where the board folder is located. This example appends the board root of a board that in another directory/repository.
 
 ```cmake
 list(APPEND BOARD_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/lib/fprime-stm32h7-zephyr")
@@ -47,7 +47,7 @@ BOARD=teensy41 # Example for the Teensy 4.1 (existing zephyr support)
 A list of supported boards can be found [here](https://docs.zephyrproject.org/latest/boards/index.html#).
 
 ## Update prf.conf
-Different boards may have different USB PID and VID configurations. Update the following atrributes to your board's PID and VID configurations.
+Different boards may have different USB PID and VID configurations. Update the following attributes to your board's PID and VID configurations.
 
 ```ini
 # In fprime-zephyr-reference/prj.conf
@@ -59,4 +59,4 @@ CONFIG_USB_DEVICE_PID=<PID>
 
 <!-- Links -->
 [initial-setup]: ../main-content/initial-setup.md
-[custom-board-config]: https://docs.zephyrproject.org/latest/hardware/porting/board_porting.html
+[custom-board-config]: https://docs.zephyrproject.org/latest/hardware/porting/board_porting.html
diff --git a/docs/additional-resources/troubleshooting.md b/docs/additional-resources/troubleshooting.md
@@ -17,4 +17,4 @@ WSL does not natively install USB drivers. Refer to the guide [here][wsl-notes]
 
 
 <!-- Links -->
-[wsl-notes]: ./wsl-notes.md
+[wsl-notes]: ./wsl-notes.md
diff --git a/docs/additional-resources/wsl-notes.md b/docs/additional-resources/wsl-notes.md
@@ -1,10 +1,10 @@
 # WSL (Windows 11) Notes
 WSL natively does not have access to USB devices. To flash the board properly and allow the GDS to communicate with the deployment board via UART over USB, follow these one-time steps.
 
-1. On Powershell as administrator, install and run **usbipd-win**: 
-Run Powershell as administrator 
+1. On Powershell as administrator, install and run **usbipd-win**:
+Run Powershell as administrator
 ```sh
-winget install dorssel.usbipd-win 
+winget install dorssel.usbipd-win
 ```
 
 2. On Powershell find your USB device:
@@ -14,7 +14,7 @@ usbipd list
 > [!Note]
 > You should see two STM32 devices listed with different BUSID's. One corresponds to the USB PWR and the other to USER USB.
 
-3. On Powershell bind both devices to USBIPD in two seperate commands (as administrator):
+3. On Powershell bind both devices to USBIPD in two separate commands (as administrator):
 ```sh
 usbipd bind --busid <BUSID_USB_PWR> --wsl
 ```
diff --git a/docs/main-content/build-flash-run.md b/docs/main-content/build-flash-run.md
diff --git a/docs/main-content/initial-setup.md b/docs/main-content/initial-setup.md
diff --git a/docs/uploading/stm32/Arduino-STM32CubeProgrammer-Arm-Issue.md b/docs/uploading/stm32/Arduino-STM32CubeProgrammer-Arm-Issue.md
diff --git a/docs/uploading/stm32/stm32.md b/docs/uploading/stm32/stm32.md
diff --git a/docs/uploading/teensy.md b/docs/uploading/teensy.md
diff --git a/fprime-gds.yaml b/fprime-gds.yaml
diff --git a/prj.conf b/prj.conf

Original file line number	Diff line number	Diff line change
`@@ -22,4 +22,3 @@ register_fprime_library(`
`22`	`22`	`# DEPENDS`
`23`	`23`	`# MyPackage_MyOtherModule`
`24`	`24`	`)`
`25`		`-`
Original file line number	Diff line number	Diff line change
`@@ -84,4 +84,4 @@ void Led ::SET_BLINK_INTERVAL_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, U32 in`
`84`	`84`	`this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);`
`85`	`85`	`}`
`86`	`86`
`87`		`-} // namespace Components`
	`87`	`+} // namespace Components`
Original file line number	Diff line number	Diff line change
`@@ -64,4 +64,4 @@ module Components {`
`64`	`64`	`telemetry port tlmOut`
`65`	`65`
`66`	`66`	`}`
`67`		`-}`
	`67`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -68,4 +68,4 @@ class Led : public LedComponentBase {`
`68`	`68`
`69`	`69`	`} // namespace Components`
`70`	`70`
`71`		`-#endif`
	`71`	`+#endif`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`#####`
`2`	`2`	`# 'ReferenceDeployment' Deployment:`
`3`	`3`	`#`
`4`		`-# This registers the 'ReferenceDeployment' deployment to the build system.`
`5`		`-# Custom components that have not been added at the project-level should be added to`
	`4`	`+# This registers the 'ReferenceDeployment' deployment to the build system.`
	`5`	`+# Custom components that have not been added at the project-level should be added to`
`6`	`6`	`# the list below.`
`7`	`7`	`#`
`8`	`8`	`#####`