Add js-beautify support to JS generator (OpenAPITools#961)

* add js-beautify support to JS generator * replace tab with space * update samples without JS_BEAUTIFY_PATH
ihsmarkitoss · Sep 8, 2018 · 3923160 · 3923160
1 parent 3f6c98b
commit 3923160
Show file tree

Hide file tree

Showing 93 changed files with 124 additions and 93 deletions.
diff --git a/...i-generator/src/main/java/org/openapitools/codegen/languages/JavascriptClientCodegen.java b/...i-generator/src/main/java/org/openapitools/codegen/languages/JavascriptClientCodegen.java
@@ -24,6 +24,7 @@
 import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.Schema;
 import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.io.FilenameUtils;
 import org.openapitools.codegen.CliOption;
 import org.openapitools.codegen.CodegenConfig;
 import org.openapitools.codegen.CodegenConstants;
@@ -47,7 +48,6 @@
 import java.util.Locale;
 import java.util.Map;
 
-
 public class JavascriptClientCodegen extends DefaultCodegen implements CodegenConfig {
     @SuppressWarnings("hiding")
     private static final Logger LOGGER = LoggerFactory.getLogger(JavascriptClientCodegen.class);
@@ -232,6 +232,10 @@ public void processOpts() {
         }
         super.processOpts();
 
+        if (StringUtils.isEmpty(System.getenv("JS_BEAUTIFY_PATH"))) {
+            LOGGER.info("Environment variable JS_BEAUTIFY_PATH not defined so the JS code may not be properly formatted. To define it, try 'export JS_BEAUTIFY_PATH=/usr/local/bin/js-beautify' (Linux/Mac)");
+        }
+
         if (additionalProperties.containsKey(PROJECT_NAME)) {
             setProjectName(((String) additionalProperties.get(PROJECT_NAME)));
         }
@@ -1157,4 +1161,31 @@ public String escapeUnsafeCharacters(String input) {
         return input.replace("*/", "*_/").replace("/*", "/_*");
     }
 
+    @Override
+    public void postProcessFile(File file, String fileType) {
+        if (file == null) {
+            return;
+        }
+
+        String jsBeautifyPath = System.getenv("JS_BEAUTIFY_PATH");
+        if (StringUtils.isEmpty(jsBeautifyPath)) {
+            return; // skip if JS_BEAUTIFY_PATH env variable is not defined
+        }
+
+        // only process files with js extension
+        if ("js".equals(FilenameUtils.getExtension(file.toString()))) {
+            String command = jsBeautifyPath + " -r -f " + file.toString();
+            try {
+                Process p = Runtime.getRuntime().exec(command);
+                p.waitFor();
+                if (p.exitValue() != 0) {
+                    LOGGER.error("Error running the command ({}): {}", command, p.exitValue());
+                }
+            } catch (Exception e) {
+                LOGGER.error("Error running the command ({}): {}", command, e.getMessage());
+            }
+            LOGGER.info("Successfully executed: " + command);
+        }
+    }
+
 }
diff --git a/samples/client/petstore/javascript-es6/.openapi-generator/VERSION b/samples/client/petstore/javascript-es6/.openapi-generator/VERSION
@@ -1 +1 @@
-3.2.3-SNAPSHOT
+3.3.0-SNAPSHOT
diff --git a/samples/client/petstore/javascript-promise-es6/.openapi-generator/VERSION b/samples/client/petstore/javascript-promise-es6/.openapi-generator/VERSION
@@ -1 +1 @@
-3.2.3-SNAPSHOT
+3.3.0-SNAPSHOT
diff --git a/samples/client/petstore/javascript-promise/.openapi-generator/VERSION b/samples/client/petstore/javascript-promise/.openapi-generator/VERSION
@@ -1 +1 @@
-3.2.3-SNAPSHOT
+3.3.0-SNAPSHOT
diff --git a/samples/client/petstore/javascript-promise/src/ApiClient.js b/samples/client/petstore/javascript-promise/src/ApiClient.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/api/AnotherFakeApi.js b/samples/client/petstore/javascript-promise/src/api/AnotherFakeApi.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/api/FakeApi.js b/samples/client/petstore/javascript-promise/src/api/FakeApi.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/api/FakeClassnameTags123Api.js b/samples/client/petstore/javascript-promise/src/api/FakeClassnameTags123Api.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/api/PetApi.js b/samples/client/petstore/javascript-promise/src/api/PetApi.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/api/StoreApi.js b/samples/client/petstore/javascript-promise/src/api/StoreApi.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/api/UserApi.js b/samples/client/petstore/javascript-promise/src/api/UserApi.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/index.js b/samples/client/petstore/javascript-promise/src/index.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/AdditionalPropertiesClass.js b/samples/client/petstore/javascript-promise/src/model/AdditionalPropertiesClass.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/Animal.js b/samples/client/petstore/javascript-promise/src/model/Animal.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/AnimalFarm.js b/samples/client/petstore/javascript-promise/src/model/AnimalFarm.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/ApiResponse.js b/samples/client/petstore/javascript-promise/src/model/ApiResponse.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/ArrayOfArrayOfNumberOnly.js b/samples/client/petstore/javascript-promise/src/model/ArrayOfArrayOfNumberOnly.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/ArrayOfNumberOnly.js b/samples/client/petstore/javascript-promise/src/model/ArrayOfNumberOnly.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/ArrayTest.js b/samples/client/petstore/javascript-promise/src/model/ArrayTest.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/Capitalization.js b/samples/client/petstore/javascript-promise/src/model/Capitalization.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/Cat.js b/samples/client/petstore/javascript-promise/src/model/Cat.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/Category.js b/samples/client/petstore/javascript-promise/src/model/Category.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/ClassModel.js b/samples/client/petstore/javascript-promise/src/model/ClassModel.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/Client.js b/samples/client/petstore/javascript-promise/src/model/Client.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/Dog.js b/samples/client/petstore/javascript-promise/src/model/Dog.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/EnumArrays.js b/samples/client/petstore/javascript-promise/src/model/EnumArrays.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/EnumClass.js b/samples/client/petstore/javascript-promise/src/model/EnumClass.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/EnumTest.js b/samples/client/petstore/javascript-promise/src/model/EnumTest.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/File.js b/samples/client/petstore/javascript-promise/src/model/File.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/FileSchemaTestClass.js b/samples/client/petstore/javascript-promise/src/model/FileSchemaTestClass.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/FormatTest.js b/samples/client/petstore/javascript-promise/src/model/FormatTest.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/HasOnlyReadOnly.js b/samples/client/petstore/javascript-promise/src/model/HasOnlyReadOnly.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/List.js b/samples/client/petstore/javascript-promise/src/model/List.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/MapTest.js b/samples/client/petstore/javascript-promise/src/model/MapTest.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/...ient/petstore/javascript-promise/src/model/MixedPropertiesAndAdditionalPropertiesClass.js b/...ient/petstore/javascript-promise/src/model/MixedPropertiesAndAdditionalPropertiesClass.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/Model200Response.js b/samples/client/petstore/javascript-promise/src/model/Model200Response.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/ModelReturn.js b/samples/client/petstore/javascript-promise/src/model/ModelReturn.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/Name.js b/samples/client/petstore/javascript-promise/src/model/Name.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/NumberOnly.js b/samples/client/petstore/javascript-promise/src/model/NumberOnly.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *

diff --git a/samples/client/petstore/javascript-promise/src/model/Order.js b/samples/client/petstore/javascript-promise/src/model/Order.js
@@ -7,7 +7,7 @@
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  *
- * OpenAPI Generator version: 3.2.3-SNAPSHOT
+ * OpenAPI Generator version: 3.3.0-SNAPSHOT
  *
  * Do not edit the class manually.
  *