Ci/update (#7)

* added precommit hook for applying code style

* run precommit hook to update code style

* add ci for static analysis, building, and releasing

* fix static analysis

.clang-format

@@ -0,0 +1,117 @@
+---
+Language:        Cpp
+# BasedOnStyle:  LLVM
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Right
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: false
+BinPackArguments: true
+BinPackParameters: true
+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
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: true
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     100
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:   
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks:   Preserve
+IncludeCategories: 
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+  - Regex:           '.*'
+    Priority:        1
+IncludeIsMainRegex: '(Test)?$'
+IndentCaseLabels: false
+IndentPPDirectives: None
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Right
+RawStringFormats:
+  - Language: TextProto
+    Delimiters:
+      - 'pb'
+      - 'proto'
+    BasedOnStyle: google
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Cpp11
+TabWidth:        8
+UseTab:          Never
+...
+

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: Build
+
+on: [pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v2
+      with:
+        submodules: 'recursive'
+
+    - name: Build Examples
+      uses: espressif/esp-idf-ci-action@v1
+      with:
+        esp_idf_version: release-v5.2
+        target: esp32s3
+        path: '.'

.github/workflows/package_main.yml

@@ -0,0 +1,48 @@
+name: Build and Package Main
+
+on:
+  push:
+    branches: [main]
+  release:
+    types: [published]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    continue-on-error: false
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v2
+      with:
+        submodules: 'recursive'
+
+    - name: Build Main Code
+      uses: espressif/esp-idf-ci-action@v1
+      with:
+        esp_idf_version: release-v5.2
+        target: esp32s3
+        path: '.'
+        command: 'idf.py build'
+
+    - name: Upload Build Outputs
+      uses: actions/upload-artifact@v3
+      with:
+        name: build-artifacts
+        path: |
+          build/bootloader/bootloader.bin
+          build/partition_table/partition-table.bin
+          build/*.bin
+          build/flash_args
+
+    - name: Attach files to release
+      uses: softprops/action-gh-release@v1
+      if: ${{ github.event.release && github.event.action == 'published' }}
+      with:
+        files: |
+          build/*.bin
+          build/bootloader/bootloader.bin
+          build/partition_table/partition-table.bin
+          build/flash_args
+

.github/workflows/static_analysis.yml

@@ -0,0 +1,25 @@
+name: Static analysis
+
+on: [pull_request]
+
+jobs:
+  static_analysis:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v2
+      with:
+        submodules: 'recursive'
+
+    - name: Run static analysis
+      uses: esp-cpp/StaticAnalysis@master
+      with:
+        # Do not build the project and do not use cmake to generate compile_commands.json
+        use_cmake: false
+
+        # Use the 5.2 release version since it's what we build with
+        esp_idf_version: release/v5.2
+
+        # (Optional) cppcheck args
+        cppcheck_args: -i$GITHUB_WORKSPACE/components/espp -i$GITHUB_WORKSPACE/components/esp32-camera -i$GITHUB_WORKSPACE/components/esp-protocols --force --enable=all --inline-suppr --inconclusive --platform=mips32 --std=c++17 --suppressions-list=$GITHUB_WORKSPACE/suppressions.txt

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+-   repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v14.0.6
+    hooks:
+    -   id: clang-format
+        exclude: |
+          (?x)(
+          ^components/esp-dsp/|
+          ^components/esp_littlefs/|
+          ^components/lvgl/|
+          ^components/state_machine/include/magic_enum.hpp|
+          ^external/alpaca/|
+          ^external/cli/|
+          ^external/csv2/|
+          ^external/fmt/
+          )
+        types_or: [c++, c]

components/battery/include/battery.hpp

@@ -16,10 +16,10 @@ class Battery {
     espp::Logger::Verbosity log_level{espp::Logger::Verbosity::WARN};
   };
 
-  Battery(const Config& config)
-    : read_(config.read),
-      hold_gpio_(config.hold_gpio),
-      logger_({.tag = "Battery", .level = config.log_level}) {
+  explicit Battery(const Config &config)
+      : read_(config.read)
+      , hold_gpio_(config.hold_gpio)
+      , logger_({.tag = "Battery", .level = config.log_level}) {
     init();
   }
 
@@ -54,13 +54,12 @@ class Battery {
       return;
     }
     logger_.info("Initializing hold GPIO {}", hold_gpio_);
-    uint64_t pin_mask = (1 << hold_gpio_);
     gpio_config_t io_config = {
-      .pin_bit_mask = pin_mask,
-      .mode = GPIO_MODE_OUTPUT,
-      .pull_up_en = GPIO_PULLUP_DISABLE,
-      .pull_down_en = GPIO_PULLDOWN_DISABLE,
-      .intr_type = GPIO_INTR_DISABLE,
+        .pin_bit_mask = ((uint64_t)1 << hold_gpio_),
+        .mode = GPIO_MODE_OUTPUT,
+        .pull_up_en = GPIO_PULLUP_DISABLE,
+        .pull_down_en = GPIO_PULLDOWN_DISABLE,
+        .intr_type = GPIO_INTR_DISABLE,
     };
     ESP_ERROR_CHECK(gpio_config(&io_config));
     hold_output();

main/fs_init.cpp

@@ -3,10 +3,10 @@
 #include "format.hpp"
 
 static esp_vfs_littlefs_conf_t conf = {
-  .base_path = "/littlefs",
-  .partition_label = "littlefs",
-  .format_if_mount_failed = true,
-  .dont_mount = false,
+    .base_path = "/littlefs",
+    .partition_label = "littlefs",
+    .format_if_mount_failed = true,
+    .dont_mount = false,
 };
 
 void fs_init() {
@@ -28,8 +28,7 @@ void fs_init() {
   size_t total = 0, used = 0;
   ret = esp_littlefs_info(conf.partition_label, &total, &used);
   if (ret != ESP_OK) {
-    fmt::print("Failed to get LittleFS partition information ({})\n",
-               esp_err_to_name(ret));
+    fmt::print("Failed to get LittleFS partition information ({})\n", esp_err_to_name(ret));
   } else {
     fmt::print("Partition size: total: {}, used: {}\n", total, used);
   }

main/fs_init.hpp

@@ -1,7 +1,7 @@
 #pragma once
 
-#include <esp_err.h>
 #include "esp_littlefs.h"
+#include <esp_err.h>
 #include <sys/stat.h>
 
 void fs_init();