Refactor/cleanup tech debt (#9)

* Cleanup tech debt

* Update vs code config

* Cleanup magic numbers

* Update README.md

* Remove redundant docs

* Remove unneeded README

* Rename build script name

* Simplify makefiles and update help section

* Add testing framework README

* Remove outdated test README

Author: MatthewMuller

.vscode/README.md

@@ -2,7 +2,7 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "Debug Cisco CLI (Local)",
+            "name": "Debug Cisco CLI",
             "type": "cppdbg",
             "request": "launch",
             "program": "${workspaceFolder}/build/cisco-cli-interface",
@@ -31,40 +31,7 @@
                     "ignoreFailures": true
                 }
             ],
-            "preLaunchTask": "docker-build-debug",
-            "miDebuggerPath": "/usr/bin/gdb",
-            "logging": {
-                "engineLogging": false,
-                "trace": false,
-                "traceResponse": false
-            }
-        },
-        {
-            "name": "Debug Cisco CLI (Docker)",
-            "type": "cppdbg",
-            "request": "launch",
-            "program": "/app/build/cisco-cli-interface",
-            "args": [
-                "/dev/ttyUSB0"
-            ],
-            "stopAtEntry": false,
-            "cwd": "/app",
-            "environment": [
-                {
-                    "name": "TERM",
-                    "value": "xterm-256color"
-                }
-            ],
-            "externalConsole": false,
-            "MIMode": "gdb",
-            "setupCommands": [
-                {
-                    "description": "Enable pretty-printing for gdb",
-                    "text": "-enable-pretty-printing",
-                    "ignoreFailures": true
-                }
-            ],
-            "preLaunchTask": "docker-build-debug",
+            "preLaunchTask": "build-debug",
             "miDebuggerPath": "/usr/bin/gdb",
             "logging": {
                 "engineLogging": false,

.vscode/launch.json

@@ -19,6 +19,12 @@
         "-g",
         "-O0"
     ],
+    "C_Cpp.default.browse": {
+        "path": [
+            "${workspaceFolder}/include",
+            "${workspaceFolder}/src"
+        ]
+    },
     "files.associations": {
         "*.h": "c",
         "*.c": "c"
@@ -36,5 +42,7 @@
     "debug.console.lineHeight": 22,
     "debug.inlineValues": true,
     "debug.showBreakpointsInOverviewRuler": true,
-    "debug.showInlineBreakpointCandidates": true
+    "debug.showInlineBreakpointCandidates": true,
+    "debug.allowBreakpointsEverywhere": true,
+    "debug.openDebug": "openOnDebugBreak"
 }

.vscode/settings.json

@@ -4,11 +4,14 @@
         {
             "label": "build-debug",
             "type": "shell",
-            "command": "make",
+            "command": "./scripts/dev-setup.sh",
             "args": [
                 "debug"
             ],
-            "group": "build",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
             "presentation": {
                 "echo": true,
                 "reveal": "always",
@@ -20,14 +23,14 @@
             "problemMatcher": [
                 "$gcc"
             ],
-            "detail": "Build the Cisco CLI Interface with debug symbols"
+            "detail": "Build the Cisco CLI Interface with debug symbols using dev-setup.sh"
         },
         {
             "label": "build-release",
             "type": "shell",
-            "command": "make",
+            "command": "./scripts/dev-setup.sh",
             "args": [
-                "release"
+                "compile"
             ],
             "group": "build",
             "presentation": {
@@ -41,19 +44,16 @@
             "problemMatcher": [
                 "$gcc"
             ],
-            "detail": "Build the Cisco CLI Interface for release"
+            "detail": "Build the Cisco CLI Interface for release using dev-setup.sh"
         },
         {
-            "label": "docker-build-debug",
+            "label": "setup-environment",
             "type": "shell",
             "command": "./scripts/dev-setup.sh",
             "args": [
-                "debug"
+                "build"
             ],
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            },
+            "group": "build",
             "presentation": {
                 "echo": true,
                 "reveal": "always",
@@ -62,15 +62,12 @@
                 "showReuseMessage": true,
                 "clear": false
             },
-            "problemMatcher": [
-                "$gcc"
-            ],
-            "detail": "Build the Cisco CLI Interface with debug symbols in Docker"
+            "detail": "Build the Docker development environment"
         },
         {
             "label": "clean",
             "type": "shell",
-            "command": "make",
+            "command": "./scripts/dev-setup.sh",
             "args": [
                 "clean"
             ],
@@ -83,7 +80,7 @@
                 "showReuseMessage": true,
                 "clear": false
             },
-            "detail": "Clean build artifacts"
+            "detail": "Clean Docker resources and build artifacts"
         },
         {
             "label": "run-tests",
@@ -104,7 +101,7 @@
             "detail": "Run unit tests in Docker"
         },
         {
-            "label": "docker-shell",
+            "label": "dev-shell",
             "type": "shell",
             "command": "./scripts/dev-setup.sh",
             "args": [

.vscode/tasks.json

@@ -1,22 +1,16 @@
 CC = gcc
-CFLAGS = -Wall -Wextra -std=c99 -g -Iinclude
+CFLAGS = -Wall -Wextra -std=c99 -g -Iinclude -MMD -MP
 LIBS = -lncurses -lpthread
 TARGET = build/cisco-cli-interface
 SOURCES = src/main.c src/serial.c src/ui.c src/cisco_commands.c src/file_tree.c
 OBJECTS = $(SOURCES:src/%.c=build/%.o)
+DEPENDS = $(OBJECTS:.o=.d)
 
-# Debug and Release configurations
-DEBUG_CFLAGS = -Wall -Wextra -std=c99 -g -O0 -DDEBUG -Iinclude
-RELEASE_CFLAGS = -Wall -Wextra -std=c99 -O2 -DNDEBUG -Iinclude
+.PHONY: all clean release install-deps help
 
-.PHONY: all clean debug release
+all: $(TARGET)
 
-all: debug
-
-debug: CFLAGS = $(DEBUG_CFLAGS)
-debug: $(TARGET)
-
-release: CFLAGS = $(RELEASE_CFLAGS)
+release: CFLAGS = -Wall -Wextra -std=c99 -O2 -DNDEBUG -Iinclude -MMD -MP
 release: $(TARGET)
 
 $(TARGET): $(OBJECTS)
@@ -27,9 +21,20 @@ build/%.o: src/%.c
 	$(CC) $(CFLAGS) -c $< -o $@
 
 clean:
-	rm -f $(OBJECTS) $(TARGET)
+	rm -f $(OBJECTS) $(TARGET) $(DEPENDS)
 	rm -rf build
 
 install-deps:
 	sudo apt-get update
-	sudo apt-get install -y libncurses5-dev libncursesw5-dev
+	sudo apt-get install -y libncurses5-dev libncursesw5-dev build-essential
+
+help:
+	@echo "Available targets:"
+	@echo "  all         - Build debug version (default)"
+	@echo "  release     - Build optimized release version"
+	@echo "  clean       - Remove build artifacts"
+	@echo "  install-deps- Install system dependencies"
+	@echo "  help        - Show this help"
+
+# Include dependency files
+-include $(DEPENDS)