Add descriptions to logs and reload commands (#69)

companieshouse · Jul 29, 2024 · 2fd8795 · 2fd8795
1 parent 48c1f8d
commit 2fd8795
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -207,6 +207,8 @@ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomp
 
 ## `chs-dev compose-logs [SERVICENAME]`
 
+Outputs the logs for services and compose logs (i.e. logs from 'up' and 'down' commands)
+
 ```
 USAGE
   $ chs-dev compose-logs [SERVICENAME...] [-C] [-f] [-n <value>]
@@ -219,6 +221,9 @@ FLAGS
   -f, --follow        Follow the logs
   -n, --tail=<value>  [default: all] Number of lines from the end of the logs
 
+DESCRIPTION
+  Outputs the logs for services and compose logs (i.e. logs from 'up' and 'down' commands)
+
 ALIASES
   $ chs-dev service-logs
   $ chs-dev compose-logs
@@ -393,6 +398,8 @@ ALIASES
 
 ## `chs-dev logs [SERVICENAME]`
 
+Outputs the logs for services and compose logs (i.e. logs from 'up' and 'down' commands)
+
 ```
 USAGE
   $ chs-dev logs [SERVICENAME...] [-C] [-f] [-n <value>]
@@ -405,6 +412,9 @@ FLAGS
   -f, --follow        Follow the logs
   -n, --tail=<value>  [default: all] Number of lines from the end of the logs
 
+DESCRIPTION
+  Outputs the logs for services and compose logs (i.e. logs from 'up' and 'down' commands)
+
 ALIASES
   $ chs-dev service-logs
   $ chs-dev compose-logs
@@ -457,16 +467,23 @@ DESCRIPTION
 
 ## `chs-dev reload SERVICE`
 
+Rebuilds and restarts the supplied service running in development mode to load in any changes to source code
+
 ```
 USAGE
   $ chs-dev reload SERVICE
 
 ARGUMENTS
   SERVICE  Name of the service
+
+DESCRIPTION
+  Rebuilds and restarts the supplied service running in development mode to load in any changes to source code
 ```
 
 ## `chs-dev service-logs [SERVICENAME]`
 
+Outputs the logs for services and compose logs (i.e. logs from 'up' and 'down' commands)
+
 ```
 USAGE
   $ chs-dev service-logs [SERVICENAME...] [-C] [-f] [-n <value>]
@@ -479,6 +496,9 @@ FLAGS
   -f, --follow        Follow the logs
   -n, --tail=<value>  [default: all] Number of lines from the end of the logs
 
+DESCRIPTION
+  Outputs the logs for services and compose logs (i.e. logs from 'up' and 'down' commands)
+
 ALIASES
   $ chs-dev service-logs
   $ chs-dev compose-logs

diff --git a/src/commands/logs.ts b/src/commands/logs.ts
@@ -4,6 +4,8 @@ import configLoader from "../helpers/config-loader.js";
 import { ComposeLogViewer } from "../run/compose-log-viewer.js";
 
 export default class Logs extends Command {
+    static description = "Outputs the logs for services and compose logs (i.e. logs from 'up' and 'down' commands)";
+
     static aliases: string[] = ["service-logs", "compose-logs"];
 
     /**

diff --git a/src/commands/reload.ts b/src/commands/reload.ts
@@ -6,6 +6,9 @@ import { DependencyCache } from "../run/dependency-cache.js";
 
 export default class Reload extends Command {
 
+    static description = "Rebuilds and restarts the supplied service running " +
+        "in development mode to load in any changes to source code";
+
     static args = {
         service: Args.string({
             required: true,