Moved documentation to 00-docs / integrated DevCompanyCamundalaHelper.

Author: pme123

00-documentation/README.md renamed to 00-docs/README.md

@@ -1,17 +1,19 @@
 package camundala.helper.dev
 
+import camundala.api.ApiConfig
 import camundala.helper.dev.publish.PublishHelper
 import camundala.helper.dev.publish.PublishHelper.*
-import camundala.helper.util.{DevConfig, Helpers}
+import camundala.helper.util.{DevConfig, Helpers, PublishConfig}
 
 import scala.util.{Failure, Success, Try}
 
 // dev-company/company-camundala/helper.scala
-case class DevCompanyCamundalaRunner(
-    devConfig: DevConfig
-) extends Helpers:
+trait DevCompanyCamundalaHelper extends Helpers:
+  def apiConfig: ApiConfig
+  def devConfig: DevConfig
+  def publishConfig: Option[PublishConfig]
 
-  def run(command: String, arguments: String*): Unit =
+  def runForCompany(command: String, arguments: String*): Unit =
     val args = arguments.toSeq
     println(s"Running command: $command with args: $args")
     Try(Command.valueOf(command)) match
@@ -21,7 +23,7 @@ case class DevCompanyCamundalaRunner(
         println(s"Command not found: $command")
         println("Available commands: " + Command.values.mkString(", "))
     end match
-  end run
+  end runForCompany
 
   private def runCommand(command: Command, args: Seq[String]): Unit =
     command match
@@ -30,14 +32,11 @@ case class DevCompanyCamundalaRunner(
       case Command.publish =>
         println("Usage: publish <version>")
       case Command.prepareDocs =>
-      //   CompanyDocCreator.prepareDocs()
+       // DocCreator.prepareDocs()
       case Command.releaseDocs =>
       //  CompanyDocCreator.releaseDocs()
-      case other =>
-        println(s"Command not found: $other")
-        println("Available commands: publish, prepareDocs, releaseDocs")
 
-  enum Command:
+  private enum Command:
     case publish, prepareDocs, releaseDocs
 
   private def publish(newVersion: String): Unit =
@@ -56,4 +55,4 @@ case class DevCompanyCamundalaRunner(
     end if
   end publish
 
-end DevCompanyCamundalaRunner
+end DevCompanyCamundalaHelper

00-documentation/src/docs/bpmnDsl.md renamed to 00-docs/src/docs/bpmnDsl.md

@@ -6,7 +6,7 @@ import camundala.helper.util.{DevConfig, RepoConfig}
 import scala.util.{Failure, Success, Try}
 
 // dev-company/helperCompany.scala
-object DevCompanyRunner:
+object DevCompanyHelper:
 
   def run(command: String, arguments: String*): Unit =
     val args = arguments.toSeq
@@ -49,4 +49,4 @@ object DevCompanyRunner:
 
   private lazy val companyName = os.pwd.last.replace("dev-", "").toLowerCase
 
-end DevCompanyRunner
+end DevCompanyHelper

00-documentation/src/docs/development/createProject.md renamed to 00-docs/src/docs/development/createProject.md

@@ -34,7 +34,7 @@ trait DevHelper:
   private def runCommand(command: Command, args: Seq[String]): Unit =
     command match
       case Command.update =>
-        update
+        update()
       // start code generation
       case Command.process =>
         args match
@@ -136,11 +136,11 @@ trait DevHelper:
     println(s"Example: $command myProcess My$command 1")
   end printBadActivity
 
-  enum Command:
+  private enum Command:
     case update, process, customTask, serviceTask, userTask, decision, signalEvent, messageEvent,
       timerEvent, publish, deploy, dockerUp, dockerStop, dockerDown
 
-  def update: Unit =
+  def update(): Unit =
     println(s"Update Project: ${devConfig.projectName}")
     println(s" - with Subprojects: ${devConfig.subProjects}")
     SetupGenerator().generate
@@ -154,50 +154,50 @@ trait DevHelper:
     ))
   end createProcess
 
-  def createCustomTask(processName: String, bpmnName: String, version: Option[Int]): Unit =
+  private def createCustomTask(processName: String, bpmnName: String, version: Option[Int]): Unit =
     SetupGenerator().createProcessElement(SetupElement(
       "CustomTask",
       processName.asProcessName,
       bpmnName.asElemName,
       version
     ))
 
-  def createServiceTask(processName: String, bpmnName: String, version: Option[Int]): Unit =
+  private def createServiceTask(processName: String, bpmnName: String, version: Option[Int]): Unit =
     SetupGenerator().createProcessElement(SetupElement(
       "ServiceTask",
       processName.asProcessName,
       bpmnName.asElemName,
       version
     ))
 
-  def createUserTask(processName: String, bpmnName: String, version: Option[Int]): Unit =
+  private def createUserTask(processName: String, bpmnName: String, version: Option[Int]): Unit =
     SetupGenerator().createUserTask(
       SetupElement("UserTask", processName.asProcessName, bpmnName.asElemName, version)
     )
 
-  def createDecision(processName: String, bpmnName: String, version: Option[Int]): Unit =
+  private def createDecision(processName: String, bpmnName: String, version: Option[Int]): Unit =
     SetupGenerator().createDecision(
       SetupElement("Decision", processName.asProcessName, bpmnName.asElemName, version)
     )
 
-  def createSignalEvent(processName: String, bpmnName: String, version: Option[Int]): Unit =
+  private def createSignalEvent(processName: String, bpmnName: String, version: Option[Int]): Unit =
     SetupGenerator().createEvent(SetupElement(
       "Signal",
       processName.asProcessName,
       bpmnName.asElemName,
       version
     ))
 
-  def createMessageEvent(processName: String, bpmnName: String, version: Option[Int]): Unit =
+  private def createMessageEvent(processName: String, bpmnName: String, version: Option[Int]): Unit =
     SetupGenerator().createEvent(SetupElement(
       "Message",
       processName.asProcessName,
       bpmnName.asElemName,
       version
     ))
 
-  def createTimerEvent(processName: String, bpmnName: String, version: Option[Int])(using
-      config: DevConfig
+  private def createTimerEvent(processName: String, bpmnName: String, version: Option[Int])(using
+                                                                                            config: DevConfig
   ): Unit =
     SetupGenerator().createEvent(SetupElement(
       "Timer",
@@ -207,9 +207,9 @@ trait DevHelper:
     ))
 
   extension (name: String)
-    def asProcessName: String =
+    private def asProcessName: String =
       name.head.toLower + name.tail
-    def asElemName: String =
+    private def asElemName: String =
       name.head.toUpper + name.tail
   end extension
 end DevHelper

00-documentation/src/docs/development/directory.conf renamed to 00-docs/src/docs/development/directory.conf

@@ -20,7 +20,7 @@ lazy val root = project
     sourcesInBase := false
   )
   .aggregate(
-    documentation,
+    docs,
     domain,
     bpmn,
     api,
@@ -41,10 +41,10 @@ lazy val root = project
   )
 
 // general independent
-lazy val documentation =
-  (project in file("./00-documentation"))
+lazy val docs =
+  (project in file("./00-docs"))
     .configure(preventPublication)
-    .settings(projectSettings("documentation"))
+    .settings(projectSettings("docs"))
     .settings(laikaSettings)
     .settings(mdocSettings)
     .enablePlugins(LaikaPlugin, MdocPlugin)
@@ -388,7 +388,7 @@ lazy val exampleDemosC7 = project
   )
   .dependsOn(bpmn, exampleDemosBpmn, camunda)
 
