Merge remote-tracking branch 'upstream/master' into custom-templates

Author: josh-hemphill

.circleci/config.yml

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

.github/workflows/codeql.yml

@@ -0,0 +1,41 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron: "44 20 * * 3"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ javascript ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          queries: +security-and-quality
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{ matrix.language }}"

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.24.0] - 2023-04-10
+### Fixed
+- Upgraded dependencies
+- Fixed issue with Cancelable promise
+- Fixed issue with escaping reserved keywords in schema names
+### Added
+- Added `--postfixModels` option
+
 ## [0.23.0] - 2022-06-02
 ### Fixed
 - Upgraded dependencies

README.md

@@ -17,8 +17,6 @@ To release a new version, run `npm run release` and push everything, including t
 [![NPM][npm-image]][npm-url]
 [![License][license-image]][license-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]
 
@@ -28,7 +26,7 @@ To release a new version, run `npm run release` and push everything, including t
 - 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, [Node-Fetch](#node-fetch-support), [Axios](#axios-support), [Angular](#angular-support) and XHR http clients
+- Supports generations of Fetch, Node-Fetch, Axios, Angular and XHR 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
@@ -62,7 +60,8 @@ $ openapi --help
     --exportModels <value>    Write models to disk (default: true)
     --exportSchemas <value>   Write schemas to disk (default: false)
     --indent <value>          Indentation options [4, 2, tab] (default: "4")
-    --postfix <value>         Service name postfix (default: "Service")
+    --postfixServices         Service name postfix (default: "Service")
+    --postfixModels           Model name postfix
     --request <value>         Path to custom request file
     --serviceTemplate         Path to custom service handlebars template to generate the service files
     -h, --help                display help for command
@@ -100,10 +99,6 @@ Support
 [license-image]: http://img.shields.io/npm/l/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
-[quality-image]: https://img.shields.io/lgtm/grade/javascript/g/ferdikoomen/openapi-typescript-codegen.svg
-[climate-url]: https://codeclimate.com/github/ferdikoomen/openapi-typescript-codegen
-[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

bin/index.js

@@ -23,7 +23,8 @@ const params = program
     .option('--exportIndex <value>', 'Write Index to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
     .option('--indent <value>', 'Indentation options [4, 2, tabs]', '4')
-    .option('--postfix <value>', 'Service name postfix', 'Service')
+    .option('--postfixServices <value>', 'Service name postfix', 'Service')
+    .option('--postfixModels <value>', 'Model name postfix')
     .option('--request <value>', 'Path to custom request file')
     .option('--serviceTemplate <value>', 'Path to custom service handlebars template to generate the service files')
     .option('--clientTemplate <value>', 'Path to custom client handlebars template to generate the client file')
@@ -48,7 +49,8 @@ if (OpenAPI) {
         exportIndex: JSON.parse(params.exportIndex) === true,
         exportSchemas: JSON.parse(params.exportSchemas) === true,
         indent: params.indent,
-        postfix: params.postfix,
+        postfixServices: params.postfixServices,
+        postfixModels: params.postfixModels,
         request: params.request,
         serviceTemplate: params.serviceTemplate,
         clientTemplate: params.clientTemplate,

bin/index.spec.js

@@ -34,8 +34,10 @@ describe('bin', () => {
             'true',
             '--indent',
             '4',
-            '--postfix',
+            '--postfixServices',
             'Service',
+            '--postfixModels',
+            'Dto',
         ]);
         expect(result.stdout.toString()).toBe('');
         expect(result.stderr.toString()).toBe('');

docs/angular-support.md

@@ -9,8 +9,8 @@ If you want to generate the Angular based client then you can specify `--client
 The Angular client has been tested with the following versions:
 
 ```
-"@angular/common": "14.0.x",
-"@angular/core": "14.0.x",
+"@angular/common": "15.0.x",
+"@angular/core": "15.0.x",
 "rxjs": "7.5.x",
 ```
 

docs/basic-usage.md

@@ -18,7 +18,8 @@ $ openapi --help
     --exportModels <value>    Write models to disk (default: true)
     --exportSchemas <value>   Write schemas to disk (default: false)
     --indent <value>          Indentation options [4, 2, tab] (default: "4")
-    --postfix <value>         Service name postfix (default: "Service")
+    --postfixServices         Service name postfix (default: "Service")
+    --postfixModels           Model name postfix
     --request <value>         Path to custom request file
     -h, --help                display help for command