Skip to content
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

Add js-beautify support to JS generator #961

Merged
merged 3 commits into from
Sep 8, 2018
Merged

Add js-beautify support to JS generator #961

merged 3 commits into from
Sep 8, 2018

Conversation

wing328
Copy link
Member

@wing328 wing328 commented Sep 4, 2018

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.3.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

To turn on the feature, please setup the environment variabel: export JS_BEAUTIFY_PATH=/usr/local/bin/js-beautify

e.g.

[main] INFO  o.o.codegen.AbstractGenerator - writing file /Users/williamcheng/Code/openapi-generator/samples/client/petstore/javascript/docs/PetApi.md
[main] INFO  o.o.codegen.AbstractGenerator - writing file /Users/williamcheng/Code/openapi-generator/samples/client/petstore/javascript/src/api/StoreApi.js
[main] INFO  o.o.c.l.JavascriptClientCodegen - Successfully executed: /usr/local/bin/js-beautify -r -f /Users/williamcheng/Code/openapi-generator/samples/client/petstore/javascript/src/api/StoreApi.js

cc @CodeNinjai (2017/07) @frol (2017/07) @cliffano (2017/07)

@cliffano
Copy link
Contributor

cliffano commented Sep 5, 2018

LGTM, but just curious, does the CI build actually run and test the generated petstore? (beyond generating the code)
Wondering if there's any, however unlikely, possibility of beautification causing any unexpected issue.

@wing328
Copy link
Member Author

wing328 commented Sep 5, 2018

@cliffano yes, there are integration tests, e.g. https://github.com/OpenAPITools/openapi-generator/blob/master/samples/client/petstore/javascript/test/api/PetApi.spec.js

@wing328 wing328 merged commit 47b3210 into master Sep 8, 2018
@wing328 wing328 deleted the js_code_better branch September 8, 2018 10:06
jaumard pushed a commit to jaumard/openapi-generator that referenced this pull request Sep 21, 2018
* add js-beautify support to JS generator

* replace tab with space

* update samples without JS_BEAUTIFY_PATH
@wing328
Copy link
Member Author

wing328 commented Oct 1, 2018

BREAKING CHANGE: we'll later rename the environment variable to JS_POST_PROCESS_FILE to make it consistent with other generators.

A-Joshi pushed a commit to ihsmarkitoss/openapi-generator that referenced this pull request Feb 27, 2019
* add js-beautify support to JS generator

* replace tab with space

* update samples without JS_BEAUTIFY_PATH
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants