Added support for pre-req and some clean-up

Author: hhariri

README.md

@@ -16,7 +16,17 @@ Configure the parameters for your hands-on tutorial using a JSON configuration f
   "title": "Introduction to Ktor",
   "projectName": "introduction-to-ktor",
   "pathHandsOn": "./hands-on",
-  "pathProject": "./hands-on-project"
+  "pathProject": "./hands-on-project",
+  "pre": [
+    {
+      "text": "How to set up a project",
+      "link": "https://play.kotlinlang.org/hands-on/how-to"
+    },
+    {
+      "text": "How to start a server",
+      "link": "https://play.kotlinlang.org/hands-on/start-server"
+    }
+  ]
 }
 ``` 
 
@@ -37,3 +47,4 @@ You can binaries on the [Releases](https://github.com/kotlin-hands-on/hands-on-i
 
 Apache 2.0 
 
+

src/macosMain/kotlin/com/jetbrains/handson/handson/init/Configuration.kt

@@ -3,4 +3,16 @@ package com.jetbrains.handson.handson.init
 import kotlinx.serialization.Serializable
 
 @Serializable
-data class Configuration(val title: String, val projectName: String, val pathHandsOn: String, val pathProject: String)
+data class Configuration(
+    val title: String,
+    val projectName: String,
+    val pathHandsOn: String,
+    val pathProject: String,
+    val pre: List<PreRequisite>
+)
+
+@Serializable
+data class PreRequisite(
+    val text: String,
+    val link: String
+)

src/macosMain/kotlin/com/jetbrains/handson/handson/init/FileIOException.kt

@@ -1,7 +1,6 @@
 package com.jetbrains.handson.handson.init
 
 import kotlinx.cinterop.toKString
-import platform.posix.errno
 import platform.posix.strerror
 
 class FileIOException(errorCode: Int) : Throwable(strerror(errorCode)?.toKString() ?: "Error: $errorCode")

src/macosMain/kotlin/com/jetbrains/handson/handson/init/HandsOnInitiator.kt

@@ -1,5 +1,7 @@
 package com.jetbrains.handson.handson.init
 
+import kotlinx.serialization.PrimitiveKind
+
 class HandsOnInitiator(private val configuration: Configuration) {
     private val fileIO = FileIO()
 
@@ -30,7 +32,7 @@ class HandsOnInitiator(private val configuration: Configuration) {
         fileIO.createFile("${configuration.pathProject}/${configuration.projectName}/LICENSE", generateLicenseContent())
     }
 
-    fun createGitIngoreFile() {
+    fun createGitIgnoreFile() {
         println("\nCreating .gitignore file")
         fileIO.createFile("${configuration.pathProject}/${configuration.projectName}/.gitignore", generateGitIgnoreContent())
     }
@@ -259,8 +261,23 @@ class HandsOnInitiator(private val configuration: Configuration) {
                 "This repository is the code corresponding to the hands-on lab [${configuration.title}](https://play.kotlinlang.org/hands-on/${configuration.title.replace(" ", "%%20")}/01_Introduction). \n"
     }
 
+    private fun generatePrerequisites(): String {
+        var topics = ""
+        configuration.pre.forEach {
+            topics += "* [${it.text}](${it.link})\n"
+        }
+
+        return "This tutorial assumes that you're already familiar with the following topics:\n" +
+                "\n" +
+                topics +
+                "\n"
+    }
+
     private fun generateIntroductionContent(): String {
+        val prereq = generatePrerequisites()
         return "# Introduction\n" +
+                "\n" +
+                prereq +
                 "\n" +
                 "TODO - Provide introduction here" +
                 "\n" +

src/macosMain/kotlin/com/jetbrains/handson/handson/init/HandsOnInitiatorException.kt

@@ -10,15 +10,14 @@ fun main(args: Array<String>) {
         println("\n usage: hands-on-init {config.json}")
         exitProcess(-1)
     }
-
     val configurationFile = ConfigurationFile()
     try {
         val config = configurationFile.load(args[0])
         val handsOnInitiator = HandsOnInitiator(config)
         handsOnInitiator.createFolderStructure()
         handsOnInitiator.createMarkdownFiles()
         handsOnInitiator.createLicenseFile()
-        handsOnInitiator.createGitIngoreFile()
+        handsOnInitiator.createGitIgnoreFile()
         handsOnInitiator.outputInstructions()
     } catch (e: Exception) {
         printErrorMessage(e)

src/macosMain/kotlin/com/jetbrains/handson/handson/init/Main.kt

@@ -2,5 +2,15 @@
   "title": "Introduction to Ktor",
   "projectName": "introduction-to-ktor",
   "pathHandsOn": "./hands-on",
-  "pathProject": "./"
+  "pathProject": "./",
+  "pre": [
+    {
+      "text": "How to set up a project",
+      "link": "https://play.kotlinlang.org/hands-on/how-to"
+    },
+    {
+      "text": "How to start a server",
+      "link": "https://play.kotlinlang.org/hands-on/start-server"
+    }
+  ]
 }