Merge pull request #2 from ESPToolKit/formatter-baseline

Align formatter baseline with esptoolkit-template

Author: zekageri

.clang-format

@@ -0,0 +1,11 @@
+BasedOnStyle: LLVM
+ColumnLimit: 100
+BinPackArguments: false
+BinPackParameters: false
+AllowAllArgumentsOnNextLine: false
+AlignAfterOpenBracket: BlockIndent
+UseTab: ForIndentation
+IndentWidth: 4
+TabWidth: 4
+ContinuationIndentWidth: 4
+AllowShortFunctionsOnASingleLine: None

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+
+[*.{c,cc,cpp,h,hpp,ino}]
+indent_style = tab
+indent_size = tab
+tab_width = 4

.gitignore

@@ -1,4 +1,3 @@
 .venv
 build/
 build_prev_runner/
-.vscode

.vscode/bin/clang-format

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+if command -v clang-format >/dev/null 2>&1; then
+    exec clang-format "$@"
+fi
+
+_home_dir="${HOME:-}"
+if [ -n "$_home_dir" ]; then
+    _candidate="$(ls -1d "$_home_dir"/.vscode/extensions/ms-vscode.cpptools-*-linux-x64/LLVM/bin/clang-format 2>/dev/null | tail -n 1 || true)"
+    if [ -n "$_candidate" ] && [ -x "$_candidate" ]; then
+        exec "$_candidate" "$@"
+    fi
+fi
+
+echo "clang-format executable not found." >&2
+echo "Install clang-format system-wide or install/update ms-vscode.cpptools." >&2
+exit 127

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+    "recommendations": [
+        "pioarduino.pioarduino-ide",
+        "xaver.clang-format"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,30 @@
+{
+    "files.associations": {
+        "*.ino": "cpp"
+    },
+    "editor.defaultFormatter": "xaver.clang-format",
+    "C_Cpp.formatting": "Disabled",
+    "clang-format.style": "file",
+    "clang-format.executable": "${workspaceRoot}/.vscode/bin/clang-format",
+    "[cpp]": {
+        "editor.defaultFormatter": "xaver.clang-format",
+        "editor.detectIndentation": false,
+        "editor.insertSpaces": false,
+        "editor.tabSize": 4,
+        "editor.formatOnSave": true
+    },
+    "[c]": {
+        "editor.defaultFormatter": "xaver.clang-format",
+        "editor.detectIndentation": false,
+        "editor.insertSpaces": false,
+        "editor.tabSize": 4,
+        "editor.formatOnSave": true
+    },
+    "[arduino]": {
+        "editor.defaultFormatter": "xaver.clang-format",
+        "editor.detectIndentation": false,
+        "editor.insertSpaces": false,
+        "editor.tabSize": 4,
+        "editor.formatOnSave": true
+    }
+}

.vscode/tasks.json

@@ -0,0 +1,12 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Format Firmware Sources",
+            "type": "shell",
+            "command": "bash ${workspaceFolder}/scripts/format_cpp.sh",
+            "group": "build",
+            "problemMatcher": []
+        }
+    ]
+}

README.md

@@ -134,6 +134,13 @@ serializeJson(json, Serial);
 - `examples/failure-policy` - rollback and teardown failure policy behavior.
 - `examples/reload-burst` - listener burst coalescing and deduplicated node-name reloads.
 
+## Formatting Baseline
+
+This repository follows the firmware formatting baseline from `esptoolkit-template`:
+- `.clang-format` is the source of truth for C/C++/INO layout.
+- `.editorconfig` enforces tabs (`tab_width = 4`), LF endings, and final newline.
+- Format all tracked firmware sources with `bash scripts/format_cpp.sh`.
+
 ## License
 MIT - see [LICENSE.md](LICENSE.md).
 

examples/basic-startup/basic-startup.ino

