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, 8 insertions, 2 deletions

diff --git a/sinksh/syntax_modules/sink_count.cpp b/sinksh/syntax_modules/sink_count.cpp
index 04a9550..1edf1c2 100644
--- a/sinksh/syntax_modules/sink_count.cpp
+++ b/sinksh/syntax_modules/sink_count.cpp
@@ -37,12 +37,14 @@
 namespace SinkCount
 {
 
+Syntax::List syntax();
+
 bool count(const QStringList &args, State &state)
 {
     Sink::Query query;
     query.setId("count");
     if (!SinkshUtils::applyFilter(query, SyntaxTree::parseOptions(args))) {
-        state.printError(QObject::tr("Options: $type $filter"));
+        state.printError(syntax()[0].usage());
         return false;
     }
 
@@ -63,7 +65,11 @@ bool count(const QStringList &args, State &state)
 
 Syntax::List syntax()
 {
-    Syntax count("count", QObject::tr("Returns the number of items of a given type in a resource. Usage: count <type> <resource>"), &SinkCount::count, Syntax::EventDriven);
+    Syntax count("count", QObject::tr("Returns the number of items of a given type in a resource"), &SinkCount::count, Syntax::EventDriven);
+
+    count.addPositionalArgument({.name = "type", .help = "The entity type to count"});
+    count.addPositionalArgument({.name = "resource", .help = "A resource id where to count", .required = false});
+
     count.completer = &SinkshUtils::typeCompleter;
 
     return Syntax::List() << count;