kafka-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Matthias J. Sax" <matth...@confluent.io>
Subject Re: Use of a formatter like Scalafmt
Date Wed, 09 May 2018 23:59:14 GMT
Joan,

thanks for starting this initiative. I am overall +1

However, I am worried about applying it to `core` module as the change
is massive. For the Kafka Streams Scala module, that is new and was not
released yet, I am +1.

A personal thing about the style: the 2-space indention for JavaDocs is
a little weird.

/**
 *
 */

is changed to

/**
  *
  */

Not sure if this can be fixed easily in the style file? If not, I am
also fine with the change.

This change also affect the license headers of many files and exposing
that those use the wrong comment format anyway. They should use regular
comments

/*
 *
 */

but not JavaDoc comments

/**
 *
 */

(We fixed this for Java source code in the past already -- maybe it's
time to fix it for Scala code base, too.



-Matthias

On 5/9/18 4:45 PM, Joan Goyeau wrote:
> Hi Ted,
> 
> As far as I understand this is an issue for PRs and back porting the
> changes to other branches.
> 
> Applying the tool to the other branches should also resolve the conflicts
> as the formattings will match, leaving only the actual changes in the diffs.
> That's what we did sometime ago at my work and it went quiet smoothly.
> 
> If we don't want to do a big bang commit then I'm thinking we might want to
> make it gradually by applying it module by module?
> This is one idea do you have any other?
> 
> I know formatting sounds like the useless thing that doesn't matter and I
> totally agree with this, that's why I don't want to care about it while
> coding.
> 
> Thanks
> 
> On Thu, 10 May 2018 at 00:15 Ted Yu <yuzhihong@gmail.com> wrote:
> 
>> Applying the tool across code base would result in massive changes.
>> How would this be handled ?
>> -------- Original message --------From: Joan Goyeau <joan@goyeau.com>
>> Date: 5/9/18  3:31 PM  (GMT-08:00) To: dev@kafka.apache.org Subject: Use
>> of a formatter like Scalafmt
>> Hi,
>>
>> Contributing to Kafka Streams' Scala API, I've been kinda lost on how
>> should I format my code.
>> I know formatting is the start of religion wars but personally I have no
>> preference at all. I just want consistency across the codebase, no
>> unnecessary formatting diffs in PRs and offload the formatting to a tool
>> that will do it for me and concentrate on what matters (not formatting).
>>
>> So I opened the following PR where I put arbitrary rules in .scalafmt.conf
>> <
>> https://github.com/apache/kafka/pull/4965/files#diff-8af3e1355c23c331ee2b848e12c5219f
>>>
>> :
>> https://github.com/apache/kafka/pull/4965
>>
>> Please let me know what do you think and if we can move this forward and
>> settle something.
>>
>> Thanks
>>
> 


Mime
View raw message