Package config with dynamic package name processing + more

README.md

@@ -1,9 +1,21 @@
-## OpenAPI Forge - C#
+## OpenAPI Forge - Java
 
 This repository is the C# generator for the [OpenAPI Forge](https://github.com/ScottLogic/openapi-forge), see that repository for usage instructions:
 
 https://github.com/ScottLogic/openapi-forge
 
+## Configuration
+
+OpenAPI Forge is opinionated in its approach, we don't provide a vast range of configuration options, just the essentials! You can list the generator-specific configuration options by running the `generate-options` command as follows:
+
+```
+% openapi-forge generator-options openapi-forge-java
+This generator has a number of additional options which can be supplied when executing the 'forge' command.
+
+Options:
+  --generator.package <value>  The package for the generated classes.
+```
+
 ## Development
 
 ### Running

config.json

@@ -0,0 +1,6 @@
+{
+  "package": {
+    "default": "com.openapi.forge",
+    "description": "The package for the generated classes."
+  }
+}

formatter.js

@@ -1,14 +1,19 @@
 const prettier_cli = require("prettier/cli.js");
 
 const logLevels = [
-    /* quiet */
-    "silent",
-    /* standard */
-    "warn",
-    /* verbose */
-    "debug",
-  ];
-
-  module.exports = (folder, logLevel) => {
-    return prettier_cli.run(["--write", folder, "--loglevel", logLevels[logLevel]]);
-  };
+  /* quiet */
+  "silent",
+  /* standard */
+  "warn",
+  /* verbose */
+  "debug",
+];
+
+module.exports = (folder, logLevel) => {
+  return prettier_cli.run([
+    "--write",
+    folder,
+    "--loglevel",
+    logLevels[logLevel],
+  ]);
+};

helpers/complexReturnType.js

@@ -1,19 +1,19 @@
 const typeConvert = require("./typeConvert");
 
-const complexReturnType = (responseSchema) => { 
-    const responseType = typeConvert(responseSchema);
-    switch (responseType) {
-        case "boolean":
-        case "int":
-        case "long":
-        case "float":
-        case "double":
-        case "String":
-            return false;
-        case "Date":
-        default:
-            return true;
-    }
-}
+const complexReturnType = (responseSchema) => {
+  const responseType = typeConvert(responseSchema);
+  switch (responseType) {
+    case "boolean":
+    case "int":
+    case "long":
+    case "float":
+    case "double":
+    case "String":
+      return false;
+    case "Date":
+    default:
+      return true;
+  }
+};
 
-module.exports = complexReturnType;
+module.exports = complexReturnType;

helpers/createReturnStatement.js

@@ -8,7 +8,7 @@ const mapperListHandle = (responseType) => {
   } else {
     return `${responseType}.class`;
   }
-}
+};
 
 const createReturnStatement = (responseSchema) => {
   const responseType = typeConvert(responseSchema);
@@ -24,15 +24,21 @@ const createReturnStatement = (responseSchema) => {
       returnStatement = `${responseType}.Parse(responseBody)`;
       break;
     case "String":
-      returnStatement = "responseBody";
+      returnStatement = "responseBodyString";
       break;
     default:
       mapperStatements = `ObjectMapper deserMapper = new ObjectMapper();\n`;
-      mapperStatements += `${responseType} ${toParamName(responseType)} = deserMapper.readValue(responseBodyString, ${mapperListHandle(responseType)});\n`
+      mapperStatements += `${responseType} ${toParamName(
+        responseType
+      )} = deserMapper.readValue(responseBodyString, ${mapperListHandle(
+        responseType
+      )});\n`;
       returnStatement = toParamName(responseType);
   }
 
-  return new Handlebars.SafeString(mapperStatements + `return ${returnStatement};`);
+  return new Handlebars.SafeString(
+    mapperStatements + `return ${returnStatement};`
+  );
 };
 
 module.exports = createReturnStatement;

helpers/queryType.js

@@ -1,13 +1,13 @@
 const queryType = (key) => {
-    if (key == 'delete') {
-        return '.delete()';
-    } else if (key == "put") {
-        return '.put(RequestBody.create("", null))'
-    } else if (key == "post") {
-        return '.post(RequestBody.create("", null))'
-    } else {
-        return '';
-    }
+  if (key == "delete") {
+    return ".delete()";
+  } else if (key == "put") {
+    return '.put(RequestBody.create("", null))';
+  } else if (key == "post") {
+    return '.post(RequestBody.create("", null))';
+  } else {
+    return "";
+  }
 };
 
 module.exports = queryType;

