Skip to content

Commit

Permalink
Update clang format (#231)
Browse files Browse the repository at this point in the history
* satisfy nRF24/.github#9
* ran clang-format
* use separate CI workflow to check code format
* enable dependabot
  • Loading branch information
2bndy5 committed Feb 20, 2024
1 parent 38ee022 commit e0d390c
Show file tree
Hide file tree
Showing 10 changed files with 68 additions and 67 deletions.
23 changes: 7 additions & 16 deletions .clang-format
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -89,10 +86,7 @@ IncludeCategories:
CaseSensitive: false
IncludeIsMainRegex: "(Test)?$"
IncludeIsMainSourceRegex: ""
# ---
# only in v13+
# IndentAccessModifiers: false
# ---
IndentAccessModifiers: false
IndentCaseLabels: true
IndentCaseBlocks: false
IndentGotoLabels: false
Expand All @@ -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
Expand Down
13 changes: 13 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -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"
9 changes: 2 additions & 7 deletions .github/workflows/build_arduino.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
8 changes: 2 additions & 6 deletions .github/workflows/build_linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Linux build

on:
pull_request:
types: [opened, reopened]
branches: [master, v1.x]
paths:
- "*.h"
- "*.cpp"
Expand All @@ -15,6 +15,7 @@ on:
- "pyRF24Mesh/*"
- ".github/workflows/build_linux.yml"
push:
branches: [master, v1.x]
paths:
- "*.h"
- "*.cpp"
Expand All @@ -34,13 +35,8 @@ env:
BUILD_TYPE: Release

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:
rf24mesh-ref: ${{ github.sha }}
Expand Down
10 changes: 3 additions & 7 deletions .github/workflows/build_platformIO.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@ name: PlatformIO build

on:
pull_request:
types: [opened, reopened]
branches: [master, v1.x]
paths:
- ".github/workflows/build_platformIO.yml"
- "library.json"
- "examples/**"
- "!examples/old_backups/**"
- "!examples/rf24_ATTiny/**"
push:
branches: [master, v1.x]
paths:
- ".github/workflows/build_platformIO.yml"
- "library.json"
Expand All @@ -26,13 +27,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 }}
Expand Down
8 changes: 2 additions & 6 deletions .github/workflows/build_rp2xxx.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ name: Pico SDK build

on:
push:
branches: [master, v1.x]
paths:
- ".github/workflows/build_rp2xxx.yml"
- "*.h"
Expand All @@ -10,7 +11,7 @@ on:
- "cmake/"
- "examples_pico/*"
pull_request:
types: [opened, reopened]
branches: [master, v1.x]
paths:
- ".github/workflows/build_rp2xxx.yml"
- "*.h"
Expand All @@ -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 }}
Expand Down
14 changes: 14 additions & 0 deletions .github/workflows/clang_format.yml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: build Docs

on:
pull_request:
types: [opened, reopened]
branches: [master, v1.x]
paths:
- "*.h"
- "docs/**"
Expand All @@ -15,6 +15,7 @@ on:
- "Doxyfile"
- "library.properties" # get lib version from here
push:
branches: [master, v1.x]
paths:
- "*.h"
- "docs/**"
Expand All @@ -27,7 +28,6 @@ on:
- "Doxyfile"
- "library.properties" # get lib version from here
release:
branches: [master]
types: [published, edited]
workflow_dispatch:

Expand Down
8 changes: 4 additions & 4 deletions RF24Mesh.h
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ class ESBMesh
public:
/**
* Construct the mesh.
*
*
* v2.0 supports a backward compatible constructor:
* @code
* RF24 radio(7, 8);
Expand All @@ -91,7 +91,7 @@ class ESBMesh
* RF52Network network1(radio1);
* RF52Mesh mesh1(network1, radio1); // for nRF52xxx family
* @endcode
*
*
* @see v2.0 supports [nrf_to_nrf Arduino library](https://github.com/TMRh20/nrf_to_nrf)
* for nrf52 chips' internal radio.
* @param _radio The underlying radio driver instance
Expand Down Expand Up @@ -371,11 +371,11 @@ class ESBMesh

/**
* A type definition of the template class `ESBMesh` to maintain backward compatibility.
*
*
* ```.cpp
* RF24 radio(7, 8);
* RF24Network network(radio);
*
*
* RF24Mesh mesh(radio, network);
* // is equivalent to
* ESBMesh<ESBNetwork<RF24>, RF24> mesh(radio, network);
Expand Down
38 changes: 19 additions & 19 deletions examples_RPi/ncurses/RF24Mesh_Ncurses_Master.cpp
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@

/*
* RF24Mesh Master Node Monitoring Tool
* This is a generic tool for master nodes running RF24Mesh that will display address
* assignments, and information regarding incoming data, regardless of the specific
* configuration details.
*
* Requirements: NCurses
* Install NCurses: apt-get install libncurses5-dev
* Setup:
* 1: make
* 2: sudo ./RF24Mesh_Ncurses_Master
*
* NOTE: DEBUG MUST BE DISABLED IN RF24Mesh_config.h
*
* Once configured and running, the interface will display the header information, data rate,
* and address assignments for all connected nodes.*
* The master node will also continuously ping each of the child nodes, one per second, while indicating
* the results.
*
*/
* RF24Mesh Master Node Monitoring Tool
* This is a generic tool for master nodes running RF24Mesh that will display address
* assignments, and information regarding incoming data, regardless of the specific
* configuration details.
*
* Requirements: NCurses
* Install NCurses: apt-get install libncurses5-dev
* Setup:
* 1: make
* 2: sudo ./RF24Mesh_Ncurses_Master
*
* NOTE: DEBUG MUST BE DISABLED IN RF24Mesh_config.h
*
* Once configured and running, the interface will display the header information, data rate,
* and address assignments for all connected nodes.*
* The master node will also continuously ping each of the child nodes, one per second, while indicating
* the results.
*
*/

#include <ncurses.h>
#include "RF24Mesh/RF24Mesh.h"
Expand Down

0 comments on commit e0d390c

Please sign in to comment.