Added custom options to typescript-axios generator

- (generator/typescript-axios) Added npmName, npmVersion, and npmRepository custom options support
- (templates/typescript-axios) Minor style improvements
- (docs) Fixed typos in README.md

Author: DonIsaac

README.md

@@ -7,7 +7,7 @@
 ## Overview
 **Swagger Codegen Generators** project is a set of classes and templates ([Handlebars](https://jknack.github.io/handlebars.java)) used by [Swagger Codegen 3.0.0 project](https://github.com/swagger-api/swagger-codegen/tree/3.0.0) in its code generation process for a specific language or language framework. The main differents with **Swagger Codegen 2.x.x** are:
 
-- **Handlebars as template engine:** with Handelbars feature is possible to create more logic-less templates.
+- **Handlebars as template engine:** with Handlebars feature is possible to create more logic-less templates.
 - **OAS 3 support:** generator classes work with OpenAPI Specification V3.
 
 More details about these and more differences are referenced at [https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.0](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.0)
@@ -18,16 +18,16 @@ You need the following installed and available in your $PATH:
 * Java 8 (http://java.oracle.com)
 * Apache maven 3.0.4 or greater (http://maven.apache.org/)
 
-## How to contribute.
-Right now the templates and generators classes are migrated from  [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) **3.0.0** branch. 
+## How to Contribute.
+Right now the templates and generators classes are migrated from  [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) **3.0.0** branch.
 If you want to migrate an existing language/framework, you can follow this [guide](https://github.com/swagger-api/swagger-codegen/wiki/Swagger-Codegen-migration-(swagger-codegen-generators-repository)).
-Also you need to keep in mind that **Handlebars** is used as template engines and besides it's pretty similar to **Mustache** there are different that can not be ignored. So you can follow this [guide](https://github.com/swagger-api/swagger-codegen/wiki/Swagger-Codegen-migration-from-Mustache-and-Handlebars-templates.) which explains steps to migrate templates from **Mustaches** to **Handelbars**.
+Also you need to keep in mind that **Handlebars** is used as the template engine. It's pretty similar to **Mustache**, but there are differences that can not be ignored. So you can follow this [guide](https://github.com/swagger-api/swagger-codegen/wiki/Swagger-Codegen-migration-from-Mustache-and-Handlebars-templates.) which explains steps to migrate templates from **Mustaches** to **Handlebars**.
 
-## Security contact
+## Security Contact
 
 Please disclose any security-related issues or vulnerabilities by emailing [[email protected]](mailto:[email protected]), instead of using the public issue tracker.
 
-## License information on Generated Code
+## License Information on Generated Code
 
 The Swagger Codegen project is intended as a benefit for users of the Swagger / Open API Specification.  The project itself has the [License](#license) as specified.  In addition, please understand the following points:
 

src/main/java/io/swagger/codegen/v3/generators/typescript/TypeScriptAxiosClientCodegen.java

@@ -19,11 +19,15 @@
 public class TypeScriptAxiosClientCodegen extends AbstractTypeScriptClientCodegen {
 
     public static final String NPM_NAME = "npmName";
+    public static final String NPM_VERSION = "npmVersion";
     public static final String NPM_REPOSITORY = "npmRepository";
     public static final String DEFAULT_API_PACKAGE = "apis";
     public static final String DEFAULT_MODEL_PACKAGE = "models";
 
     protected String npmRepository = null;
+    protected String npmName = null;
+    protected String npmVersion = "1.0.0";
+
 
     private String tsModelPackage = "";
 
@@ -34,6 +38,12 @@ public TypeScriptAxiosClientCodegen() {
         LOGGER.info("Template folder: " + this.templateDir());
         LOGGER.info("Template engine: " + this.getTemplateEngine());
         reservedWords.add("query");
+
+        // Custom CLI options
+        this.cliOptions.add(new CliOption(NPM_NAME, "The name under which you want to publish generated npm package"));
+        this.cliOptions.add(new CliOption(NPM_VERSION, "The version of your npm package. Defaults to 1.0.0"));
+        this.cliOptions.add(new CliOption(NPM_REPOSITORY,
+                "Use this property to set an url your private npm registry in the package.json"));
     }
 
     @Override
@@ -46,14 +56,14 @@ public String getHelp() {
         return "Generates a TypeScript Axios client library.";
     }
 
-    public String getNpmRepository() {
-        return npmRepository;
-    }
-
-    public void setNpmRepository(String npmRepository) {
-        this.npmRepository = npmRepository;
-    }
-
+    /**
+     * Creates a relative path to a file or folder. The resulting path is
+     * relative to the root directory of the final client library.
+     *
+     * @param path The path to the file or folder.
+     * @return A path to the file or folder which is relative to the client
+     * library root directory.
+     */
     private static String getRelativeToRoot(String path) {
         StringBuilder sb = new StringBuilder();
         int slashCount = path.split("/").length;
@@ -102,6 +112,8 @@ public void processOpts() {
         supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
         supportingFiles.add(new SupportingFile("package.mustache", "", "package.json"));
         supportingFiles.add(new SupportingFile("tsconfig.mustache", "", "tsconfig.json"));
+
+        addNpmPackageGeneration();
     }
 
     @Override
@@ -194,6 +206,31 @@ public Map<String, Object> postProcessModels(Map<String, Object> objs) {
         return objs;
     }
 
+    /**
+     * Extracts npm package fields from `additionalProperties`. These fields
+     * are provided as custom CLI options.
+     */
+    private void addNpmPackageGeneration() {
+        // Name of the NPM package
+        if (additionalProperties.containsKey(NPM_NAME)) {
+            this.setNpmName(additionalProperties.get(NPM_NAME).toString());
+        }
+
+        // NPM package version (SemVer)
+        if (additionalProperties.containsKey(NPM_VERSION)) {
+            this.setNpmVersion(additionalProperties.get(NPM_VERSION).toString());
+        }
+        /* Package version has default value. Make internal version and
+         * additionalProperties version consistent.
+         */
+        additionalProperties.put(NPM_VERSION, npmVersion);
+
+        // NPM registry the package is pushed to
+        if (additionalProperties.containsKey(NPM_REPOSITORY)) {
+            this.setNpmRepository(additionalProperties.get(NPM_REPOSITORY).toString());
+        }
+    }
+
     /**
      * Overriding toRegularExpression() to avoid escapeText() being called,
      * as it would return a broken regular expression if any escaped character / metacharacter were present.
@@ -217,4 +254,44 @@ public String toApiFilename(String name) {
     public String getDefaultTemplateDir() {
         return "typescript-axios";
     }
+
+    /**
+     * Gets the name of the generated NPM package.
+     *
+     * @return The NPM package name.
+     */
+    public String getNpmName() {
+        return this.npmName;
+    }
+
+    public void setNpmName(String npmName) {
+       this.npmName = npmName;
+    }
+
+    /**
+     * Gets the generated NPM package SemVer string.
+     *
+     * @return The package version.
+     */
+    public String getNpmVersion() {
+        return this.npmVersion;
+    }
+
+    public void setNpmVersion(String npmVersion) {
+        this.npmVersion = npmVersion;
+    }
+
+    /**
+     * Gets the name of the NPM registry the package is published to.
+     *
+     * @return The NPM registry name.
+     */
+    public String getNpmRepository() {
+        return this.npmRepository;
+    }
+
+    public void setNpmRepository(String npmRepository) {
+        this.npmRepository = npmRepository;
+    }
+
 }

src/main/resources/handlebars/typescript-axios/apiInner.mustache

@@ -11,6 +11,7 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
 import { {{import}} } from '{{apiRelativeToRoot}}{{tsModelPackage}}';
 {{/imports}}
 {{#operations}}
+
 /**
  * {{classname}} - axios parameter creator{{#description}}
  * {{&description}}{{/description}}
@@ -22,13 +23,16 @@ export const {{classname}}AxiosParamCreator = (configuration?: Configuration) =>
 
     /**
      * {{&notes}}
+     *
     {{#summary}}
      * @summary {{&summary}}
+     *
     {{/summary}}
     {{#parameters}}
      * @param {{braces "left"}}{{{dataType}}}{{braces "right"}} {{^required}}[{{/required}}{{paramName}}{{^required}}]{{/required}} {{description}}
     {{/parameters}}
      * @param {*} [options] Override http request option.
+     *
      * @throws {RequiredError}
      */
     {{nickname}}: async ({{#parameters}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/parameters}}options: any = {}): Promise<RequestArgs> => {

src/main/resources/handlebars/typescript-axios/configuration.mustache

@@ -12,40 +12,48 @@ export interface ConfigurationParameters {
 }
 
 export class Configuration {
+
     /**
      * parameter for apiKey security
+     *
      * @param name security name
      * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+
     /**
      * parameter for basic security
      *
      * @type {string}
      * @memberof Configuration
      */
     username?: string;
+
     /**
      * parameter for basic security
      *
      * @type {string}
      * @memberof Configuration
      */
     password?: string;
+
     /**
      * parameter for oauth2 security
+     *
      * @param name security name
      * @param scopes oauth2 scope
      * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+
     /**
      * override base path
      *
      * @type {string}
      * @memberof Configuration
      */
     basePath?: string;
+
     /**
      * base options for axios calls
      *