Merge branch 'master' into master

Author: Shinevision

.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

Dockerfile

@@ -0,0 +1,7 @@
+FROM node:alpine
+WORKDIR /usr/src/openapi
+COPY . /usr/src/openapi
+RUN npm install
+RUN npm run release
+ENTRYPOINT [ "node", "/usr/src/openapi/bin/index.js" ]
+CMD "--help"

README.md

@@ -3,8 +3,7 @@
 [![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]
+[![Coverage][coverage-image]][coverage-url]
 [![Downloads][downloads-image]][downloads-url]
 [![Build][build-image]][build-url]
 
@@ -14,7 +13,7 @@
 - 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
@@ -59,6 +58,21 @@ $ openapi --help
     $ openapi --input ./spec.json --output ./generated --client xhr
 ```
 
+## Docker usage
+
+To build the Docker container, execute the following command:
+
+```
+docker build . --tag openapi-typescript-codegen
+```
+
+After this is done, you can execute the CLI commands:
+
+```
+docker run openapi-typescript-codegen --help
+docker run openapi-typescript-codegen --input sample.yaml --output client
+```
+
 Documentation
 ===
 - [Basic usage](docs/basic-usage.md)
@@ -87,10 +101,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

@@ -22,7 +22,6 @@ const params = program
     .option('--exportModels <value>', 'Write models to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
     .option('--indent <value>', 'Indentation options [4, 2, tabs]', '4')
-    .option('--postfix <value>', 'Deprecated: Use --postfixServices instead. 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')
@@ -45,7 +44,7 @@ if (OpenAPI) {
         exportModels: JSON.parse(params.exportModels) === true,
         exportSchemas: JSON.parse(params.exportSchemas) === true,
         indent: params.indent,
-        postfixServices: params.postfixServices ?? params.postfix,
+        postfixServices: params.postfixServices,
         postfixModels: params.postfixModels,
         request: params.request,
     })

bin/index.spec.js

@@ -70,18 +70,4 @@ describe('bin', () => {
         expect(result.stdout.toString()).toContain(`-o, --output <value>`);
         expect(result.stderr.toString()).toBe('');
     });
-
-    it('should still support the deprecated --postfix parameter', () => {
-        const result = crossSpawn.sync('node', [
-            './bin/index.js',
-            '--input',
-            './test/spec/v3.json',
-            '--output',
-            './test/generated/bin',
-            '--postfix',
-            'Service',
-        ]);
-        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",
 ```