[Refactor] Refactor syntax highlighting logic to copy and fetch config file to and from /.config directory in user file system

Author: chrisdedman

include/SyntaxManager.h

@@ -28,6 +28,7 @@ class SyntaxManager
      * @return A unique pointer to the appropriate syntax highlighter, or nullptr if not available.
      */
     static std::unique_ptr<QSyntaxHighlighter> createSyntaxHighlighter(const QString &extension, QTextDocument *doc);
+    static void initializeUserSyntaxConfig();
 
 private:
     static std::unique_ptr<QSyntaxHighlighter> createHighlighter(QTextDocument *doc, const std::vector<YAML::Node> &config, const QString &extension);

src/SyntaxManager.cpp

@@ -5,44 +5,90 @@
 #include <QFile>
 #include <QDebug>
 
-std::unique_ptr<QSyntaxHighlighter> SyntaxManager::createSyntaxHighlighter(const QString &extension, QTextDocument *doc)
+void SyntaxManager::initializeUserSyntaxConfig()
 {
-    QString configPath = qgetenv("CONFIG_DIR");
-    if (configPath.isEmpty())
+    QString userSyntaxDir = QDir::homePath() + "/.config/codeastra/syntax";
+    QDir dir(userSyntaxDir);
+
+    if (!dir.exists())
     {
-        configPath = "config";
-    }
+        qDebug() << "[Setup] First run detected. Creating syntax config directory:" << userSyntaxDir;
+
+        if (!dir.mkpath("."))
+        {
+            qWarning() << "[Setup] Failed to create user syntax config directory:" << userSyntaxDir;
+            return;
+        }
+
+        // List of default syntax files to copy
+        QDir defaultDir(":/resources/syntax/");
+        QStringList defaultSyntaxFiles = defaultDir.entryList({"*.yaml", "*.yml"}, QDir::Files);
 
-    QDir syntaxDir(configPath);
+        for (const QString &fileName : defaultSyntaxFiles)
+        {
+            QString resourcePath = ":/resources/syntax/" + fileName;
+            QString destPath     = userSyntaxDir + "/" + fileName;
+
+            QFile resFile(resourcePath);
+            if (resFile.copy(destPath))
+            {
+                qDebug() << "[Setup] Copied default config:" << fileName;
+            }
+            else
+            {
+                qWarning() << "[Setup] Failed to copy:" << resourcePath << "to" << destPath;
+            }
+        }
+    }
+    else
+    {
+        qDebug() << "[Setup] User syntax directory already exists. Skipping first-run config.";
+    }
+}
 
-    QStringList yamlFiles = syntaxDir.entryList({"*.yaml", "*.yml"}, QDir::Files);
-    qDebug() << "Directory being scanned: " << syntaxDir.absolutePath();
+std::unique_ptr<QSyntaxHighlighter> SyntaxManager::createSyntaxHighlighter(const QString &extension, QTextDocument *doc)
+{
+    QString baseDir;
 
-    if (syntaxDir.exists())
+    if (qEnvironmentVariableIsSet("CONFIG_DIR"))
     {
-        qDebug() << "Directory exists.";
+        baseDir = qEnvironmentVariable("CONFIG_DIR");
     }
     else
     {
-        qDebug() << "Directory does not exist.";
+        QString userSyntaxDir = QDir::homePath() + "/.config/codeastra/syntax";
+        if (QDir(userSyntaxDir).exists())
+        {
+            baseDir = userSyntaxDir;
+        }
+        else
+        {
+            baseDir = "config";
+        }
     }
 
+//     qDebug() << "[SyntaxManager] Using config directory:" << baseDir;
+
+    QDir syntaxDir(baseDir);
+    QStringList yamlFilePath = syntaxDir.entryList({"*.yaml", "*.yml"}, QDir::Files);
+
     std::vector<YAML::Node> config;
     // Iterate over all YAML files and store their contents as separate nodes
-    for (const QString &fileName : yamlFiles)
+    for (const QString &fileName : yamlFilePath)
     {
         QFile file(syntaxDir.filePath(fileName));
         if (file.open(QIODevice::ReadOnly | QIODevice::Text))
         {
             YAML::Node fileConfig = YAML::Load(file.readAll().toStdString());
             file.close();
-            qDebug() << "Loaded YAML from: " << file.fileName();
+            // qDebug() << "[SyntaxManager] Loaded config for extension:" << extension << "from:" << file.fileName();
 
             config.push_back(fileConfig);
         }
         else
         {
-            qDebug() << "Failed to open file: " << file.fileName();
+            qWarning() << "[SyntaxManager] Failed to open syntax config for extension:" << extension << "at:" << yamlFilePath;
+            return nullptr;
         }
     }
 
@@ -51,7 +97,7 @@ std::unique_ptr<QSyntaxHighlighter> SyntaxManager::createSyntaxHighlighter(const
 
 std::unique_ptr<QSyntaxHighlighter> SyntaxManager::createHighlighter(QTextDocument *doc, const std::vector<YAML::Node> &config, const QString &extension)
 {
-    qDebug() << "Creating highlighter for extension:" << extension;
+    // qDebug() << "[SyntaxManager] Creating highlighter for extension:" << extension;
     for (const auto &node : config)
     {
         if (node["extensions"])

src/main.cpp

@@ -1,4 +1,5 @@
 #include "MainWindow.h"
+#include "SyntaxManager.h"
 
 #include <QApplication>
 #include <QMainWindow>
@@ -34,6 +35,7 @@ QIcon createRoundIcon(const QString &iconPath)
 
 QFont setFont()
 {
+	SyntaxManager::initializeUserSyntaxConfig();
     QStringList preferreFontFamilies = {"Monaco", "Menlo", "Consolas", "Courier New", "Monospace"};
     QStringList availableFamilies    = QFontDatabase::families();