Improve documentation of SinkSH

Summary:
- Add support for positional arguments, options, flags in the syntax tree
- Add automatic generation of usage string

TODO:

- ~~Better document the `--reduce` option in the `list` command~~
- Get the parent command for sub-commands so we could show help for `trace on` and not just `on`
- Pass the syntax to the implementation of the command so commands can easily show help on wrong usage. Also, SyntaxTree could do automatic input validation in the future, this could also help.
- Even with the new documentation, some command could still be confusing. Should we add some usage examples?

Reviewers: cmollekopf

Reviewed By: cmollekopf

Tags: #sink

Differential Revision: https://phabricator.kde.org/D14547

1 files changed, 9 insertions, 2 deletions

diff --git a/sinksh/syntax_modules/sink_stat.cpp b/sinksh/syntax_modules/sink_stat.cpp
index 7263941..a936af2 100644
--- a/sinksh/syntax_modules/sink_stat.cpp
+++ b/sinksh/syntax_modules/sink_stat.cpp
@@ -69,7 +69,6 @@ void statResource(const QString &resource, const State &state)
     state.printLine(QObject::tr("Actual database file sizes total: %1 [kb]").arg(size), 1);
 
     QDir dataDir{Sink::resourceStorageLocation(resource.toLatin1()) + "/fulltext/"};
-    Q_ASSERT(dataDir.exists());
     qint64 dataSize = 0;
     for (const auto &e : dataDir.entryInfoList(QDir::Files | QDir::NoSymLinks | QDir::NoDotAndDotDot)) {
         dataSize += e.size();
@@ -102,7 +101,15 @@ bool stat(const QStringList &args, State &state)
 
 Syntax::List syntax()
 {
-    Syntax state("stat", QObject::tr("Shows database usage for the resources requested"), &SinkStat::stat, Syntax::NotInteractive);
+    Syntax state("stat", QObject::tr("Shows database usage for the resources requested"),
+        &SinkStat::stat, Syntax::NotInteractive);
+
+    state.addPositionalArgument({ .name = "resourceId",
+        .help = "Show statistics of the given resource(s). If no resource is provided, show "
+                "statistics of all resources",
+        .required = false,
+        .variadic = true });
+
     state.completer = &SinkshUtils::resourceCompleter;
 
     return Syntax::List() << state;