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 option to enable scalafmt for code formatting #1032

Merged
merged 2 commits into from
Sep 14, 2018
Merged

Conversation

wing328
Copy link
Member

@wing328 wing328 commented Sep 13, 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

Format Scala code by simply creating an environment variable, e.g. export SCALAFMT_PATH=/usr/local/bin/scalafmt

I've only run ./bin/scala-akka-petstore.sh to update the Scala Akka Petstore sample to demonstrate the formatted Scala code.

We'll undo these changes before merging into master.

cc @clasnake @jimschubert @shijinkui @ramzimaalej

@@ -113,6 +114,10 @@ public AbstractScalaCodegen() {
public void processOpts() {
super.processOpts();

if (StringUtils.isEmpty(System.getenv("SCALAFMT_PATH"))) {
LOGGER.info("Environment variable SCALAFMT_PATH not defined so the Haskell code may not be properly formatted. To define it, try 'export SCALAFMT_PATH=/usr/local/bin/scalafmt' (Linux/Mac)");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the Haskell code do you mean the Scala code?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. Sorry for the copy & paste issue.

I did a search and confirmed there's no reference to Haskell.

@wing328
Copy link
Member Author

wing328 commented Sep 14, 2018

@ramzimaalej thanks for the review. I'll merge the PR after the CI tests pass.

@wing328 wing328 merged commit fc35bb1 into master Sep 14, 2018
@wing328 wing328 deleted the scala_format branch September 14, 2018 09:05
jaumard pushed a commit to jaumard/openapi-generator that referenced this pull request Sep 21, 2018
* add option to enable scalafmt for code formatting

* fix typo
A-Joshi pushed a commit to ihsmarkitoss/openapi-generator that referenced this pull request Feb 27, 2019
* add option to enable scalafmt for code formatting

* fix typo
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.

2 participants