Merge pull request #267 from EduardKrieger/feature/wikiRunnerAddSetupScript

Feature/wikiRunnerAddSetupScript

Author: EduardKrieger

runners/wikiConsole/index.ts

@@ -3,7 +3,8 @@ 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';
+import * as fs from "fs";
+
 
 export class WikiConsole extends WikiRunner {
 
@@ -135,6 +136,16 @@ export class WikiConsole extends WikiRunner {
         return null;
     }
 
+    runAddSetupScript(runCommand: RunCommand): RunResult{
+        let scriptNameLinux = path.basename(runCommand.command.parameters[0]);
+        let scriptNameWindows = path.basename(runCommand.command.parameters[1]);
+        let windowsContent = fs.readFileSync(path.join(this.playbookPath, runCommand.command.parameters[1]), { encoding: "utf-8" });
+        let linuxContent = fs.readFileSync(path.join(this.playbookPath, runCommand.command.parameters[0]), { encoding: "utf-8" });
+        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "addSetupScript.asciidoc"), {scriptNameWindows: scriptNameWindows, windowsContent: windowsContent,
+             scriptNameLinux: scriptNameLinux, linuxContent: linuxContent});
+      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});
@@ -159,7 +170,7 @@ export class WikiConsole extends WikiRunner {
 
         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;
     }
 }

runners/wikiConsole/templates/addSetupScript.asciidoc

@@ -0,0 +1,39 @@
+== Run a Setupscript
+Run a Script to setup the enviroment for the Tutorial.  
+
+
+=== Prerequisites
+* Any Editor that can edit files.
+
+=== Create the Setupscript
+Open a editor and create a new file by going to the file context menu in the top left corner of the editor and select *New* or *New File* or mostly also the keyboard shortcut ctrl+n will also work.
+
+.Operating system
+. Windows + 
+The editor opens a new editor window for an untitled file where you should insert the following text.
++
+[source, powershell]
+----
+<%- windowsContent; %>
+----
+Save the file by selecting *Save* or *Save as* in the file context menu or by using the keyboard shortcut ctrl+s.
+A file explorer window opens where you should set the filename to *<%= scriptNameWindows; %>* and save it to your current directory. 
+
+. Linux and macOS + 
+The editor opens a new editor window for an untitled file where you can insert the following text.
++
+[source, bash]
+----
+<%- linuxContent; %>
+----
+Save the file by selecting *Save* or *Save as* in the file context menu or by using the keyboard shortcut ctrl+s.
+A file explorer window opens where you should set the filename to *<%= scriptNameLinux; %>* and save it to your current directory. 
+
+=== Run the Setupscript
+
+.Operating system
+. Windows + 
+Open the PowerShell in your current workspace and execute the command `./<%= scriptNameWindows; %>` to run the script.
+. Linux and macOS + 
+Open the Terminal in your current workspace and execute the command `bash <%= scriptNameWindows; %>` to run the script.
+

runners/wikiConsole/templates/intro.asciidoc

@@ -6,4 +6,5 @@
 The definition of each step of this tutorial can be found at https://github.com/devonfw-tutorials/tutorials/tree/main/<%= name; %>. <% } %>
 
 Feel free to report any errors to us or fix them yourself. Errors can be reported by creating an issue in the https://github.com/devonfw-tutorials/tutorials/issues[tutorials repository]. To fix the error fork the repository and create a pull request. Errors in the wiki can be reported and fixed in the https://github.com/devonfw-tutorials/tutorial-compiler[Tutorial-compiler repository].
-You can find a description of what to look for when creating a pull request at the devonfw contribution guide: https://devonfw.com/website/pages/community/community.html#community.asciidoc_contributing-to-devonfw. If you want to create a tutorial you can start with the https://katacoda.com/devonfw/scenarios/create-your-own-tutorial[katacoda tutorial] and read the description for creating your own tutorials: https://github.com/devonfw-tutorials/tutorials/wiki/Development.
+You can find a description of what to look for when creating a pull request at the devonfw contribution guide: https://devonfw.com/website/pages/community/community.html#community.asciidoc_contributing-to-devonfw. If you want to create a tutorial you can start with the https://katacoda.com/devonfw/scenarios/create-your-own-tutorial[katacoda tutorial] and read the description for creating your own tutorials: https://github.com/devonfw-tutorials/tutorials/wiki/Development.
+