Scala Formatting

[Narigo]

It would be great if you'd use a formatter for the Scala code. There are some files where the white spaces look somehow chaotic.

For example: https://github.com/vert-x/mod-lang-scala/blob/master/src/test/scala/org/vertx/scala/tests/FileSystemTest.scala

or https://github.com/vert-x/mod-lang-scala/blob/master/src/main/scala/org/vertx/scala/core/file/FileSystem.scala

[raniejade]

I totally agree, we should have guidelines for this.

[Narigo]

Here is the formatter we use in our Scala projects. If you want to use them? ;)

#Scalariform formatter preferences
#Thu Mar 21 13:48:49 CET 2013
alignParameters=false
formatXml=true
preserveDanglingCloseParenthesis=false
spaceInsideBrackets=false
indentWithTabs=false
spaceInsideParentheses=false
multilineScaladocCommentsStartOnFirstLine=false
alignSingleLineCaseStatements=false
compactStringConcatenation=false
placeScaladocAsterisksBeneathSecondAsterisk=false
indentPackageBlocks=true
compactControlReadability=false
spacesWithinPatternBinders=true
alignSingleLineCaseStatements.maxArrowIndent=40
doubleIndentClassDeclaration=false
preserveSpaceBeforeArguments=false
spaceBeforeColon=false
rewriteArrowSymbols=false
indentLocalDefs=false
indentSpaces=2

[nfmelendez]

yeah +1

[nfmelendez]

Would be good to also add a style checker:
http://www.scalastyle.org/

to the building, but hope it doesn't make it even slower...

Any experience using that style checker @Narigo ?

[Narigo]

@nfmelendez I just imported use the pasted properties file in my Eclipse Scala IDE. I did not use extra style checking plugins, sorry.

[raniejade]

I don't think we need a specific formatter, as it may complicate things. I'm pretty sure, we are not using the same IDE. We just need some guidelines and configure your IDE or an external formatter to follow those guidelines.

[nfmelendez]

Yeah, that is what i want to do with the formater part of the building, Collaborators can develop with any text editor they want as long as the build + test + checkstyle pases.

[edgarchan]

well, i think nested callbacks doesn't look much aesthetic even when properly formatting is used

https://gist.github.com/edgarchan/5897738

any way its good idea adopt a common practice.. thanks for the formatter preferences i'll use them more often

[edgarchan]

@nfmelendez a gradle task?

[swilliams-pivotal]

Using the same prefs should be sufficient; they are the defaults in the Eclipse Scala plugin from what I can tell.

[galderz]

I think we should definitely integrate ScalaStyle (https://github.com/scalastyle/scalastyle) at some point so that all the style is validated and we all agree to some settings. This way, the style stops becoming something subjective :). I know the guy who has developed it, he lives in Switzerland too and I see him from time to time in Lausanne Scala Enthousiasts group meetings.

In other Scala projects, I've basically tried to stick to the guidelines in http://docs.scala-lang.org/style/. I think it'd make sense to adhere to official Scala style guidelines?

[swilliams-pivotal]

+1 for official Scala formatting style

On 4 July 2013 14:05, Galder Zamarreño notifications@github.com wrote:

I think we should definitely integrate ScalaStyle (
https://github.com/scalastyle/scalastyle) at some point so that all the
style is validated and we all agree to some settings. This way, the style
stops becoming something subjective :). I know the guy who has developed
it, he lives in Switzerland too and I see him from time to time in Lausanne
Scala Enthousiasts group meetings.

In other Scala projects, I've basically tried to stick to the guidelines
in http://docs.scala-lang.org/style/. I think it'd make sense to adhere
to official Scala style guidelines?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/13#issuecomment-20475899
.

[galderz]

We discussed this on IRC earlier, here's a summary of what was discussed. Nothing new, just have to get it done :)