Implement help text

Author: htmlboss

src/CLIOptions.cpp

@@ -1,4 +1,5 @@
 #include "CLIOptions.hpp"
+#include "Utils/PrettyPrint.hpp"
 
 #include <iostream>
 
@@ -11,20 +12,27 @@ namespace tsm::cli {
     {
         cxxopts::Options options("NetCDF Timestamp Mapper", "Maps timestamps and variables to netCDF files using sqlite3.");
 
-        options.add_options()
-        ("i,input-dir", "Input directory.", cxxopts::value<std::string>())
-        ("n,dataset-name", "Dataset name (no spaces).", cxxopts::value<std::string>())
-        ("o,output-dir", "Output directory.", cxxopts::value<std::string>())
+        options.allow_unrecognised_options().add_options()
+        ("i,input-dir", "Input directory of netcdf files to scan.", cxxopts::value<std::string>())
+        ("n,dataset-name", "Dataset name (no spaces). Will also become the filename of the resulting database (with the .sqlite3 extension).", cxxopts::value<std::string>())
+        ("o,output-dir", "Output directory of the resulting database file. Make sure the user running the process has write priveleges to this folder!", cxxopts::value<std::string>())
         ("regen-indices", "Regenerate indices.", cxxopts::value<bool>())
-        ("f,forecast", "Forecast dataset type.", cxxopts::value<bool>())
-        ("h,historical", "Historical dataset type.", cxxopts::value<bool>())
-        ("r,regex", "Regex to apply to input directory.", cxxopts::value<std::string>())
-        ("file-list", "Path to text file containing absolute file paths of netcdf files to be indexed.", cxxopts::value<std::string>())
-        ("dry-run", "Dry run", cxxopts::value<bool>())
+        ("f,forecast", "Forecast dataset type. INACTIVE AT THIS TIME.", cxxopts::value<bool>())
+        ("h,historical", "Indicates the dataset is historical in nature (i.e. not a forecast). In the future, there will be a -f flag to denote forecasts.", cxxopts::value<bool>())
+        ("r,regex", "Apply a regex pattern to the input directory to filter the scanned netcdf files.", cxxopts::value<std::string>())
+        ("file-list", "File containing absolute paths to netcdf files to be indexed. The format is 1 path per line (no line-ending commas, etc). Supported file extensions are: .txt, .diff, .ll.", cxxopts::value<std::string>())
+        ("dry-run", "Perform a dry-run of the tool; the list of scanned netcdf files will be output to the screen. No database changes will be made.", cxxopts::value<bool>())
         ("help", "Print help.")
         ;
 
-        return std::make_optional(options.parse(argc, argv));
+        auto result{ options.parse(argc, argv) };
+
+        if (result.count("help")) {
+            std::cout << options.help({""}) << std::endl;
+            return std::nullopt;
+        }
+
+        return std::make_optional(result);
     }
     catch (const cxxopts::OptionException &e)
     {
@@ -38,11 +46,6 @@ namespace tsm::cli {
     }
 }
 
-/***********************************************************************************/
-void printHelp() {
-
-}
-
 /***********************************************************************************/
 std::string cleanRegexPattern(const std::string& inputPattern) {
     std::string cleaned = inputPattern;

src/CLIOptions.hpp

@@ -11,17 +11,13 @@ namespace tsm::cli {
 ///
 [[nodiscard]] std::optional<cxxopts::ParseResult> parseCmdLineOptions(int argc, char** argv);
 
-/***********************************************************************************/
-/// Print help message.
-void printHelp();
-
 /***********************************************************************************/
 std::string cleanRegexPattern(const std::string& inputPattern);
 
 /***********************************************************************************/
 struct [[nodiscard]] CLIOptions {
-    explicit CLIOptions(const cxxopts::ParseResult& result) :   InputDir{ result["input-dir"].as<std::string>() },
-                                                                DatasetName{ result["dataset-name"].as<std::string>() },
+    explicit CLIOptions(const cxxopts::ParseResult& result) :   InputDir{ result.count("input-dir") > 0 ? result["input-dir"].as<std::string>() : "" },
+                                                                DatasetName{ result.count("dataset-name") > 0 ? result["dataset-name"].as<std::string>() : "" },
                                                                 OutputDir{ result["output-dir"].as<std::string>() },
                                                                 RegexPattern{ result.count("regex") > 0 ? cleanRegexPattern(result["regex"].as<std::string>()) : ".*" },
                                                                 FileListPath{ result.count("file-list") > 0 ? result["file-list"].as<std::string>() : ""},

src/Utils/PrettyPrint.hpp

@@ -0,0 +1,15 @@
+#pragma once
+
+#include <ostream>
+
+namespace tsm::utils {
+
+std::ostream& bold_on(std::ostream& os) {
+    return os << "\e[1m";
+}
+
+std::ostream& bold_off(std::ostream& os) {
+    return os << "\e[0m";
+}
+
+} //namespace tsm::utils

src/main.cpp

@@ -7,16 +7,11 @@ int main(int argc, char** argv) {
 
     std::iostream::sync_with_stdio(false);
 
-    const auto& result{ tsm::cli::parseCmdLineOptions(argc, argv) };
+    auto result{ tsm::cli::parseCmdLineOptions(argc, argv) };
     if (!result) {
         return EXIT_FAILURE;
     }
 
-    if ((*result).count("help")) {
-        tsm::cli::printHelp();
-        return 0;
-    }
-
     const tsm::cli::CLIOptions opts{ *result };
     if (!opts.verify()) {
         return EXIT_FAILURE;