Merge branch 'feature/synchronizeDocumentation' of https://github.com/MarcelDiessner/tutorial-compiler into feature/synchronizeDocumentation

MarcelDiessner · MarcelDiessner · commit b70a45658cbb · 2021-06-02T13:52:23.000+02:00
diff --git a/engine/runner.ts b/engine/runner.ts
@@ -11,8 +11,8 @@ export abstract class Runner {
     public playbookPath: string;
     public playbookTitle: string;
     public environmentName: string;
-    protected readonly useDevonCommand: string = "useDevonCommand";
-    protected readonly workspaceDirectory: string = "workspaceDirectory";
+    protected readonly USE_DEVON_COMMAND: string = "useDevonCommand";
+    protected readonly WORKSPACE_DIRECTORY: string = "workspaceDirectory";
 
     private setVariableCallback: (name: string, value: any) => any;
     registerSetVariableCallback(callback: (name: string, value: any) => any) {
@@ -83,7 +83,7 @@ export abstract class Runner {
     }
 
     init(playbook: Playbook): void {
-        this.setVariable(this.useDevonCommand, false);
+        this.setVariable(this.USE_DEVON_COMMAND, false);
     }
 
     run(runCommand: RunCommand): RunResult {
diff --git a/engine/wikiRunner.ts b/engine/wikiRunner.ts
@@ -7,11 +7,13 @@ import * as ejs from "ejs";
 export abstract class WikiRunner extends Runner {
 
     public outputPathTutorial: string;
+    protected readonly INSTALLED_TOOLS: string = "installedTools";
 
     init(playbook: Playbook): void {
         let outputDirectory = this.createFolder(path.join(this.getOutputDirectory(), "wiki", this.environmentName), false)
         this.outputPathTutorial = this.createFolder(path.join(outputDirectory, playbook.name), true);
-        this.setVariable(this.workspaceDirectory, path.join(this.getWorkingDirectory()));
+        this.setVariable(this.WORKSPACE_DIRECTORY, path.join(this.getWorkingDirectory()));
+        this.setVariable(this.INSTALLED_TOOLS, "");
     }
 
     async destroy(playbook: Playbook): Promise<void> {
diff --git a/runners/console/index.ts b/runners/console/index.ts
diff --git a/runners/katacoda/index.ts b/runners/katacoda/index.ts
diff --git a/runners/vscode/index.ts b/runners/vscode/index.ts
@@ -68,7 +68,7 @@ export class VsCode extends Runner {
         let result = new RunResult();
         result.returnCode = 0;
 
-        let filepath = path.join(this.getVariable(this.workspaceDirectory), runCommand.command.parameters[0]);
+        let filepath = path.join(this.getVariable(this.WORKSPACE_DIRECTORY), runCommand.command.parameters[0]);
         let directoryPath = path.dirname(filepath).replace(/\\/g, "\\\\").replace(/\//g, "//");
         let directoryName = filepath.split(path.sep)[filepath.split(path.sep).length - 2];
         let testfile = path.join(this.getWorkingDirectory(), "vscode_tests", "runCobiGenJava.js");
diff --git a/runners/wikiConsole/index.ts b/runners/wikiConsole/index.ts
@@ -3,13 +3,14 @@ import { RunCommand } from "../../engine/run_command";
 import { RunResult } from "../../engine/run_result";
 import { WikiRunner } from "../../engine/wikiRunner";
 import * as path from "path";
+import * as fs from 'fs';
 
 export class WikiConsole extends WikiRunner {
 
     init(playbook: Playbook): void {
         super.init(playbook);
+        this.setVariable(this.WORKSPACE_DIRECTORY, path.join(this.getWorkingDirectory()));
         this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "intro.asciidoc"), {name: playbook.name, title: playbook.title, subtitle: playbook.subtitle, description: playbook.description});
-        this.setVariable(this.workspaceDirectory, path.join(this.getWorkingDirectory()));
     }
 
     async destroy(playbook: Playbook): Promise<void> {
@@ -26,7 +27,8 @@ export class WikiConsole extends WikiRunner {
             version = runCommand.command.parameters[1];
         }
         this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "installDevonfwIde.asciidoc"), { tools: tools, version:version })
-        this.setVariable(this.workspaceDirectory, path.join(this.getWorkingDirectory(), "devonfw", "workspaces", "main"));
+        this.setVariable(this.WORKSPACE_DIRECTORY, path.join(this.getWorkingDirectory(), "devonfw", "workspaces", "main"));
+        this.setVariable(this.INSTALLED_TOOLS, tools);
         return null;
     }
 
@@ -35,7 +37,7 @@ export class WikiConsole extends WikiRunner {
     }
 
     runChangeFile(runCommand: RunCommand): RunResult{
-            let workspacePath = this.getVariable(this.workspaceDirectory).replace(/\\/g, "/");
+            let workspacePath = this.getVariable(this.WORKSPACE_DIRECTORY).replace(/\\/g, "/");
             let filePath = path.join(workspacePath,runCommand.command.parameters[0]);
             let fileName = path.basename(runCommand.command.parameters[0]); 
             let contentPath, contentString;
@@ -62,13 +64,13 @@ export class WikiConsole extends WikiRunner {
 
 
     runRunServerJava(runCommand: RunCommand): RunResult {
-        let server_path = path.join(this.getVariable(this.workspaceDirectory), runCommand.command.parameters[0]);
+        let server_path = path.join(this.getVariable(this.WORKSPACE_DIRECTORY), runCommand.command.parameters[0]);
         this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "runServerJava.asciidoc"), { server_path: server_path, port: runCommand.command.parameters[1].port, app_path: runCommand.command.parameters[1].path })
         return null;
     }
 
     runNpmInstall(runCommand: RunCommand): RunResult {
-        let projectPath = path.join(this.getVariable(this.workspaceDirectory), runCommand.command.parameters[0]);
+        let projectPath = path.join(this.getVariable(this.WORKSPACE_DIRECTORY), runCommand.command.parameters[0]);
         let npmCommand = {
             "name": (runCommand.command.parameters.length > 1 && runCommand.command.parameters[1].name) ? runCommand.command.parameters[1].name : undefined,
             "global": (runCommand.command.parameters.length > 1 && runCommand.command.parameters[1].global) ? runCommand.command.parameters[1].global : false, 
@@ -80,7 +82,7 @@ export class WikiConsole extends WikiRunner {
     }
   
     runCloneRepository(runCommand: RunCommand): RunResult {
-        let directoryPath = path.join(this.getVariable(this.workspaceDirectory), runCommand.command.parameters[0]);
+        let directoryPath = path.join(this.getVariable(this.WORKSPACE_DIRECTORY), runCommand.command.parameters[0]);
         this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "cloneRepository.asciidoc"), { directoryPath: directoryPath, url: runCommand.command.parameters[1] });
         return null;
     }
@@ -95,7 +97,7 @@ export class WikiConsole extends WikiRunner {
     }
       
     runBuildNg(runCommand: RunCommand): RunResult {
-        let angularPath = path.join(this.getVariable(this.workspaceDirectory), runCommand.command.parameters[0]);
+        let angularPath = path.join(this.getVariable(this.WORKSPACE_DIRECTORY), runCommand.command.parameters[0]);
         let outputPath = runCommand.command.parameters.length < 1 ? runCommand.command.parameters[1] : "";
         this.renderWiki(path.join(this.getRunnerDirectory(), "template", "buildNg.asciidoc"), {angularPath: angularPath, outputPath: outputPath});
       
@@ -110,21 +112,55 @@ export class WikiConsole extends WikiRunner {
     }
   
     runCreateFolder(runCommand: RunCommand): RunResult {
-        let folderPath = path.join(this.getVariable(this.workspaceDirectory), runCommand.command.parameters[0]);
+        let folderPath = path.join(this.getVariable(this.WORKSPACE_DIRECTORY), runCommand.command.parameters[0]);
         this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "createFolder.asciidoc"), { folderPath: folderPath });
         return null;
     }
 
     runBuildJava(runCommand: RunCommand): RunResult {
-        let directoryPath = path.join(this.getVariable(this.workspaceDirectory), runCommand.command.parameters[0]);
+        let directoryPath = path.join(this.getVariable(this.WORKSPACE_DIRECTORY), runCommand.command.parameters[0]);
         let skipTest = (runCommand.command.parameters.length == 2 && runCommand.command.parameters[1] == true) ? false : true;
         this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "buildJava.asciidoc"), { directoryPath: directoryPath, skipTest: skipTest });
         return null;
     }
 
+    runInstallCobiGen(runCommand: RunCommand): RunResult{
+        let devonPath = path.relative(this.getWorkingDirectory(), this.getVariable(this.WORKSPACE_DIRECTORY)).replace(/\\/g, "/");;
+        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "installCobiGen.asciidoc"), {devonPath: devonPath});
+        return null;
+    }
+
     runCreateDevon4jProject(runCommand: RunCommand): RunResult {
         this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "createDevon4jProject.asciidoc"), { name: runCommand.command.parameters[0] });
         return null;
     }
