Updated docs

2023-02-20 15:55:20 +01:00
parent 48d0daabf5
commit 9e28dce5ce
632 changed files with 10917 additions and 6775 deletions
--- a/docs/source/cpl_cli.generate.md
+++ b/docs/source/cpl_cli.generate.md
@@ -0,0 +1,43 @@
+# cpl generate
+
+## Contents
+
+- [Description](#description)
+- [Arguments](#arguments)
+- [Schematics](#schematics)
+
+Generate a file based on schematic.
+
+cpl **generate** *&lt;schematic&gt;* *&lt;name&gt;* <br>
+cpl **g** *&lt;schematic&gt;* *&lt;name&gt;* <br>
+cpl **G** *&lt;schematic&gt;* *&lt;name&gt;*
+
+## Description
+
+Generates files based on a schematic.
+
+You can define custom schematics by creating templates in a ```.cpl``` folder.
+
+## Arguments
+
+| Argument          |                                                                             Description                                                                             | Value type    |
+|-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------:|
+| ```<schematic>``` |                                                                     The schematic to generate.                                                                      | ```str```     |
+| ```<name>```      |                                                                   The name of the generated file.                                                                   | ```str```     |
+| ```--base```      | First element of path will be used as base-path not 'src'. For example: 'cpl g c test/Test' will be created at ```src/test/``` with --base it would be ```test/```  | ```str```     |
+
+## Schematics
+
+| Schematic       |              Description               |  Arguments   |
+|-----------------|:--------------------------------------:|:------------:|
+| ```abc```       |          Abstract base class           | ```<name>``` |
+| ```class```     |                 Class                  | ```<name>``` |
+| ```enum```      |               Enum class               | ```<name>``` |
+| ```pipe```      |               Pipe class               | ```<name>``` |
+| ```service```   |             Service class              | ```<name>``` |
+| ```settings```  | [Configmodel](cpl_core.configuration)  | ```<name>``` |
+| ```test```      |               Test class               | ```<name>``` |
+| ```thread```    |              Thread class              | ```<name>``` |
+| ```validator``` |            Validator class             | ```<name>``` |
+| ```command```   |       Discord bot command class        | ```<name>``` |
+| ```event```     |        Discord bot event class         | ```<name>``` |