Generate config file incase nothing is available

Author: eckon

README.md

@@ -36,28 +36,35 @@ Run the `qc` command. This will open up the interactive TUI (the [config file](#
 
 
 # Setup
-Currently there is no real easy way of installing this tool.
-Appimage might work (on linux) but was not tested.
-General installing and compiling should work.
+Either download the newest [AppImage](#appimage) (see Releases) and run it
+or [compile the repo manually](#general) and run it.
 
 
-## Appimage
+## AppImage
 
-* Download the Appimage
+* Download the Appimage on the Releases page
 * Make it executable `chmod +x <file>`
-  * For systems that can not run it
+  * For systems that can not run it (Windows: WSL)
   * Extract it with `./<file> --appimage-extract`
   * Run the executable in `./squashfs-root/usr/bin/qc`
 * Run it
 
 
 ## General
 
-* Currently there is no pre-compiled binaries (ignoring appimage)
+* Currently there is no pre-compiled binaries (ignoring [appimage](#appimage))
   * To install: have the needed [dependencies](#dependencies) and [compile](#commands) the tool on your machine
+* On first run, the application will create (if not already existing) the following:
+  * Folders for `~/.config/quick-clone/`
+  * Config file `~/.config/quick-clone/config.json`
+  * Add example data to the config file
+    * Only the official gitlab repo works for testing the rest are just example data that will not work
+
+
+## Config
 * Add access token in Gitlab with (at least) API-read permissions
   * Can be found in your personal settings under "Access Tokens"
-* Create config file at `~/.config/quick-clone/config.json` (_names etc. might change_)
+* ~~Create/~~Update config file at `~/.config/quick-clone/config.json` (_names etc. might change_)
   * An array structure is used, for the purpose of having multiple git endpoints
   * Every element is an objcet inside the array `[{...}, {...}, ...]` with the following
     * `name` - Will be shown in the app to identify the selected endpoint

src/data/config.cpp

@@ -22,13 +22,53 @@ ApiConfigCollection::ApiConfigCollection() {
   this->selected = 0;
 }
 
+void ApiConfigCollection::generatePlaceholderConfigFile(std::string path, std::string filename) {
+  std::string createFolder = "mkdir -p " + path;
+  std::system(createFolder.c_str());
+
+  std::string configFilePath = path + "/" + filename;
+  std::ofstream outfile(configFilePath);
+
+  std::string configExampleString =
+    "[\n"
+    "  {\n"
+    "    \"name\": \"Official Gitlab\",\n"
+    "    \"access_token\": \"\",\n"
+    "    \"url\": \"https://gitlab.com/api/v4/projects\"\n"
+    "  },\n"
+    "  {\n"
+    "    \"name\": \"Your Work Repository Manager     (see README for configuration)\",\n"
+    "    \"access_token\": \"replace-with-token-see-README\",\n"
+    "    \"url\": \"https://your-work-endpoint.com/path/to/api\"\n"
+    "  },\n"
+    "  {\n"
+    "    \"name\": \"Your Private Repository Manager  (config at: '" + configFilePath + "')\",\n"
+    "    \"access_token\": \"replace-with-token-see-README\",\n"
+    "    \"url\": \"https://your-private-endpoint.com/path/to/api\"\n"
+    "  }\n"
+    "]";
+
+  outfile << configExampleString << std::endl;
+  outfile.close();
+}
+
 void ApiConfigCollection::init() {
   std::string homeDir = std::getenv("HOME");
-  std::string configDir = homeDir + "/.config/quick-clone/config.json";
-  std::ifstream file(configDir);
+  std::string configDir = homeDir + "/.config/quick-clone";
+  std::string configFileName = "config.json";
+  std::string configFilePath = configDir + "/" + configFileName;
+  std::ifstream file;
+  file.open(configFilePath);
 
   // user could have forgotten the config file
-  if (!file) throw std::string("Config file is missing: \"" + configDir + "\"");
+  // generate a basic one so that it at least shows the working app
+  if (!file) {
+    file.close();
+    this->generatePlaceholderConfigFile(configDir, configFileName);
+
+    // reload the file
+    file.open(configFilePath);
+  }
 
   // build array of missing config parts, to display to the user
   std::vector<std::string> errorList;

src/data/config.h

@@ -22,6 +22,7 @@ class ApiConfigCollection {
   ApiConfigCollection();
 
   void init();
+  void generatePlaceholderConfigFile(std::string path, std::string filename);
 };
 
 #endif