+
+    runAdaptTemplatesCobiGen(runComannd: RunCommand): RunResult{
+        let devonPath = path.relative(this.getWorkingDirectory(), this.getVariable(this.WORKSPACE_DIRECTORY)).replace(/\\/g, "/");
+        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "adaptTemplates.asciidoc"), {devonPath: devonPath});
+              return null;
+    }
+
+    runNextKatacodaStep(runCommand: RunCommand): RunResult {
+        let tempFile = path.join(this.getTempDirectory(), runCommand.command.name + ".md");
+        fs.writeFileSync(tempFile, "");
+        for(let i = 0; i < runCommand.command.parameters[1].length; i++) {
+            let param = runCommand.command.parameters[1][i];
+            if(param.content) {
+                fs.appendFileSync(tempFile, param.content);
+            } else if(param.file) {
+                fs.appendFileSync(tempFile, fs.readFileSync(path.join(this.playbookPath, param.file), "utf-8"));
+            } else if (param.image) {
+                let image = path.join(this.playbookPath, param.image);
+                fs.appendFileSync(tempFile, "![" + path.basename(image) + "](./assets/" + path.basename(image) + ")");
+            }
+            fs.appendFileSync(tempFile, "\n\n");
+        }
+
+        let content = fs.readFileSync(tempFile, "utf-8");
+        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "nextKatacodaStep.asciidoc"), { title: runCommand.command.parameters[0], content: content, path: runCommand.command.parameters[2]});
+
+        return null;
+    }
 }
 
