Upgrade Dart2 template to advertised best-practices, plenty of additions too.

docs/generators/dart-dio.md

@@ -18,6 +18,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |pubAuthorEmail|Email address of the author in generated pubspec| |null|
 |pubDescription|Description in generated pubspec| |null|
 |pubHomepage|Homepage in generated pubspec| |null|
+|pubLibrary|Library name in generated code| |null|
 |pubName|Name in generated pubspec| |null|
 |pubVersion|Version in generated pubspec| |null|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|

docs/generators/dart-jaguar.md

@@ -17,6 +17,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |pubAuthorEmail|Email address of the author in generated pubspec| |null|
 |pubDescription|Description in generated pubspec| |null|
 |pubHomepage|Homepage in generated pubspec| |null|
+|pubLibrary|Library name in generated code| |null|
 |pubName|Name in generated pubspec| |null|
 |pubVersion|Version in generated pubspec| |null|
 |serialization|Choose serialization format JSON or PROTO is supported| |null|

docs/generators/dart.md

@@ -16,6 +16,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |pubAuthorEmail|Email address of the author in generated pubspec| |null|
 |pubDescription|Description in generated pubspec| |null|
 |pubHomepage|Homepage in generated pubspec| |null|
+|pubLibrary|Library name in generated code| |null|
 |pubName|Name in generated pubspec| |null|
 |pubVersion|Version in generated pubspec| |null|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/DartClientCodegen.java

