Skip to content

WIP: new javascript flowtyped generator #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

cnx-bot
Copy link

@cnx-bot cnx-bot commented May 29, 2018

As discussed in swagger-api/swagger-codegen#5733 there is no generator which outputs Javascript which is properly flow typed and easy to use with React.

Here is it now.

Is is based on the Typescript Fetch Generator, so differs from the other Javascript Generators in code and architecture.

Simply adding flow annotations didn't work with the current js es6 code.

The code is written in ES6 with flow syntax. In order to use it as a library in your react app, it comes with a npm build script to transpile it into node.js and browser compatible es5 syntax with additional .js.flow for flow to use the types properly.

steps to use this client as a npm library:

create yourself a new folder and repo for the client sdk
generate client with java -jar swagger-codegen-cli-2.3.1.jar generate -i swagger.json -l javascript-flowtyped -o
npm install
NODE_ENV=production npm run build
git add .
git commit -m 'update sdk version'
git tag v
git push && git push --tags
in your react app do:
npm install #v
import { * as api } from 'client-sdk-package'
if you want to generate the api directly inside your client-app you can do so. just import the files from the generated src then. these are pure es6 with flow types and need to be transpiled like you would do with the other code.

see swagger-api/swagger-codegen#8101 for reference and discussion.

@cnx-bot cnx-bot changed the title new javascript flowtyped generator WIP: new javascript flowtyped generator May 29, 2018
@cnx-bot
Copy link
Author

cnx-bot commented May 29, 2018

this is a copy of my changes in swagger-api/swagger-codegen#8101 without adjustments to this new project.
@wing328 please advise how to proceed with this PR

@cnx-bot cnx-bot closed this May 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants