Refatora quase tudo

.clang-format

@@ -0,0 +1,46 @@
+---
+Language:        Cpp
+AccessModifierOffset: -4
+AlignAfterOpenBracket: BlockIndent
+AlignConsecutiveBitFields:
+  Enabled:         true
+  PadOperators:    true
+AlignConsecutiveDeclarations:
+  Enabled:         true
+  PadOperators:    true
+AlignConsecutiveMacros:
+  PadOperators:    true
+AlignEscapedNewlines: Left
+AllowShortBlocksOnASingleLine: Empty
+AllowShortEnumsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Inline
+AlwaysBreakTemplateDeclarations: Yes
+BreakBeforeTernaryOperators: false
+BreakConstructorInitializers: AfterColon
+BreakInheritanceList: AfterColon
+ColumnLimit:     120
+EmptyLineBeforeAccessModifier: Always
+IncludeCategories:
+  - Regex:           '^<.*>'
+    Priority:        1
+    SortPriority:    1
+  - Regex:           '^".*"'
+    SortPriority:    2
+IncludeIsMainRegex: '$'
+IndentCaseLabels: true
+IndentExternBlock: NoIndent
+IndentPPDirectives: BeforeHash
+IndentRequiresClause: false
+IndentWidth:     4
+IndentWrappedFunctionNames: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+PackConstructorInitializers: NextLine
+PointerAlignment: Left
+SeparateDefinitionBlocks: Always
+ShortNamespaceLines: 0
+SortIncludes:    Never
+SpaceInEmptyBlock: true
+SpacesBeforeTrailingComments: 2
+TabWidth:        4
+...
+

.clang-tidy

@@ -0,0 +1,60 @@
+---
+Checks:
+  -*,
+  bugprone-*,
+  -bugprone-easily-swappable-parameters,
+  -bugprone-narrowing-conversions,
+  -bugprone-dynamic-static-initializers,
+  clang-*,
+  -clang-diagnostic-unused-command-line-argument,
+  cppcoreguidelines-*,
+  -cppcoreguidelines-avoid-magic-numbers,
+  -cppcoreguidelines-pro-bounds-pointer-arithmetic,
+  -cppcoreguidelines-avoid-do-while,
+  -cppcoreguidelines-pro-type-union-access,
+  google-*,
+  llvm-*,
+  -llvm-header-guard,
+  misc-*,
+  -misc-include-cleaner,
+  -misc-const-correctness,
+  -misc-use-anonymous-namespace,
+  modernize-*,
+  -modernize-use-nodiscard,
+  -modernize-use-trailing-return-type,
+  performance-*,
+  readability-*,
+  -readability-duplicate-include,
+  -readability-magic-numbers,
+WarningsAsErrors: '*'
+HeaderFileExtensions:
+  - ''
+  - h
+  - hh
+  - hpp
+  - hxx
+ImplementationFileExtensions:
+  - c
+  - cc
+  - cpp
+  - cxx
+HeaderFilterRegex: '(include|config)/.*.hpp'
+FormatStyle: none
+CheckOptions:
+  readability-magic-numbers.IgnorePowersOf2IntegerValues: true
+  readability-magic-numbers.IgnoreBitFieldsWidths: true
+  readability-magic-numbers.IgnoreUserDefinedLiterals: true
+  readability-identifier-length.MinimumVariableNameLength: 2
+  readability-identifier-length.IgnoredVariableNames: ^[nxyz]$
+  readability-identifier-length.MinimumParameterNameLength: 2
+  readability-identifier-length.IgnoredParameterNames: ^[nxyz]$
+  misc-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic: true
+  cppcoreguidelines-narrowing-conversions.WarnOnIntegerToFloatingPointNarrowingConversion: false
+  readability-function-cognitive-complexity.Threshold: 30
+SystemHeaders: false
+ExtraArgsBefore:
+  - '--target=arm-none-eabi'
+  - '--sysroot=/usr/lib/arm-none-eabi/'
+  - '-I/usr/lib/arm-none-eabi/include/c++/13.2.1/'
+  - '-I/usr/lib/arm-none-eabi/include/c++/13.2.1/arm-none-eabi/'
+...

