From b5564c1c4b94d10ddd6907f43c33496001f1b98b Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Mon, 19 Feb 2024 23:49:33 -0800 Subject: [PATCH] 1.x update clang format (#220) * satisfy nRF24/.github#9 * ran clang-format * use separate CI workflow to check code format * enable dependabot --- .clang-format | 31 +++++++++----------------- .github/dependabot.yml | 13 +++++++++++ .github/workflows/build_arduino.yml | 9 ++------ .github/workflows/build_linux.yml | 8 ++----- .github/workflows/build_platformIO.yml | 10 +++------ .github/workflows/build_rp2xxx.yml | 8 ++----- .github/workflows/clang_format.yml | 14 ++++++++++++ .github/workflows/doxygen.yml | 4 ++-- RF24Network.cpp | 4 ++-- RF24Network.h | 24 ++++++++++---------- 10 files changed, 63 insertions(+), 62 deletions(-) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/clang_format.yml diff --git a/.clang-format b/.clang-format index 5b8681ed..c02cf2f6 100644 --- a/.clang-format +++ b/.clang-format @@ -14,13 +14,13 @@ AlignTrailingComments: true AllowAllArgumentsOnNextLine: true AllowAllConstructorInitializersOnNextLine: true AllowAllParametersOfDeclarationOnNextLine: true -AllowShortEnumsOnASingleLine: true -AllowShortBlocksOnASingleLine: Always +AllowShortEnumsOnASingleLine: false +AllowShortBlocksOnASingleLine: Empty AllowShortCaseLabelsOnASingleLine: true AllowShortFunctionsOnASingleLine: All AllowShortLambdasOnASingleLine: All -AllowShortIfStatementsOnASingleLine: WithoutElse -AllowShortLoopsOnASingleLine: true +AllowShortIfStatementsOnASingleLine: Never +AllowShortLoopsOnASingleLine: false AlwaysBreakAfterReturnType: None AlwaysBreakBeforeMultilineStrings: false AlwaysBreakTemplateDeclarations: Yes @@ -67,10 +67,7 @@ DeriveLineEnding: false DerivePointerAlignment: false DisableFormat: false EmptyLineBeforeAccessModifier: Always -# --- -# only in v13+ -# EmptyLineAfterAccessModifier: Leave -# --- +EmptyLineAfterAccessModifier: Leave ExperimentalAutoDetectBinPacking: false FixNamespaceComments: true IncludeBlocks: Preserve @@ -89,10 +86,7 @@ IncludeCategories: CaseSensitive: false IncludeIsMainRegex: "(Test)?$" IncludeIsMainSourceRegex: "" -# --- -# only in v13+ -# IndentAccessModifiers: false -# --- +IndentAccessModifiers: false IndentCaseLabels: true IndentCaseBlocks: false IndentGotoLabels: false @@ -117,15 +111,12 @@ PenaltyExcessCharacter: 1000000 PenaltyReturnTypeOnItsOwnLine: 60 PenaltyIndentedWhitespace: 0 PointerAlignment: Left -# --- -# only in v13+ -# ReferenceAlignment: Right -# --- +ReferenceAlignment: Pointer ReflowComments: true -# --- -# only in v13+ -# ShortNamespaceLines: 0 -# --- +SpacesInLineCommentPrefix: + Maximum: -1 + Minimum: 0 +ShortNamespaceLines: 0 # Sort**** is about sorting include/using statements alphabetically SortIncludes: false SortUsingDeclarations: false diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..05a48fc6 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,13 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "github-actions" + # Workflow files stored in the + # default location of `.github/workflows` + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/build_arduino.yml b/.github/workflows/build_arduino.yml index d1fc0d34..b984a10f 100644 --- a/.github/workflows/build_arduino.yml +++ b/.github/workflows/build_arduino.yml @@ -2,25 +2,20 @@ name: Arduino CLI build on: pull_request: - types: [opened, reopened] + branches: [master, v1.x] paths: - ".github/workflows/build_arduino.yml" - "examples/**" push: + branches: [master, v1.x] paths: - ".github/workflows/build_arduino.yml" - "examples/**" jobs: - check_formatting: - uses: nRF24/.github/.github/workflows/cpp_lint.yaml@main - with: - ignore: '!examples|' - extensions: ino build: - needs: check_formatting uses: nRF24/.github/.github/workflows/build_arduino.yaml@main with: sketch-paths: | diff --git a/.github/workflows/build_linux.yml b/.github/workflows/build_linux.yml index bdf51193..3b9c96de 100644 --- a/.github/workflows/build_linux.yml +++ b/.github/workflows/build_linux.yml @@ -2,7 +2,7 @@ name: Linux build on: pull_request: - types: [opened, reopened] + branches: [master, v1.x] paths: - "*.h" - "*.cpp" @@ -15,6 +15,7 @@ on: - "**pyRF24Network/*.cpp" - ".github/workflows/linux_build.yml" push: + branches: [master, v1.x] paths: - "*.h" - "*.cpp" @@ -30,13 +31,8 @@ on: types: [created] jobs: - check_formatting: - uses: nRF24/.github/.github/workflows/cpp_lint.yaml@main - with: - ignore: 'examples|examples_pico' using_cmake: - needs: check_formatting uses: nRF24/.github/.github/workflows/build_linux_cmake.yaml@main with: rf24network-ref: ${{ github.sha }} diff --git a/.github/workflows/build_platformIO.yml b/.github/workflows/build_platformIO.yml index 9fc7bcb1..64986fe6 100644 --- a/.github/workflows/build_platformIO.yml +++ b/.github/workflows/build_platformIO.yml @@ -2,13 +2,14 @@ name: PlatformIO build on: pull_request: - types: [opened, reopened] + branches: [master, v1.x] paths: - ".github/workflows/build_platformIO.yml" - "library.json" - "examples/**" - "!examples/*.zip" push: + branches: [master, v1.x] paths: - ".github/workflows/build_platformIO.yml" - "library.json" @@ -24,13 +25,8 @@ jobs: with: deploy-release: ${{ github.event_name == 'release' }} - check_formatting: - uses: nRF24/.github/.github/workflows/cpp_lint.yaml@main - with: - extensions: ino - build: - needs: [check_formatting, validate_lib_json] + needs: [validate_lib_json] uses: nRF24/.github/.github/workflows/build_platformio.yaml@main with: example-path: ${{ matrix.example }} diff --git a/.github/workflows/build_rp2xxx.yml b/.github/workflows/build_rp2xxx.yml index 1b482b24..dd49212a 100644 --- a/.github/workflows/build_rp2xxx.yml +++ b/.github/workflows/build_rp2xxx.yml @@ -2,6 +2,7 @@ name: Pico SDK build on: push: + branches: [master, v1.x] paths: - ".github/workflows/build_rp2xxx.yml" - "*.h" @@ -10,7 +11,7 @@ on: - "cmake/" - "examples_pico/*" pull_request: - types: [opened, reopened] + branches: [master, v1.x] paths: - ".github/workflows/build_rp2xxx.yml" - "*.h" @@ -20,13 +21,8 @@ on: - "examples_pico/*" jobs: - check_formatting: - uses: nRF24/.github/.github/workflows/cpp_lint.yaml@main - with: - ignore: '!examples_pico|' build: - needs: check_formatting uses: nRF24/.github/.github/workflows/build_pico_sdk.yaml@main with: board-id: ${{ matrix.board }} diff --git a/.github/workflows/clang_format.yml b/.github/workflows/clang_format.yml new file mode 100644 index 00000000..41105c1c --- /dev/null +++ b/.github/workflows/clang_format.yml @@ -0,0 +1,14 @@ +name: check code formatting + +on: + push: + branches: [master, v1.x] + pull_request: + branches: [master, v1.x] + +jobs: + check_formatting: + uses: nRF24/.github/.github/workflows/cpp_lint.yaml@main + with: + ignore: examples/old_backups|utility/RPi/bcm2835.h|utility/RPi/bcm2835.c + extensions: ino,c,cpp,h diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index bfefa1a6..d4ff9b3a 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -2,7 +2,7 @@ name: build Docs on: pull_request: - types: [opened, reopened] + branches: [master, v1.x] paths: - "*.h" - "docs/**" @@ -13,6 +13,7 @@ on: - "Doxyfile" - "library.properties" # get lib version from here push: + branches: [master, v1.x] paths: - "*.h" - "docs/**" @@ -23,7 +24,6 @@ on: - "Doxyfile" - "library.properties" # get lib version from here release: - branches: [master] types: [published, edited] workflow_dispatch: diff --git a/RF24Network.cpp b/RF24Network.cpp index b86a44e5..ba4fe251 100644 --- a/RF24Network.cpp +++ b/RF24Network.cpp @@ -779,7 +779,7 @@ bool RF24Network::_write(RF24NetworkHeader& header, const void* message, uint16_ //IF_SERIAL_DEBUG(printf_P(PSTR("NET Sending " PRIPSTR // "\n\r"), - // header.toString())); + // header.toString())); if (len) { #if defined(RF24_LINUX) memcpy(frame_buffer + sizeof(RF24NetworkHeader), message, rf24_min(frame_size - sizeof(RF24NetworkHeader), len)); @@ -828,7 +828,7 @@ bool RF24Network::write(uint16_t to_node, uint8_t sendType) isAckType = true; /*if( ( (frame_buffer[7] % 2) && frame_buffer[6] == NETWORK_MORE_FRAGMENTS) ){ - isAckType = 0; + isAckType = 0; }*/ // Throw it away if it's not a valid address diff --git a/RF24Network.h b/RF24Network.h index 44dc28cc..d394dd0c 100644 --- a/RF24Network.h +++ b/RF24Network.h @@ -314,9 +314,9 @@ struct RF24NetworkFrame uint16_t message_size; /** - * On Arduino, the message buffer is just a pointer, and can be pointed to any memory location. - * On Linux the message buffer is a standard byte array, equal in size to the defined MAX_PAYLOAD_SIZE - */ + * On Arduino, the message buffer is just a pointer, and can be pointed to any memory location. + * On Linux the message buffer is a standard byte array, equal in size to the defined MAX_PAYLOAD_SIZE + */ #if defined(RF24_LINUX) uint8_t message_buffer[MAX_PAYLOAD_SIZE]; // Array to store the message #else @@ -331,15 +331,15 @@ struct RF24NetworkFrame RF24NetworkFrame() {} /** - * **Constructor for Linux platforms** - create a network frame with data - * Frames are constructed and handled differently on Arduino/AVR and Linux devices (`#if defined RF24_LINUX`) - * - * @param _header The RF24Network header to be stored in the frame - * @param _message The 'message' or data. - * @param _len The size of the 'message' or data. - * - * Frames are used internally and by external systems. See RF24NetworkHeader. - */ + * **Constructor for Linux platforms** - create a network frame with data + * Frames are constructed and handled differently on Arduino/AVR and Linux devices (`#if defined RF24_LINUX`) + * + * @param _header The RF24Network header to be stored in the frame + * @param _message The 'message' or data. + * @param _len The size of the 'message' or data. + * + * Frames are used internally and by external systems. See RF24NetworkHeader. + */ #if defined(RF24_LINUX) || defined(DOXYGEN_FORCED) RF24NetworkFrame(RF24NetworkHeader& _header, const void* _message = NULL, uint16_t _len = 0) : header(_header), message_size(_len) {