Merge branch 'master' into feature/cancelable

# Conflicts:
#	README.md
#	package.json
#	src/utils/registerHandlebarTemplates.ts
#	test/__snapshots__/index.spec.js.snap
#	test/custom/request.ts
#	test/e2e/v3.fetch.spec.js
#	test/e2e/v3.node.spec.js
#	yarn.lock

Author: ferdikoomen

.circleci/config.yml

@@ -1,31 +1,31 @@
 version: 2
 jobs:
-    build:
-        working_directory: ~/repo
-        docker:
-            - image: circleci/node:latest-browsers
-        steps:
-            - checkout
-            - restore_cache:
-                keys:
-                    - v1-dependencies-{{ checksum "package.json" }}
-                    - v1-dependencies-
-            - run:
-                  name: Install dependencies
-                  command: yarn install
-            - save_cache:
-                key: v1-dependencies-{{ checksum "package.json" }}
-                paths:
-                    - node_modules
-            - run:
-                name: Build library
-                command: yarn run release
-            - run:
-                name: Run unit tests
-                command: yarn run test:coverage
-            - run:
-                name: Run e2e tests
-                command: yarn run test:e2e
-            - run:
-                name: Submit to Codecov
-                command: yarn run codecov
+  build:
+    working_directory: ~/repo
+    docker:
+      - image: circleci/node:latest-browsers
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "package.json" }}
+            - v1-dependencies-
+      - run:
+          name: Install dependencies
+          command: yarn install
+      - save_cache:
+          key: v1-dependencies-{{ checksum "package.json" }}
+          paths:
+            - node_modules
+      - run:
+          name: Build library
+          command: yarn run release
+      - run:
+          name: Run unit tests
+          command: yarn run test:coverage
+      - run:
+          name: Run e2e tests
+          command: yarn run test:e2e
+      - run:
+         name: Submit to Codecov
+         command: yarn run codecov

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: monthly
+    time: "04:00"
+  open-pull-requests-limit: 10
+  ignore:
+    - dependency-name: "@types/node-fetch"
+    - dependency-name: "node-fetch"

.travis.yml

@@ -27,5 +27,5 @@ https://help.github.com/articles/using-pull-requests
 5. Ensure the code is formatted by running: `yarn run eslint:fix`
 6. Commit your changes using a descriptive commit message
 
-After your Pull Request is created, it will automatically be build using Circle CI
-and Travis. When the build is successful then the Pull Request is ready for review.
+After your Pull Request is created, it will automatically be build using Circle CI.
+When the build is successful then the Pull Request is ready for review.

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Ferdi Koomen
+Copyright (c) 2021 Ferdi Koomen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -2,20 +2,19 @@
 
 [![NPM][npm-image]][npm-url]
 [![License][license-image]][license-url]
-[![Build Status][travis-image]][travis-url]
-[![Dependency Status][deps-image]][deps-url]
 [![Coverage][coverage-image]][coverage-url]
 [![Quality][quality-image]][quality-url]
 [![Code Climate][climate-image]][climate-url]
 [![Downloads][downloads-image]][downloads-url]
+[![Build][build-image]][build-url]
 
 > Node.js library that generates Typescript clients based on the OpenAPI specification.
 
 ## Why?
 - Frontend ❤️ OpenAPI, but we do not want to use JAVA codegen in our builds
 - Quick, lightweight, robust and framework agnostic 🚀
 - Supports generation of TypeScript clients
-- Supports generations of fetch and XHR http clients
+- Supports generations of fetch, XHR and Axios http clients
 - Supports OpenAPI specification v2.0 and v3.0
 - Supports JSON and YAML files for input
 - Supports generation through CLI, Node.js and NPX
@@ -41,13 +40,15 @@ $ openapi --help
     -V, --version             output the version number
     -i, --input <value>       OpenAPI specification, can be a path, url or string content (required)
     -o, --output <value>      Output directory (required)
-    -c, --client <value>      HTTP client to generate [fetch, xhr, node] (default: "fetch")
+    -c, --client <value>      HTTP client to generate [fetch, xhr, axios, node] (default: "fetch")
     --useOptions              Use options instead of arguments
     --useUnionTypes           Use union types instead of enums
     --exportCore <value>      Write core files to disk (default: true)
     --exportServices <value>  Write services to disk (default: true)
     --exportModels <value>    Write models to disk (default: true)
     --exportSchemas <value>   Write schemas to disk (default: false)
+    --request <value>         Path to custom request file
+    -h, --help                display help for command
 
   Examples
     $ openapi --input ./spec.json
@@ -404,12 +405,12 @@ as part of your types to ensure everything is able to be TypeScript generated.
 
 External references may be:
 * *relative references* - references to other files at the same ___location e.g.
-    `{ $ref: 'schemas/customer.yml' }`
+  `{ $ref: 'schemas/customer.yml' }`
 * *remote references* - fully qualified references to another remote ___location
-     e.g. `{ $ref: 'https://myexampledomain.com/schemas/customer_schema.yml' }`
+   e.g. `{ $ref: 'https://myexampledomain.com/schemas/customer_schema.yml' }`
 
-    For remote references, both files (when the file is on the current filesystem)
-    and http(s) URLs are supported.
+   For remote references, both files (when the file is on the current filesystem)
+   and http(s) URLs are supported.
 
 External references may also contain internal paths in the external schema (e.g.
 `schemas/collection.yml#/definitions/schemas/Customer`) and back-references to
@@ -420,14 +421,6 @@ At start-up, an OpenAPI or Swagger file with external references will be "bundle
 so that all external references and back-references will be resolved (but local
 references preserved).
 
-### Compare to other generators
-Depending on which swagger generator you use, you will see different output.
-For instance: Different ways of generating models, services, level of quality,
-HTTP client, etc. I've compiled a list with the results per area and how they
-compare against the openapi-typescript-codegen.
-
-[Click here to see the comparison](https://htmlpreview.github.io/?https://github.com/ferdikoomen/openapi-typescript-codegen/blob/master/samples/index.html)
-
 
 FAQ
 ===
@@ -453,14 +446,17 @@ module.exports = {
 
 
 ### Node.js support
+> Since version 3.x [`node-fetch`](https://www.npmjs.com/package/node-fetch) switched to ESM only, breaking many
+> CommonJS based toolchains (like Jest). Right now we do not support this new version!
+
 By default, this library will generate a client that is compatible with the (browser based) [fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API),
 however this client will not work inside the Node.js environment. If you want to generate a Node.js compatible client then
 you can specify `--client node` in the openapi call:
 
 `openapi --input ./spec.json --output ./dist --client node`
 
 This will generate a client that uses [`node-fetch`](https://www.npmjs.com/package/node-fetch) internally. However,
-in order to compile and run this client, you will need to install the `node-fetch` dependencies:
+in order to compile and run this client, you might need to install the `node-fetch@2.x` dependencies:
 
 ```
 npm install @types/node-fetch --save-dev
@@ -483,10 +479,6 @@ in your `tsconfig.json` file.
 [npm-image]: https://img.shields.io/npm/v/openapi-typescript-codegen.svg
 [license-url]: LICENSE
 [license-image]: http://img.shields.io/npm/l/openapi-typescript-codegen.svg
-[travis-url]: https://travis-ci.org/ferdikoomen/openapi-typescript-codegen
-[travis-image]: https://img.shields.io/travis/ferdikoomen/openapi-typescript-codegen.svg
-[deps-url]: https://david-dm.org/ferdikoomen/openapi-typescript-codegen
-[deps-image]: https://img.shields.io/david/ferdikoomen/openapi-typescript-codegen.svg
 [coverage-url]: https://codecov.io/gh/ferdikoomen/openapi-typescript-codegen
 [coverage-image]: https://img.shields.io/codecov/c/github/ferdikoomen/openapi-typescript-codegen.svg
 [quality-url]: https://lgtm.com/projects/g/ferdikoomen/openapi-typescript-codegen
@@ -495,3 +487,5 @@ in your `tsconfig.json` file.
 [climate-image]: https://img.shields.io/codeclimate/maintainability/ferdikoomen/openapi-typescript-codegen.svg
 [downloads-url]: http://npm-stat.com/charts.html?package=openapi-typescript-codegen
 [downloads-image]: http://img.shields.io/npm/dm/openapi-typescript-codegen.svg
+[build-url]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/master
+[build-image]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/master.svg?style=svg

README.md

@@ -12,7 +12,7 @@ const params = program
     .version(pkg.version)
     .requiredOption('-i, --input <value>', 'OpenAPI specification, can be a path, url or string content (required)')
     .requiredOption('-o, --output <value>', 'Output directory (required)')
-    .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node]', 'fetch')
+    .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node, axios]', 'fetch')
     .option('--useOptions', 'Use options instead of arguments')
     .option('--useUnionTypes', 'Use union types instead of enums')
     .option('--exportCore <value>', 'Write core files to disk', true)

bin/index.js

@@ -20,10 +20,12 @@ module.exports = {
             testMatch: [
                 '<rootDir>/test/e2e/v2.fetch.spec.js',
                 '<rootDir>/test/e2e/v2.xhr.spec.js',
+                '<rootDir>/test/e2e/v2.axios.spec.js',
                 '<rootDir>/test/e2e/v2.node.spec.js',
                 '<rootDir>/test/e2e/v2.babel.spec.js',
                 '<rootDir>/test/e2e/v3.fetch.spec.js',
                 '<rootDir>/test/e2e/v3.xhr.spec.js',
+                '<rootDir>/test/e2e/v3.axios.spec.js',
                 '<rootDir>/test/e2e/v3.node.spec.js',
                 '<rootDir>/test/e2e/v3.babel.spec.js',
             ],

jest.config.js

@@ -1,6 +1,6 @@
 {
     "name": "openapi-typescript-codegen",
-    "version": "0.10.0",
+    "version": "0.11.0",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
     "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",
@@ -32,7 +32,6 @@
         }
     ],
     "main": "dist/index.js",
-    "module": "dist/index.js",
     "types": "types/index.d.ts",
     "bin": {
         "openapi": "bin/index.js"
@@ -61,47 +60,48 @@
         "codecov": "codecov --token=66c30c23-8954-4892-bef9-fbaed0a2e42b"
     },
     "dependencies": {
+        "@types/node-fetch": "^2.5.12",
+        "abort-controller": "^3.0.0",
+        "axios": "^0.23.0",
         "camelcase": "^6.2.0",
-        "commander": "^7.0.0",
+        "commander": "^8.0.0",
+        "form-data": "^4.0.0",
         "handlebars": "^4.7.6",
-        "js-yaml": "^4.0.0",
         "json-schema-ref-parser": "^9.0.7",
         "mkdirp": "^1.0.4",
+        "node-fetch": "^2.6.5",
         "rimraf": "^3.0.2"
     },
     "devDependencies": {
-        "@babel/cli": "7.13.10",
-        "@babel/core": "7.13.10",
-        "@babel/preset-env": "7.13.10",
-        "@babel/preset-typescript": "7.13.0",
-        "@rollup/plugin-commonjs": "17.1.0",
-        "@rollup/plugin-node-resolve": "11.2.0",
-        "@types/express": "4.17.11",
-        "@types/jest": "26.0.20",
-        "@types/js-yaml": "4.0.0",
-        "@types/node": "14.14.32",
-        "@types/node-fetch": "2.5.8",
-        "@types/qs": "6.9.6",
-        "@typescript-eslint/eslint-plugin": "4.17.0",
-        "@typescript-eslint/parser": "4.17.0",
-        "abort-controller": "3.0.0",
-        "codecov": "3.8.1",
-        "eslint": "7.21.0",
-        "eslint-config-prettier": "8.1.0",
-        "eslint-plugin-prettier": "3.3.1",
+        "@babel/cli": "7.15.7",
+        "@babel/core": "7.15.8",
+        "@babel/preset-env": "7.15.8",
+        "@babel/preset-typescript": "7.15.0",
+        "@rollup/plugin-commonjs": "21.0.0",
+        "@rollup/plugin-node-resolve": "13.0.5",
+        "@types/express": "4.17.13",
+        "@types/glob": "7.1.4",
+        "@types/jest": "27.0.2",
+        "@types/node": "16.11.1",
+        "@types/qs": "6.9.7",
+        "@typescript-eslint/eslint-plugin": "5.1.0",
+        "@typescript-eslint/parser": "5.1.0",
+        "codecov": "3.8.3",
+        "eslint": "8.0.1",
+        "eslint-config-prettier": "8.3.0",
+        "eslint-plugin-prettier": "4.0.0",
         "eslint-plugin-simple-import-sort": "7.0.0",
         "express": "4.17.1",
-        "form-data": "4.0.0",
-        "glob": "7.1.6",
-        "jest": "26.6.3",
-        "jest-cli": "26.6.3",
-        "node-fetch": "2.6.1",
-        "prettier": "2.2.1",
-        "puppeteer": "8.0.0",
-        "qs": "6.9.6",
-        "rollup": "2.41.0",
+        "glob": "7.2.0",
+        "jest": "27.3.0",
+        "jest-cli": "27.3.0",
+        "prettier": "2.4.1",
+        "puppeteer": "10.4.0",
+        "qs": "6.10.1",
+        "rollup": "2.58.0",
         "rollup-plugin-terser": "7.0.2",
         "rollup-plugin-typescript2": "0.30.0",
-        "typescript": "4.2.3"
+        "tslib": "2.3.1",
+        "typescript": "4.4.4"
     }
 }

package.json

@@ -57,7 +57,7 @@ const getPlugins = () => {
         return plugins;
     }
     return [...plugins, terser()];
-}
+};
 
 module.exports = {
     input: './src/index.ts',