helpers/queryTypeWithBody.js

@@ -2,15 +2,15 @@
 // This is why this function exists seperately.
 
 const queryTypeWithBody = (key) => {
-    if (key == "delete") {
-        return ".delete()";
-    } else if (key == "put") {
-        return ".put(httpBody)"
-    } else if (key == "post") {
-        return ".post(httpBody)"
-    } else {
-        return "";
-    }
+  if (key == "delete") {
+    return ".delete()";
+  } else if (key == "put") {
+    return ".put(httpBody)";
+  } else if (key == "post") {
+    return ".post(httpBody)";
+  } else {
+    return "";
+  }
 };
 
 module.exports = queryTypeWithBody;

helpers/toParamNameCapital.js

@@ -1,7 +1,6 @@
 const toParamNameCapital = (name) => {
-    name = name.replace(/[^a-z0-9_]/gi, "");
-    return name.charAt(0).toUpperCase() + name.substr(1);
-  };
-
-  module.exports = toParamNameCapital;
-
+  name = name.replace(/[^a-z0-9_]/gi, "");
+  return name.charAt(0).toUpperCase() + name.substr(1);
+};
+
+module.exports = toParamNameCapital;

package.json

@@ -3,8 +3,8 @@
   "version": "0.1.0",
   "description": "OpenAPI-Forge Java template",
   "apiTemplates": [
-    "src/main/java/com/example/springboot/ApiClient.java.handlebars",
-    "src/main/java/com/example/springboot/IApiClient.java.handlebars"
+    "ApiClient.java.handlebars",
+    "IApiClient.java.handlebars"
   ],
   "main": "index.js",
   "scripts": {
@@ -44,7 +44,8 @@
     "path": "^0.12.7",
     "prettier": "^2.7.1",
     "prettier-plugin-java": "^2.0.0",
-    "semantic-release": "^19.0.5"
+    "semantic-release": "^19.0.5",
+    "shelljs": "^0.8.5"
   },
   "engines": {
     "node": ">=16.0.0"

postProcess.js

@@ -0,0 +1,5 @@
+const move_files = require("./postProcessMoveFiles");
+
+module.exports = (folder, _, options) => {
+  move_files(folder, options);
+};

postProcessMoveFiles.js

@@ -0,0 +1,15 @@
+const shell = require("shelljs");
+
+// To match the java package/folder conventions, the java files that are generated from handlebars templates 
+// should be moved to src/main/java/<package_folder>. 
+// The package folder name comes from the generator options and that can given as a command line argument
+// by --generator.package
+
+module.exports = (folder, options) => {
+  var package_name = options["generator.package"];
+  var package_folder = package_name.replaceAll(".", "/");
+  java_path = "src/main/java/" + package_folder;
+  shell.cd(folder);
+  shell.mkdir("-p", java_path);
+  shell.mv("-f", "*.java", java_path);
+};

template/src/main/java/com/example/springboot/ApiClient.java.handlebars → template/ApiClient.java.handlebars

@@ -1,4 +1,4 @@
-package com.example.springboot;
+package {{_options.[generator.package]}};
 
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;

template/src/main/java/com/example/springboot/ApiModel.java.handlebars → template/ApiModel.java.handlebars

@@ -1,4 +1,4 @@
-package com.example.springboot;
+package {{_options.[generator.package]}};
 
 import java.util.Date;
 import java.util.List;

template/src/main/java/com/example/springboot/Application.java.handlebars → template/Application.java.handlebars

@@ -1,4 +1,4 @@
-package com.example.springboot;
+package {{_options.[generator.package]}};
 
 import org.springframework.boot.CommandLineRunner;
 import org.springframework.boot.SpringApplication;

template/src/main/java/com/example/springboot/Configuration.java.handlebars → template/Configuration.java.handlebars

@@ -1,4 +1,4 @@
-package com.example.springboot;
+package {{_options.[generator.package]}};
 
 import java.util.Arrays;
 import java.util.List;

template/src/main/java/com/example/springboot/IApiClient.java.handlebars → template/IApiClient.java.handlebars

@@ -1,4 +1,4 @@
-package com.example.springboot;
+package {{_options.[generator.package]}};
 
 import java.util.List;