diff --git a/runners/wikiConsole/templates/adaptTemplates.asciidoc b/runners/wikiConsole/templates/adaptTemplates.asciidoc
@@ -0,0 +1,19 @@
+== Generate CobiGen Templates 
+How to use CobiGen, to generate templates for the following code generation.
+More information about CobiGen on https://devonfw.com/website/pages/docs/master-cobigen.asciidoc.html.
+
+=== Prerequisites
+
+* An installed devonfw distribution is needed. To execute the CobiGen CLI, you have to install the devonfw IDE first. Follow the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html[devonfw IDE] documentation to install the same.
+
+=== Generate CobiGen Templates with CobiGen CLI
+
+First open a command prompt in your current workspace. You should be inside your devonfw directory, if not change your directory to *<%= devonPath;%>*.
+Run the CobiGen command  `devon cobigen adapt-templates`
+to generate a new templates folder next to the CobiGen CLI and save its location in a configuration file.
+
+You can also spezify the location of the templates folder with the parameter `--custom-location` or `-cl` and pass the absolute path to your custom location.
+
+
+
+
diff --git a/runners/wikiConsole/templates/installCobiGen.asciidoc b/runners/wikiConsole/templates/installCobiGen.asciidoc
@@ -0,0 +1,14 @@
+== Install GobiGen
+Installing devonfw code generator (i.e. CobiGen).
+
+=== Prerequisites
+* An installed devonfw distribution is needed. To execute the CobiGen CLI, you have to install the devonfw IDE first. Follow the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html[devonfw-ide] documentation to install the same.
+
+=== Install CobiGen with a command prompt
+
+First, you need to open a command prompt in your current workspace. For Windows, you can use PowerShell and on Linux and macOS, you can use the Terminal.
+Navigate to the devonfw installation directory with this command `cd <%= devonPath;%>`.
+Execute the command `devon cobigen` and CobiGen will be installed.
+To update the environment, you have to execute `devon` and you have successfully installed CobiGen. 
+
+Some further information about the usage of CobiGen can be found https://devonfw.com/website/pages/docs/master-cobigen.asciidoc.html[here]. 
diff --git a/runners/wikiConsole/templates/installDevonfwIde.asciidoc b/runners/wikiConsole/templates/installDevonfwIde.asciidoc
@@ -47,4 +47,5 @@ You can also just execute `.\setup` (Windows) or `bash setup` (Linux) and press
 
 <% if(tools.indexOf("mvn") > 0){ %>
 The installer will also ask you if you want to enter secrets for your maven repository. You can simply skip this by pressing 'Enter'.
-<% } %> 
+<% } %> 
+
diff --git a/runners/wikiConsole/templates/nextKatacodaStep.asciidoc b/runners/wikiConsole/templates/nextKatacodaStep.asciidoc
@@ -0,0 +1,7 @@
+== <%= title; %>
+
+<%= content; %>
+
+<% if(path) {%>
+After that, move to the target directory by executing `cd  <%= path; %>` in the terminal.
+<% } %>
diff --git a/runners/wikiEclipse/index.ts b/runners/wikiEclipse/index.ts
@@ -15,7 +15,7 @@ export class WikiEclipse extends WikiRunner {
     }
 
     runChangeFile(runCommand: RunCommand): RunResult{
-        let workspacePath = this.getVariable(this.workspaceDirectory).replace(/\\/g, "/");
+        let workspacePath = this.getVariable(this.WORKSPACE_DIRECTORY).replace(/\\/g, "/");
         let fileName = path.basename(runCommand.command.parameters[0]);
         let filePath = path.join(workspacePath,runCommand.command.parameters[0].replace(fileName, "")); 
         let contentPath, contentFile, contentString;
@@ -40,9 +40,26 @@ export class WikiEclipse extends WikiRunner {
             contentFile: contentFile, fileName: fileName});
         return null;
     }
+    
+
+    runInstallCobiGen(runCommand: RunCommand): RunResult{
+        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "installCobiGen.asciidoc"), {});
+        return null;
+    }
+
+    supports(name: string, parameters: any[]): boolean {
+        return this.getVariable(this.INSTALLED_TOOLS).includes("eclipse")
+            ? super.supports(name, parameters)
+            : false;
+    }
+
 
     runCreateDevon4jProject(runCommand: RunCommand): RunResult {
         this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "createDevon4jProject.asciidoc"), { name: runCommand.command.parameters[0]});
         return null;
     }
+    runAdaptTemplatesCobiGen(runComannd: RunCommand): RunResult{
+        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "adaptTemplates.asciidoc"), {});
+        return null;
+    }
 }
diff --git a/runners/wikiEclipse/templates/adaptTemplates.asciidoc b/runners/wikiEclipse/templates/adaptTemplates.asciidoc
@@ -0,0 +1,11 @@
+== Generate new Templates for CobiGen 
+How to use CobiGen, to generate templates for the following code generation.
+More information about CobiGen on https://devonfw.com/website/pages/docs/master-cobigen.asciidoc.html.
+
+=== Prerequisites
+An installed devonfw distribution is needed. To execute CobiGen in Eclipse IDE, you have to install the devonfw IDE with the Eclipse IDE first. Follow the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html[devonfw-ide] documentation to install the same.
+
+=== Generate CobiGen Templates with Eclipse IDE
+
+First, open Eclipse IDE, and if your file explorer is empty load any file, create a file, or project into Eclipse.
+Right-click any file in the file explorer to open a dropdown menu where you can select CobiGen and an additional menu opens. Select *Adapt Templates...* and CobiGen starts generating a new template folder. CobiGen gives you a warning that existing templates will be overridden in your current workspace, you can confirm to continue. If the folder is already existing CobiGen will inform you, that for updating your templates you have to use the *Update Templates...* functionality else CobiGen will create a folder and download the latest template to use it. You can confirm the messages with *OK* or *Update* and the CobiGen templates folder is imported successfully.
diff --git a/runners/wikiEclipse/templates/installCobigen.asciidoc b/runners/wikiEclipse/templates/installCobigen.asciidoc
@@ -0,0 +1,12 @@
+== Install GobiGen
+Installing devonfw code generator (i.e. CobiGen).
+
+=== Prerequisites
+* An installed devonfw Eclipse installation is needed. CobiGen Eclipse plugin will be installed with your devonfw distribution. In order to execute it, you have to install the devonfw IDE first. Follow the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html[devonfw-ide] documentation to install the same.
+
+=== Install CobiGen for Eclipse IDE
+
+CobiGen is already installed for your Eclipse IDE if you have installed it with the devonfw setup.
+You can open the *Help* menu and select *About Eclipse IDE*. To check if CobiGen is installed select *Installation Details* and CobiGen should be in the list of *Installed Software* and *Plug-ins*. You can use CobiGen by right-click on a file and selecting CobiGen in the opened menu. Now you can choose some CobiGen functions you want to execute for the selected file.
+
+Some further information about the usage of CobiGen can be found https://devonfw.com/website/pages/docs/master-cobigen.asciidoc.html[here]. 
diff --git a/runners/wikiEditor/index.ts b/runners/wikiEditor/index.ts
@@ -15,7 +15,7 @@ export class WikiEditor extends WikiRunner {
     }
 
     runChangeFile(runCommand: RunCommand): RunResult{
-        let workspacePath = this.getVariable(this.workspaceDirectory).replace(/\\/g, "/");
+        let workspacePath = this.getVariable(this.WORKSPACE_DIRECTORY).replace(/\\/g, "/");
         let fileName = path.basename(runCommand.command.parameters[0]);
         let filePath = path.join(workspacePath,runCommand.command.parameters[0].replace(fileName, "")); 
         let contentPath, contentFile, contentString;
diff --git a/runners/wikiVsCode/index.ts b/runners/wikiVsCode/index.ts
@@ -6,6 +6,7 @@ import * as path from "path";
 
 export class WikiVsCode extends WikiRunner {
 
+
     init(playbook: Playbook): void {
         super.init(playbook);
     }
@@ -15,7 +16,7 @@ export class WikiVsCode extends WikiRunner {
     }
 
     runChangeFile(runCommand: RunCommand): RunResult{
-        let workspacePath = this.getVariable(this.workspaceDirectory).replace(/\\/g, "/");
+        let workspacePath = this.getVariable(this.WORKSPACE_DIRECTORY).replace(/\\/g, "/");
         let fileName = path.basename(runCommand.command.parameters[0]);
         let filePath = path.join(workspacePath,runCommand.command.parameters[0].replace(fileName, "")); 
         let contentPath, contentFile, contentString;
@@ -40,4 +41,17 @@ export class WikiVsCode extends WikiRunner {
             contentFile: contentFile, fileName: fileName});
         return null;
     }
+
+    runInstallCobiGen(runCommand: RunCommand): RunResult{
+        let dir = path.relative(this.getVariable(this.WORKSPACE_DIRECTORY), this.getWorkingDirectory()).replace(/\\/g, "/");;
+        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "installCobiGen.asciidoc"), {dir: dir});
+        return null;
+    }
+
+    supports(name: string, parameters: any[]): boolean {
+        return this.getVariable(this.INSTALLED_TOOLS).includes("vscode")
+            ? super.supports(name, parameters)
+            : false;
+    }
+
 }
diff --git a/runners/wikiVsCode/templates/installCobiGen.asciidoc b/runners/wikiVsCode/templates/installCobiGen.asciidoc
@@ -0,0 +1,20 @@
+== Install GobiGen
+Installing devonfw code generator (i.e. CobiGen).
+
+=== Prerequisites
+* An installed VS Code Editor is needed. VS Code is installed inside your devonfw distribution. If VS Code or devonfw is missing, you have to install it first. Follow the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html[devonfw ] documentation to install the missing ones. 
+
+=== Install CobiGen for VS Code Editor
+First, download the VS Code extension file. You can download it from https://github.com/devonfw-forge/cobigen-vscode-plugin/releases/download/0.0.1/cobigen-plugin-0.0.1.vsix[here] or execute the following command in PowerShell or Terminal.
+
+
+.Operating system
+. Windows +
+`Invoke-WebRequest https://github.com/devonfw-forge/cobigen-vscode-plugin/releases/download/0.0.1/cobigen-plugin-0.0.1.vsix -O <%= dir;%>cobigen-plugin-0.0.1.vsix`
+. Linux and macOS +
+`wget https://github.com/devonfw-forge/cobigen-vscode-plugin/releases/download/0.0.1/cobigen-plugin-0.0.1.vsix -O cobigen-plugin-0.0.1.vsix -P $(pwd)/<%= dir;%>`
+
+Install CobiGen by opening VS Code Editor and the *Extensions* menu with ctrl+shift+X and select *...* in the top right corner of the extensions window. Select *Install from VSIX* and select the previously downloaded cobigen-plugin-0.0.1.vsix file, it is located in the directory you startet executing this wiki.
+Now CobiGen is installed, use CobiGen by right-clicking on a file and selecting CobiGen in the opened menu. CobiGen generate will be executed with the selected file.
+
+Some further information about the usage of CobiGen can be found https://devonfw.com/website/pages/docs/master-cobigen.asciidoc.html[here]. 
