matthiasmargot/typegen

Generate source-code types from a swagger-specification file

Swagger Typegen

Install

Run yarn to install dependencies.

Global npm install

Typegen is globally installable as an npm cli tool.

To install it run npm link from the root of the project.

How to generate the type file

typegen example/input.json -o example/output.ts

Parameters

• input (required) - The path to swagger file in JSON format
• -o, --output [filename] (optional) - the path to the output file. By skipping this param, the output is returned in the terminal.

typegen's Issues

Provide possibility of logging output generated from typegen to the console instead of interacting with the file-system

This is necessary to support the following use-cases:

• appending the generated output to an already existing file
• funneling the output of this tool into further processing

One proposal is to add an optional flag which instructs the tool not to write the generated output to the file-system but to instead log it back to the console:

typegen input.json --log

# take the output and do something additional with it
# such as appending it to an already existing file
typegen input.json --log >> outpu.ts

Configure linting setup

If you tackle this, tackle it with ESLint.

Restore support for yaml files

There's a dependency specified for this project called "swagger-parser" that's currently not used.
It was introduced to support yaml as the input format for source-files that typegen should parse.
Currently typegen only supports json format.

Support for yaml should be added, some options for API implementation:

1. add an optional "type" / "extension" flag to the CLI defaulting to json
2. figure out the file-type based on its contents, for this case it should be fine to assume a limitation to only json/yaml
3. figure out the file-type based on the extension provided in the input & output file-path arguments (this is un-desirable since it forces the user to specify file extensions in the argument, that shouldn't be necessary)

Configure unit testing setup

If you tackle this, tackle it with Jest.