Merge pull request #52 from nicolas-chaulet/fix/remove-indent

fix(cli): remove indent option

Author: mrlubos

.eslintrc.json

@@ -1,6 +1,10 @@
 {
     "parser": "@typescript-eslint/parser",
-    "extends": ["plugin:@typescript-eslint/recommended", "plugin:prettier/recommended", "prettier"],
+    "extends": [
+        "plugin:@typescript-eslint/recommended",
+        "plugin:prettier/recommended",
+        "prettier"
+    ],
     "env": {
         "es6": true,
         "node": true,

.gitignore

@@ -6,13 +6,18 @@ junit.xml
 .DS_Store
 .tmp
 .idea
+
+# IDE config
 .vscode
+
 *.iml
 dist
 coverage
-test/generated
-test/e2e/generated
 samples/generated
 samples/swagger-codegen-cli-v2.jar
 samples/swagger-codegen-cli-v3.jar
 .env
+
+# test files
+test/generated
+test/e2e/generated

.prettierignore

@@ -1,28 +1,19 @@
-# Why The Fork?
+# OpenAPI TypeScript Codegen
 
-Mainly, it's because the original project maintainer [doesn't have time](https://github.com/ferdikoomen/openapi-typescript-codegen/issues/1276#issuecomment-1302392146) to support the project. We wanted to keep the development going since this library became incompatible with [FastAPI v0.99.0 release](https://fastapi.tiangolo.com/release-notes/#0990) that introduced support for OpenAPI v3.1. While that was the main objective, this fork also offers other features such as:
+> ✨ Turn your OpenAPI specification into a beautiful TypeScript client
 
-- correct handling of 204 response status codes
-- ability to select which services to export and naming strategies for generated methods
-- support for non-ASCII characters
-- support for x-body-name header (compatible with Connexion v3.x)
-- ability to autoformat output with Prettier
+## About
 
-# OpenAPI Typescript Codegen
+This is an opinionated fork of the [openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen) package. We created it after the original project became [unmaintained](https://github.com/ferdikoomen/openapi-typescript-codegen/issues/1276#issuecomment-1302392146) because we wanted to support OpenAPI v3.1 introduced in the FastAPI [v0.99.0](https://fastapi.tiangolo.com/release-notes/#0990) release. We plan to resolve the most pressing issues in the original project – open an issue if you'd like to prioritise your use case!
 
-> Node.js library that generates Typescript clients based on the OpenAPI specification.
+## Features
 
-## 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, Node-Fetch, Axios, Angular and XHR http clients
-- Supports OpenAPI specification v2.0 and v3.0 (v3.1 is partially supported)
-- Supports JSON and YAML files for input
-- Supports generation through CLI, Node.js and npx
-- Supports tsc and @babel/plugin-transform-typescript
-- Supports aborting of requests (cancelable promise pattern)
-- Supports external references using [json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser/)
+- generate TypeScript clients from OpenAPI v2.0, v3.0, and v3.1 specifications
+- support JSON or YAML input files
+- handle external references using [JSON Schema $Ref Parser](https://github.com/APIDevTools/json-schema-ref-parser/)
+- generate Fetch, Node-Fetch, Axios, Angular, or XHR HTTP clients
+- can be used with CLI, Node.js, or npx
+- abortable requests through cancellable promise pattern
 
 ## Install
 
@@ -33,7 +24,7 @@ npm install @nicolas-chaulet/openapi-typescript-codegen --save-dev
 or
 
 ```
-yarn add -D @nicolas-chaulet/openapi-typescript-codegen
+yarn add @nicolas-chaulet/openapi-typescript-codegen -D
 ```
 
 ## Usage
@@ -55,7 +46,7 @@ $ openapi --help
     --exportModels <value>    Write models to disk [true, false, regexp] (default: true)
     --exportSchemas <value>   Write schemas to disk (default: false)
     --base <value>            Manually set base in OpenAPI config instead of inferring from server value
-    --indent <value>          Indentation options [4, 2, tab] (default: "4")
+    --no-autoformat           Disable processing generated files with formatter
     --postfixServices         Service name postfix (default: "Service")
     --postfixModels           Model name postfix
     --request <value>         Path to custom request file
@@ -68,8 +59,24 @@ $ openapi --help
     $ openapi --input ./spec.json --output ./generated --client xhr
 ```
 
-Documentation
-===
+## Formatting
+
+If you use Prettier, your client will be automatically formatted according to your configuration. To disable automatic formatting, run
+
+```sh
+openapi --input path/to/openapi.json --output src/client --no-autoformat
+```
+
+To prevent your client from being processed by linters and similar tools, you should add your output path to the tool's ignore file (e.g. `.eslintignore`).
+
+## Contributing
+
+This section is WIP.
+
+- recommend using VS Code
+- configure Prettier
+
+## Documentation
 
 The original documentation can be found in the [openapi-typescript-codegen/wiki](https://github.com/ferdikoomen/openapi-typescript-codegen/wiki)
 

README.md

@@ -15,13 +15,12 @@ const params = program
     .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node, axios, angular]', 'fetch')
     .option('--name <value>', 'Custom client class name')
     .option('--useOptions [value]', 'Use options instead of arguments', false)
-    .option('--autoformat', 'Process generated files with autoformatter', false)
     .option('--base [value]', 'Manually set base in OpenAPI config instead of inferring from server value')
+    .option('--no-autoformat', 'Disable processing generated files with formatter')
     .option('--exportCore <value>', 'Write core files to disk', true)
     .option('--exportServices <value>', 'Write services to disk', true)
     .option('--exportModels <value>', 'Write models to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
-    .option('--indent <value>', 'Indentation options [4, 2, tab]', '4')
     .option('--postfixServices <value>', 'Service name postfix', 'Service')
     .option('--serviceResponse [value]', 'Define shape of returned value from service calls')
     .option('--useDateType <value>', 'Output Date instead of string for the format "date-time" in the models', false)
@@ -44,7 +43,6 @@ const parseBooleanOrString = value => {
 if (OpenAPI) {
     OpenAPI.generate({
         ...params,
-        autoformat: JSON.parse(params.autoformat) === true,
         clientName: params.name,
         exportCore: JSON.parse(params.exportCore) === true,
         exportModels: parseBooleanOrString(params.exportModels),

bin/index.js

@@ -31,8 +31,6 @@ describe('bin', () => {
             'true',
             '--exportSchemas',
             'true',
-            '--indent',
-            '4',
             '--postfixServices',
             'Service',
             '--postfixModels',
@@ -65,7 +63,6 @@ describe('bin', () => {
             './test/spec/v3.json',
             '--output',
             './test/generated/bin',
-            '--autoformat',
         ]);
         expect(result.stdout.toString()).toBe('');
         expect(result.stderr.toString()).toBe('');

bin/index.spec.js

@@ -1,11 +1,10 @@
 import { HttpClient } from '../../HttpClient';
-import { Indent } from '../../Indent';
 
 export type ServiceResponse = 'body' | 'generics' | 'response';
 
 export interface Options {
     /**
-     * Process generated files with autoformatter
+     * Process generated files with formatter?
      */
     autoformat?: boolean;
     /**
@@ -36,10 +35,6 @@ export interface Options {
      * The selected httpClient (fetch, xhr, node or axios)
      */
     httpClient?: HttpClient;
-    /**
-     * Indentation options (4, 2 or tab)
-     */
-    indent?: Indent;
     /**
      * The relative location of the OpenAPI spec
      */

src/Indent.ts

@@ -1,14 +1,12 @@
 import type { Options } from './client/interfaces/Options';
 import { HttpClient } from './HttpClient';
-import { Indent } from './Indent';
 import { getOpenApiSpec } from './utils/getOpenApiSpec';
 import { getOpenApiSpecParser } from './utils/getOpenApiSpecParser';
 import { postProcessClient } from './utils/postProcessClient';
 import { registerHandlebarTemplates } from './utils/registerHandlebarTemplates';
 import { writeClient } from './utils/writeClient';
 
 export { HttpClient } from './HttpClient';
-export { Indent } from './Indent';
 
 /**
  * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the
@@ -18,12 +16,12 @@ export { Indent } from './Indent';
  */
 export const generate = async (options: Options): Promise<void> => {
     const {
+        autoformat = true,
         exportCore = true,
         exportModels = true,
         exportSchemas = false,
         exportServices = true,
         httpClient = HttpClient.FETCH,
-        indent = Indent.SPACE_4,
         postfixModels = '',
         postfixServices = 'Service',
         serviceResponse = 'body',
@@ -44,12 +42,12 @@ export const generate = async (options: Options): Promise<void> => {
     if (write) {
         await writeClient(clientFinal, templates, {
             ...options,
+            autoformat,
             exportCore,
             exportModels,
             exportSchemas,
             exportServices,
             httpClient,
-            indent,
             postfixModels,
             postfixServices,
             serviceResponse,

src/client/interfaces/Options.d.ts

@@ -1,5 +1,3 @@
-{{>header}}
-
 {{#equals @root.httpClient 'angular'}}
 import { NgModule} from '@angular/core';
 import { HttpClientModule } from '@angular/common/http';