📝 Add cli documentation

Author: pavelsvagr

lib/cloudrun/CloudRunStarter.js

@@ -162,6 +162,7 @@ export class CloudRunStarter implements Starter {
 
     tb.mkdir(tb.stringToPath(`${tb.destination}/src/view/cli`))
     tb.copyAsset('src/view/cli/cli.ts')
+    tb.copyAsset('src/view/cli/README.md')
     tb.mkdir(tb.stringToPath(`${tb.destination}/src/view/cli/openapi`))
     tb.copyAsset('src/view/cli/openapi/generate.ts')
     tb.npm.iDev('yargs')

lib/cloudrun/CloudRunStarter.js.map

@@ -24,7 +24,7 @@ module.exports = {
       extends: 'plugin:@graphql-eslint/schema-recommended',
       parserOptions: {
         graphQLConfig: {
-          schema: './src/app/api/graphql/schema/*.graphql',
+          schema: './src/view/graphql/schema/*.graphql',
         },
       },
       rules: {

src/cloudrun/CloudRunStarter.ts

@@ -0,0 +1,17 @@
+# CLI
+
+Cli tool to operate scripts that can use internal services or to add development toolkit with the same interface and usage. Currently cli tool is operated using tsx tool.
+
+## 👷 Development
+
+The CLI tool is build around `yargs` library. Each command needs its own `ts` file in current folder or in subfolder. The entrypoint `Cli.ts` scans the sub folders for `ts` files and intrerprets them as a command under the module called same as the folder.
+
+For example, current [openapi folder](./openapi) creates a new module `openapi` and assigns a new command called `generate` based on contents in [generate.ts](./openapi/generate.ts) file.
+
+Each command should export only functions and variables according to `CommandDefinition` in [cli.ts file](./cli.ts).
+
+Take a look at the [generate.ts](./openapi/generate.ts) for example how to implement own command.
+
+## ⚠️ Usage in production scripts
+
+If the cli tool is used to run production scripts (CRON), make sure all dependencies are also listed in production list and build the code instead of using `tsx` (e.g. `yargs`).

starter/cloudrun-graphql/.eslintrc.cjs

@@ -4,10 +4,15 @@ import { readdir, stat } from 'fs/promises'
 import { join, extname } from 'path'
 
 interface CommandDefinition {
+  // Description of the command used for help
   description: string
+  // Defines positional description of the command (e.g. '<filepath>' will mean it takes one positional required argument)
   positional?: string
+  // Function that will be called when the command is executed
   run: (argv: any) => Promise<void> | void
+  // Function that will be called to add options to the command
   options?: (yargs: Argv) => Argv
+  // Any other properties that will be added to the command
   [key: string]: any
 }