@@ -6,48 +6,53 @@ ESPWorker worker;
 ESPLifecycle lifecycle;
 
 void setup() {
-    Serial.begin(115200);
-
-    worker.init(ESPWorker::Config{});
-
-    LifecycleConfig config{};
-    config.worker = &worker;
-    config.enableParallelInit = true;
-    config.enableParallelDeinit = true;
-    config.enableParallelReinit = true;
-    config.onInitStarted = []() { Serial.println("init started"); };
-    config.onReady = []() { Serial.println("running"); };
-    config.onInitFailed = []() { Serial.println("init failed"); };
-
-    lifecycle.configure(config);
-    lifecycle.init({"core", "network"});
-
-    lifecycle.addTo("core", "logger", []() { return true; }, []() { return true; }).parallelSafe();
-    lifecycle.addTo("core", "storage", []() { return true; }, []() { return true; });
-    lifecycle.addTo("network", "wifi", []() { return true; }, []() { return true; }).after("storage");
-
-    LifecycleResult buildResult = lifecycle.build();
-    if( !buildResult.ok ){
-        Serial.println("build failed");
-        return;
-    }
-
-    LifecycleResult initResult = lifecycle.initialize();
-    if( !initResult.ok ){
-        Serial.println("initialize failed");
-        return;
-    }
-
-    JsonDocument snapshot = lifecycle.snapshotJson();
-    const bool phaseCompleted = snapshot["phaseCompleted"] | false;
-    Serial.printf("phase status: %s\n", phaseCompleted ? "completed" : "in progress");
-    serializeJson(snapshot, Serial);
-    Serial.println();
-
-    delay(1000);
-    (void)lifecycle.deinitialize({"logger"});
+	Serial.begin(115200);
+
+	worker.init(ESPWorker::Config{});
+
+	LifecycleConfig config{};
+	config.worker = &worker;
+	config.enableParallelInit = true;
+	config.enableParallelDeinit = true;
+	config.enableParallelReinit = true;
+	config.onInitStarted = []() { Serial.println("init started"); };
+	config.onReady = []() { Serial.println("running"); };
+	config.onInitFailed = []() { Serial.println("init failed"); };
+
+	lifecycle.configure(config);
+	lifecycle.init({"core", "network"});
+
+	lifecycle.addTo("core", "logger", []() { return true; }, []() { return true; }).parallelSafe();
+	lifecycle.addTo("core", "storage", []() { return true; }, []() { return true; });
+	lifecycle.addTo(
+	             "network",
+	             "wifi",
+	             []() { return true; },
+	             []() { return true; }
+	).after("storage");
+
+	LifecycleResult buildResult = lifecycle.build();
+	if (!buildResult.ok) {
+		Serial.println("build failed");
+		return;
+	}
+
+	LifecycleResult initResult = lifecycle.initialize();
+	if (!initResult.ok) {
+		Serial.println("initialize failed");
+		return;
+	}
+
+	JsonDocument snapshot = lifecycle.snapshotJson();
+	const bool phaseCompleted = snapshot["phaseCompleted"] | false;
+	Serial.printf("phase status: %s\n", phaseCompleted ? "completed" : "in progress");
+	serializeJson(snapshot, Serial);
+	Serial.println();
+
+	delay(1000);
+	(void)lifecycle.deinitialize({"logger"});
 }
 
 void loop() {
-    delay(250);
+	delay(250);
 }

examples/deferred-readiness/deferred-readiness.ino

@@ -6,57 +6,57 @@ ESPWorker worker;
 ESPLifecycle lifecycle;
 
 bool initCore() {
-    Serial.println("init core");
-    return true;
+	Serial.println("init core");
+	return true;
 }
 
 bool initCloud() {
-    Serial.println("init cloud");
-    return true;
+	Serial.println("init cloud");
+	return true;
 }
 
 bool deinitCore() {
-    Serial.println("deinit core");
-    return true;
+	Serial.println("deinit core");
+	return true;
 }
 
 bool deinitCloud() {
-    Serial.println("deinit cloud");
-    return true;
+	Serial.println("deinit cloud");
+	return true;
 }
 
 bool cloudReady() {
-    return millis() > 4000;
+	return millis() > 4000;
 }
 
 void waitForReady(TickType_t waitTicks) {
-    (void)waitTicks;
-    delay(250);
+	(void)waitTicks;
+	delay(250);
 }
 
 void setup() {
-    Serial.begin(115200);
+	Serial.begin(115200);
 
-    worker.init(ESPWorker::Config{});
+	worker.init(ESPWorker::Config{});
 
-    LifecycleConfig config{};
-    config.worker = &worker;
-    config.onReady = []() { Serial.println("all sections ready"); };
+	LifecycleConfig config{};
+	config.worker = &worker;
+	config.onReady = []() { Serial.println("all sections ready"); };
 
-    lifecycle.configure(config);
-    lifecycle.init({"core", "cloud"});
+	lifecycle.configure(config);
+	lifecycle.init({"core", "cloud"});
 
-    lifecycle.section("cloud")
-        .mode(LifecycleSectionMode::Deferred)
-        .readiness(cloudReady, waitForReady);
+	lifecycle.section("cloud")
+	    .mode(LifecycleSectionMode::Deferred)
+	    .readiness(cloudReady, waitForReady);
 
-    lifecycle.addTo("core", "core-init", initCore, deinitCore);
-    lifecycle.addTo("cloud", "cloud-sync", initCloud, deinitCloud).after("core-init");
+	lifecycle.addTo("core", "core-init", initCore, deinitCore);
+	lifecycle.addTo("cloud", "cloud-sync", initCloud, deinitCloud).after("core-init");
 
-    (void)lifecycle.build();
-    (void)lifecycle.initialize();
+	(void)lifecycle.build();
+	(void)lifecycle.initialize();
 }
 
 void loop() {
-    delay(500);
+	delay(500);
 }