.devcontainer.json

@@ -0,0 +1,26 @@
+{
+    "name": "STM32 Template Container",
+    "dockerComposeFile": "compose.yaml",
+    "service": "dev",
+    "shutdownAction": "stopCompose",
+    "workspaceFolder": "/project",
+    "overrideCommand": true,
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-vscode.cpptools",
+                "cschlosser.doxdocgen",
+                "davidanson.vscode-markdownlint",
+                "marus25.Cortex-Debug",
+                "dan-c-underwood.arm",
+                "streetsidesoftware.code-spell-checker",
+                "streetsidesoftware.code-spell-checker-portuguese-brazilian",
+                "twxs.cmake",
+                "ms-vscode.cmake-tools",
+                "seatonjiang.gitmoji-vscode",
+                "mhutchie.git-graph",
+                "xaver.clang-format",
+            ]
+        }
+    }
+}

.docker/.dockerignore

@@ -0,0 +1,18 @@
+.git/
+.github/
+.vscode/
+.cache/
+.idea/
+build/
+cube/
+!**.ioc
+
+.devcontainer
+.gitignore
+.gitmodules
+Doxyfile
+LICENSE
+
+*.yaml
+*.md
+*.iml

.docker/Dockerfile

@@ -0,0 +1,39 @@
+##################################
+# Base image for STM32 Template  #
+##################################
+FROM thunderatz/stm32cubemx:6.13.0-f1 AS base
+
+RUN apt-get update -y > /dev/null && \
+    apt-get upgrade -y > /dev/null && \
+    apt-get install -y \
+    gcc-arm-none-eabi \
+    make \
+    cmake \
+    clang-tidy \
+    clang-format  > /dev/null\
+    && apt-get clean > /dev/null
+
+WORKDIR /project
+COPY ./cube/*.ioc /project/cube/
+
+ENV CUBE_CMD=${CUBE_PATH}/STM32CubeMX
+
+ENV DISPLAY=:10
+ARG PROJECT_NAME=stm32_project_template
+
+RUN Xvfb :10 -ac & \
+    echo "config load /project/cube/${PROJECT_NAME}.ioc\nproject generate\nexit\n" > .cube && \
+    $CUBE_PATH/STM32CubeMX -q /project/.cube && \
+    rm .cube && \
+    pkill -f Xvfb
+
+RUN rm /tmp/.X10-lock
+
+RUN echo "trap 'chown -R ubuntu /project' EXIT" >> "/root/.bashrc"
+
+###################################
+# Build image for STM32 Template  #
+###################################
+FROM base AS build
+
+COPY . /project

.docker/scripts/build.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+BUILD_ARG=$1
+
+rm -rf /project/build || exit 1
+mkdir -p /project/build || exit 1
+cd /project/build || exit 1
+cmake .. -DBUILD_TYPE=Release $BUILD_ARG || exit 1
+
+echo "Compiling main..." | sed 's/.*/\x1b[34m&\x1b[0m/'
+
+make -j
+
+if [ $? -eq 0 ]; then
+  echo "Compilation successful." | sed 's/.*/\x1b[32m&\x1b[0m/'
+else
+  echo "Compilation failed." | sed 's/.*/\x1b[31m&\x1b[0m/'
+  exit 1
+fi
+
+echo "Compiling tests..." | sed 's/.*/\x1b[34m&\x1b[0m/'
+
+make test_all -j
+
+if [ $? -eq 0 ]; then
+  echo "Tests compiled successfully." | sed 's/.*/\x1b[32m&\x1b[0m/'
+else
+  echo "Tests compilation failed." | sed 's/.*/\x1b[31m&\x1b[0m/'
+  exit 1
+fi

.docker/scripts/check_format.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+FILES=$(find . \( -name "*.c" -o -name "*.cpp" -o -name "*.h" -o -name "*.hpp" \) \
+                -not \( -path "*/cube/*" -o -path "*/build/*" -o -path "*/libs/*" \))
+
+for FILE in $FILES; do
+    clang-format -style=file -output-replacements-xml $FILE | grep "<replacement " >/dev/null
+    if [ $? -eq 0 ]; then
+        echo "Code not properly formatted (File: $FILE). Please run make format." | sed 's/.*/\x1b[31m&\x1b[0m/'
+        exit 1
+    fi
+done
+
+echo "Code properly formatted." | sed 's/.*/\x1b[32m&\x1b[0m/'

.githooks/pre-commit

@@ -4,8 +4,8 @@ cd "$( dirname "${BASH_SOURCE[0]}" )"/..
 
 for file in $(git diff --cached --name-only --diff-filter=ACMRT | grep "\.[ch]$")
 do
-    uncrustify -q -f $file -c uncrustify.cfg --check > /dev/null 2> /dev/null
-    if [ $? -ne 0 ]; then
+    clang-format -style=file -output-replacements-xml $file | grep "<replacement " >/dev/null
+    if [ $? -eq 0 ]; then
         echo "Code not properly formatted. Please run make format and git add again."
         git reset -q HEAD
         exit 1

.github/workflows/ci.yaml

@@ -0,0 +1,66 @@
+name: Build lint and check formatting
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    branches:
+      - develop
+      - main
+  push:
+    branches:
+      - develop
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request' || github.event.pull_request.draft == false
+    steps:
+      - name: 🔀 Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: 🗃️ Check cache
+        id: cache
+        uses: actions/cache/restore@v4
+        with:
+            path: .docker/Dockerfile
+            key: ${{ hashFiles('.github/*', 'cmake/*', '**/*.cpp', '**/*.hpp', '**/*.ioc', '.clang*', 'CMakeLists.txt', '.docker/*') }}
+            lookup-only: true
+
+      - name: 🔧 Set up Docker Buildx
+        if: steps.cache.outputs.cache-hit != 'true'
+        uses: docker/setup-buildx-action@v3
+
+      - name: 🐋 Build Docker image
+        if: steps.cache.outputs.cache-hit != 'true'
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: .docker/Dockerfile
+          target: build
+          load: true
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          no-cache-filters: build
+          tags: project:build
+
+      - name: 🎨 Check code formatting
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: docker run --rm project:build /bin/bash /project/.docker/scripts/check_format.sh
+
+      - name: 🔨 Build project
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: docker run --rm project:build /bin/bash /project/.docker/scripts/build.sh
+
+      - name: 🚨 Lint project
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: docker run --rm project:build /bin/bash /project/.docker/scripts/build.sh -DLINTER_MODE=ON
+
+      - name: 🗃️ Save cache
+        if: steps.cache.outputs.cache-hit != 'true'
+        uses: actions/cache/save@v4
+        with:
+            path: .docker/Dockerfile
+            key: ${{ steps.cache.outputs.cache-primary-key }}

.github/workflows/release.yaml

@@ -0,0 +1,42 @@
+name: Add binaries to release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🔀 Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: 🔧 Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: 🐋 Build Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: .docker/Dockerfile
+          target: build
+          load: true
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          no-cache-filters: build
+          tags: project:build
+
+      - name: 🔨 Build project
+        run: |
+          docker run --name release project:build /bin/bash /project/.docker/scripts/build.sh
+          docker cp release:/project/build/ output/
+
+      - name: ⬆️ Upload binaries
+        run: gh release upload ${{ github.event.release.tag_name }} output/*.hex output/*.elf
+        env:
+          GITHUB_TOKEN: ${{ github.token }}

.gitignore

@@ -6,6 +6,7 @@ build/
 -g
 .jlink-flash
 .cube
+docs
 
 # Created by https://www.gitignore.io/api/visualstudiocode,c
 
@@ -66,7 +67,6 @@ dkms.conf
 ### VisualStudioCode ###
 .vscode/*
 !.vscode/settings.json
-!.vscode/tasks.json
 !.vscode/extensions.json