@@ -59,6 +59,7 @@
 public class DartClientCodegen extends DefaultCodegen implements CodegenConfig {
     private static final Logger LOGGER = LoggerFactory.getLogger(DartClientCodegen.class);
 
+    public static final String PUB_LIBRARY = "pubLibrary";
     public static final String PUB_NAME = "pubName";
     public static final String PUB_VERSION = "pubVersion";
     public static final String PUB_DESCRIPTION = "pubDescription";
@@ -67,6 +68,7 @@ public class DartClientCodegen extends DefaultCodegen implements CodegenConfig {
     public static final String PUB_HOMEPAGE = "pubHomepage";
     public static final String USE_ENUM_EXTENSION = "useEnumExtension";
 
+    protected String pubLibrary = "openapi.api";
     protected String pubName = "openapi";
     protected String pubVersion = "1.0.0";
     protected String pubDescription = "OpenAPI API client";
@@ -169,6 +171,7 @@ public DartClientCodegen() {
         typeMapping.put("URI", "String");
         typeMapping.put("ByteArray", "String");
 
+        cliOptions.add(new CliOption(PUB_LIBRARY, "Library name in generated code"));
         cliOptions.add(new CliOption(PUB_NAME, "Name in generated pubspec"));
         cliOptions.add(new CliOption(PUB_VERSION, "Version in generated pubspec"));
         cliOptions.add(new CliOption(PUB_DESCRIPTION, "Description in generated pubspec"));
@@ -214,6 +217,13 @@ public void processOpts() {
             additionalProperties.put(PUB_NAME, pubName);
         }
 
+        if (additionalProperties.containsKey(PUB_LIBRARY)) {
+            this.setPubLibrary((String) additionalProperties.get(PUB_LIBRARY));
+        } else {
+            //not set, use to be passed to template
+            additionalProperties.put(PUB_LIBRARY, pubLibrary);
+        }
+
         if (additionalProperties.containsKey(PUB_VERSION)) {
             this.setPubVersion((String) additionalProperties.get(PUB_VERSION));
         } else {
@@ -409,7 +419,7 @@ public String toDefaultValue(Schema schema) {
 
         if (schema.getDefault() != null) {
             if (ModelUtils.isStringSchema(schema)) {
-                return "\"" + schema.getDefault().toString().replaceAll("\"", "\\\"") + "\"";
+                return "'" + schema.getDefault().toString().replaceAll("'", "\\'") + "'";
             }
             return schema.getDefault().toString();
         } else {
@@ -532,7 +542,7 @@ public String toEnumValue(String value, String datatype) {
                 "int".equalsIgnoreCase(datatype)) {
             return value;
         } else {
-            return "\"" + escapeText(value) + "\"";
+            return "'" + escapeText(value) + "'";
         }
     }
 
@@ -548,6 +558,10 @@ public String toOperationId(String operationId) {
         return camelize(operationId, true);
     }
 
+    public void setPubLibrary(String pubLibrary) {
+        this.pubLibrary = pubLibrary;
+    }
+
     public void setPubName(String pubName) {
         this.pubName = pubName;
     }

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/DartDioClientCodegen.java

@@ -130,7 +130,7 @@ public String toDefaultValue(Schema schema) {
 
         if (schema.getDefault() != null) {
             if (ModelUtils.isStringSchema(schema)) {
-                return "\"" + schema.getDefault().toString().replaceAll("\"", "\\\"") + "\"";
+                return "'" + schema.getDefault().toString().replaceAll("'", "\\'") + "'";
             }
             return schema.getDefault().toString();
         } else {
@@ -179,6 +179,13 @@ public void processOpts() {
 
         additionalProperties.put(IS_FORMAT_JSON, true);
 
+        if (additionalProperties.containsKey(PUB_LIBRARY)) {
+            this.setPubLibrary((String) additionalProperties.get(PUB_LIBRARY));
+        } else {
+            //not set, use to be passed to template
+            additionalProperties.put(PUB_LIBRARY, pubLibrary);
+        }
+
         if (additionalProperties.containsKey(PUB_NAME)) {
             this.setPubName((String) additionalProperties.get(PUB_NAME));
         } else {

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/DartJaguarClientCodegen.java

@@ -140,7 +140,7 @@ public String toDefaultValue(Schema schema) {
 
         if (schema.getDefault() != null) {
             if (ModelUtils.isStringSchema(schema)) {
-                return "\"" + schema.getDefault().toString().replaceAll("\"", "\\\"") + "\"";
+                return "'" + schema.getDefault().toString().replaceAll("'", "\\'") + "'";
             }
             return schema.getDefault().toString();
         } else {
@@ -172,6 +172,13 @@ public void processOpts() {
             additionalProperties.put(IS_FORMAT_PROTO, false);
         }
 
+        if (additionalProperties.containsKey(PUB_LIBRARY)) {
+            this.setPubLibrary((String) additionalProperties.get(PUB_LIBRARY));
+        } else {
+            //not set, use to be passed to template
+            additionalProperties.put(PUB_LIBRARY, pubLibrary);
+        }
+
         if (additionalProperties.containsKey(PUB_NAME)) {
             this.setPubName((String) additionalProperties.get(PUB_NAME));
         } else {

modules/openapi-generator/src/main/resources/dart2/README.mustache

@@ -1,18 +1,18 @@
-# {{pubName}}
+# {{{pubName}}}
 {{#appDescriptionWithNewLines}}
 {{{appDescriptionWithNewLines}}}
 {{/appDescriptionWithNewLines}}
 
 This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: {{appVersion}}
+- API version: {{{appVersion}}}
 {{#artifactVersion}}
-- Package version: {{artifactVersion}}
+- Package version: {{{artifactVersion}}}
 {{/artifactVersion}}
 {{^hideGenerationTimestamp}}
-- Build date: {{generatedDate}}
+- Build date: {{{generatedDate}}}
 {{/hideGenerationTimestamp}}
-- Build package: {{generatorClass}}
+- Build package: {{{generatorClass}}}
 {{#infoUrl}}
 For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
 {{/infoUrl}}
@@ -27,16 +27,16 @@ Dart 2.0 or later
 If this Dart package is published to Github, add the following dependency to your pubspec.yaml
 ```
 dependencies:
-  {{pubName}}:
-    git: https://{{gitHost}}/{{gitUserId}}/{{gitRepoId}}.git
+  {{{pubName}}}:
+    git: https://{{{gitHost}}}/{{{gitUserId}}}/{{{gitRepoId}}}.git
 ```
 
 ### Local
 To use the package in your local drive, add the following dependency to your pubspec.yaml
 ```
 dependencies:
-  {{pubName}}:
-    path: /path/to/{{pubName}}
+  {{{pubName}}}:
+    path: /path/to/{{{pubName}}}
 ```
 
 ## Tests
@@ -48,7 +48,7 @@ TODO
 Please follow the [installation procedure](#installation--usage) and then run the following:
 
 ```dart
-import 'package:{{pubName}}/api.dart';
+import 'package:{{{pubName}}}/api.dart';
 {{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}
 {{#hasAuthMethods}}
 {{#authMethods}}
@@ -80,34 +80,34 @@ import 'package:{{pubName}}/api.dart';
 {{/authMethods}}
 {{/hasAuthMethods}}
 
-var api_instance = {{classname}}();
+final api_instance = {{{classname}}}();
 {{#allParams}}
-var {{paramName}} = {{#isListContainer}}[{{/isListContainer}}{{#isBodyParam}}{{dataType}}(){{/isBodyParam}}{{^isBodyParam}}{{{example}}}{{/isBodyParam}}{{#isListContainer}}]{{/isListContainer}}; // {{{dataType}}} | {{{description}}}
+final {{{paramName}}} = {{#isListContainer}}[{{/isListContainer}}{{#isBodyParam}}{{{dataType}}}(){{/isBodyParam}}{{^isBodyParam}}{{{example}}}{{/isBodyParam}}{{#isListContainer}}]{{/isListContainer}}; // {{{dataType}}} | {{{description}}}
 {{/allParams}}
 
 try {
-    {{#returnType}}var result = {{/returnType}}api_instance.{{{operationId}}}({{#allParams}}{{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}});
+    {{#returnType}}final result = {{/returnType}}api_instance.{{{operationId}}}({{#allParams}}{{{paramName}}}{{#hasMore}}, {{/hasMore}}{{/allParams}});
     {{#returnType}}
     print(result);
     {{/returnType}}
 } catch (e) {
-    print("Exception when calling {{classname}}->{{operationId}}: $e\n");
+    print('Exception when calling {{{classname}}}->{{{operationId}}}: $e\n');
 }
 {{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
 ```
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *{{basePath}}*
+All URIs are relative to *{{{basePath}}}*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}/{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{{classname}}}* | [**{{{operationId}}}**]({{{apiDocPath}}}/{{{classname}}}.md#{{{operationIdLowerCase}}}) | **{{{httpMethod}}}** {{{path}}} | {{#summary}}{{{summary}}}{{/summary}}
 {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
 
 ## Documentation For Models
 
-{{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}/{{{classname}}}.md)
+{{#models}}{{#model}} - [{{{classname}}}]({{{modelDocPath}}}/{{{classname}}}.md)
 {{/model}}{{/models}}
 
 ## Documentation For Authorization
@@ -122,7 +122,7 @@ Class | Method | HTTP request | Description
 {{/isApiKey}}
 {{#isBasic}}
 {{#isBasicBasic}}
-- **Type**: HTTP basicc authentication
+- **Type**: HTTP Basic authentication
 {{/isBasicBasic}}
 {{#isBasicBearer}}
 - **Type**: HTTP Bearer authentication
@@ -140,6 +140,6 @@ Class | Method | HTTP request | Description
 
 ## Author
 
-{{#apiInfo}}{{#apis}}{{^hasMore}}{{infoEmail}}
+{{#apiInfo}}{{#apis}}{{^hasMore}}{{{infoEmail}}}
 {{/hasMore}}{{/apis}}{{/apiInfo}}