added CLI option --buildinfo (#188)

Author: Gemba

.github/ISSUE_TEMPLATE/bug_report.md

@@ -32,10 +32,13 @@ Please remove the text down to this point before proceeding.
 [Replace this text with any useful Skyscraper terminal output that might help clarify your issue. For longer output use pastebin.com, ix.io or similiar.]
 
 **Technical information**
- - Skyscraper version: [Replace with the Skyscraper version you are running, e.g. 3.9.1]
- - Configuration switches applied (config.ini, commandline, ...)
+ - Configuration switches applied to Skyscraper (config.ini, commandline, ...)
  - Internet connection: [Replace with the type of internet you have, e.g. adsl, wifi, dialup, if your issue is scraper related]
- - OS and Version [Replace with the OS/stack and version you are running, e.g. RetroPie 4.8.5, 23.10.1, ...]
+ - _Note_: For the next two items you may provide the output of `Skyscraper --buildinfo`
+   (from v3.18 onwards) and add the RetroPie version if it is not printed with
+   this command.
+   - Skyscraper version: [Replace with the Skyscraper version you are running, e.g. 3.9.1]
+   - OS and Version [Replace with the OS/stack and version you are running, e.g. RetroPie 4.8.5, 23.10.1, ...]
 
 **Additional context**
 [Replace this text with any additional context that might help understand this issue better. Optional.]

docs/CHANGELOG.md

@@ -17,6 +17,8 @@ humans](https://keepachangelog.com).
   `'*.ext'` also allow `'.ext'` and `'ext'`
 - Added: Accept also singular for media flags, e.g. `--flags video` additionally
   to `--flags videos`. However, in the config file accept only plural as before.
+- Added: Flag [`--buildinfo`](CLIHELP.md#--buildinfo), comes in handy when
+  reporting an issue.
 - Updated: macOS installation instructions to use Qt6
 - Updated: Docker uses Ubuntu 24.04 and Qt6
 - Updated: Documentation, added usage level for configuration options. See

docs/CLIHELP.md

@@ -230,6 +230,10 @@ Skyscraper -p snes -s thegamesdb --addext '*.ext1 *.ext2'
 Skyscraper -p snes -s thegamesdb --addext '.ext1 ext2'
 ```
 
+### --buildinfo
+
+Show the build configuration and runtime environment of Skyscraper and exits. Use this info when reporting an issue. Thanks!
+
 ### --cache <COMMAND[:OPTIONS]>
 
 This is the cache master option. It contains several subcommands that allows you to manipulate the cached data for the selected platform.

src/cli.cpp

@@ -30,6 +30,7 @@
 #include <QRandomGenerator>
 #include <QRegularExpression>
 #include <QStringBuilder>
+#include <QSysInfo>
 
 void Cli::createParser(QCommandLineParser *parser, QString platforms) {
 
@@ -239,9 +240,13 @@ void Cli::createParser(QCommandLineParser *parser, QString platforms) {
         "verbosity", "Print more info while scraping. Default: 0", "0-3", "0");
     QCommandLineOption hintOption("hint",
                                   "Show a random 'Tip of the Day' and quit.");
+    QCommandLineOption buildinfoOption("buildinfo",
+                                       "Show Skyscraper's build information "
+                                       "(for reporting an issue) and quit.");
 
     parser->addOption(addextOption);
     parser->addOption(aOption);
+    parser->addOption(buildinfoOption);
     parser->addOption(cacheOption);
     parser->addOption(cOption);
     parser->addOption(dOption);
@@ -538,3 +543,24 @@ void Cli::showHint() {
 
     printf("%s\n\n", hintWrapped.join("\n").toStdString().c_str());
 }
+
+void Cli::showBuildinfo() {
+    QStringList info;
+    QString skyVer = "Skyscraper:       " VERSION;
+#ifdef QT_DEBUG
+    skyVer = skyVer % " (Debug)";
+#endif
+    info.append(skyVer);
+    info.append("Qt:               " % QString::number(QT_VERSION_MAJOR) % "." %
+                QString::number(QT_VERSION_MINOR) % "." %
+                QString::number(QT_VERSION_PATCH));
+    info.append("Architecture:     " % QSysInfo::currentCpuArchitecture());
+    info.append("Kernel:           " % QSysInfo::kernelType() % " " %
+                QSysInfo::kernelVersion());
+    info.append("Operating System: " % QSysInfo::prettyProductName());
+    QString rpVer = Config::getRetropieVersion();
+    if (!rpVer.isEmpty()) {
+        info.append("RetroPie:         " % rpVer);
+    }
+    printf("%s\n", info.join("\n").toStdString().c_str());
+}

src/cli.h

@@ -29,6 +29,7 @@ namespace Cli {
     QMap<QString, QString> getSubCommandOpts(const QString subCmd);
     void cacheReportMissingUsage();
     void showHint();
+    void showBuildinfo();
 } // namespace Cli
 
 #endif // CLI_H

src/settings.cpp

@@ -76,7 +76,8 @@ void RuntimeCfg::applyConfigIni(CfgType type, QSettings *settings,
             bool isFlagsOK =
                 parser->isSet("flags") && parseFlags().contains("help");
 
-            if (!isCacheOK && !isFlagsOK && !parser->isSet("hint")) {
+            if (!isCacheOK && !isFlagsOK && !parser->isSet("hint") &&
+                !parser->isSet("buildinfo")) {
                 reportInvalidPlatform();
                 exit(1);
             }
@@ -621,6 +622,10 @@ void RuntimeCfg::applyCli(bool &inputFolderSet, bool &gameListFolderSet,
     if (parser->isSet("refresh")) {
         config->refresh = true;
     }
+    if (parser->isSet("buildinfo")) {
+        Cli::showBuildinfo();
+        exit(0);
+    }
     if (parser->isSet("hint")) {
         Cli::showHint();
         exit(0);
@@ -786,12 +791,12 @@ QStringList RuntimeCfg::parseFlags() {
                                "skipexistingmanual",
                                "fanart",
                                "video",
-                               "manual"};
+                               "manual",
+                               "miximage"};
         for (QString f : _flags) {
             retFlags << (plFlags.contains(f) ? f % "s" : f);
         }
     }
-    qDebug() << "Flags:" << retFlags;
     return retFlags;
 }