-// start company documentation example
+// start company docs example
 import com.typesafe.config.ConfigFactory
 
 import scala.jdk.CollectionConverters.*

00-documentation/src/docs/development/initCompany.md renamed to 00-docs/src/docs/development/initCompany.md

@@ -9,7 +9,7 @@
   <title>BPMN DSL</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/development/intro.md renamed to 00-docs/src/docs/development/intro.md

@@ -9,7 +9,7 @@
   <title>API Documentation</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/development/projectDev.md renamed to 00-docs/src/docs/development/projectDev.md

@@ -9,7 +9,7 @@
   <title>DMN Tester</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/directory.conf renamed to 00-docs/src/docs/directory.conf

@@ -9,7 +9,7 @@
   <title>Simulations</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/exampleApi/OpenApi.html renamed to 00-docs/src/docs/exampleApi/OpenApi.html

@@ -9,7 +9,7 @@
   <title>Workers</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/exampleApi/PostmanOpenApi.html renamed to 00-docs/src/docs/exampleApi/PostmanOpenApi.html

@@ -9,7 +9,7 @@
   <title>General Concerns</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/exampleApi/openApi.yml renamed to 00-docs/src/docs/exampleApi/openApi.yml

@@ -9,7 +9,7 @@
   <title>Create Project</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/exampleApi/postmanOpenApi.yml renamed to 00-docs/src/docs/exampleApi/postmanOpenApi.yml

@@ -9,7 +9,7 @@
   <title>Development</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/functionalityDsls/apiDoc.md renamed to 00-docs/src/docs/functionalityDsls/apiDoc.md

@@ -9,7 +9,7 @@
   <title>Init Company</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/functionalityDsls/directory.conf renamed to 00-docs/src/docs/functionalityDsls/directory.conf

@@ -9,7 +9,7 @@
   <title>Project Development</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/functionalityDsls/dmnTester.md renamed to 00-docs/src/docs/functionalityDsls/dmnTester.md

@@ -9,7 +9,7 @@
   <title>Intro</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/functionalityDsls/images/api_apiStructure.png renamed to 00-docs/src/docs/functionalityDsls/images/api_apiStructure.png

@@ -9,7 +9,7 @@
   <title>Project Setup</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>
 
 
 

00-documentation/src/docs/functionalityDsls/images/api_cawemoBpmn.png renamed to 00-docs/src/docs/functionalityDsls/images/api_cawemoBpmn.png

@@ -9,7 +9,7 @@
   <title>Process & Domain Specification</title>
 
 
-  <meta name="description" content="camundala-documentation"/>
+  <meta name="description" content="camundala-docs"/>