You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@seatunnel.apache.org by JUN GAO <ga...@apache.org> on 2022/09/02 07:15:15 UTC

Re: [Proposal] Use Spotless for code style management in ST

+1

Lucifer Tyrant <ty...@gmail.com> 于2022年8月30日周二 18:21写道:

> +1, it's a very good advice.
>
> Chao Tian
> BR
>
> CalvinKirs <ac...@163.com> 于2022年8月30日周二 18:20写道:
>
> > Hi,
> > +1, I quite agree with you
> >
> >
> > Best wishes!
> > Calvin Kirs
> >
> >
> > On 08/30/2022 18:14,范佳<fa...@qq.com.INVALID> wrote:
> > +1
> >
> > These features look exciting.
> >
> > ________________________
> >
> > Jia Fan
> >
> >
> >
> > 2022年8月30日 17:54,Chufeng Gao <ch...@gmail.com> 写道:
> >
> > Hi developers,
> >
> > Currently, ST uses the `Checkstyle` plugin for style and formatting
> checks.
> > I propose that we replace `Checkstyle` with `Spotless`.
> >
> > Huge advantage of using `Spotless`[1][2] over `CheckStyle` is in addition
> > to check the formatting of the code it also has `apply` goal that fixes
> all
> > the style and formatting errors automatically with a single line of
> command
> > `mvn spotless:apply`. `Spotless` does not rely on IDE so that
> > new contributors do not have to spend time setting up their IDE with
> > checkstyle.
> > Furthermore, we could configure `git pre-commit hook` to
> > trigger `Spotless` and in this way contributors no more need to worry
> about
> > formatting and style issues as they get fixed automatically
> > when contributors run `git commit xxx`.
> >
> > FYI, we have replaced `Checkstyle` with `Spotless` in the Apache
> > DolphinScheduler project. You could refer to the related issues[3], PRs
> and
> > discussions[4] for details.
> >
> > If you have any suggestions or concerns, you are very welcome to comment
> in
> > this email thread or in issue #2492 [5]
> >
> >
> > [1] https://github.com/diffplug/spotless
> > [2] https://github.com/diffplug/spotless/tree/main/plugin-maven
> > [3] https://github.com/apache/dolphinscheduler/issues/10963
> > [4] https://lists.apache.org/thread/9sqvd1wlfgkyn2y926l732zj1n3z7xkx
> > [5] https://github.com/apache/incubator-seatunnel/issues/2492
> >
> > Thanks!
> >
> > *Best Regards,*
> >
> > *Chufeng (Eric) Gao*
> >
> >
>


-- 

Best Regards

------------

EricJoy2048
gaojun2048@gmail.com

Re: [Proposal] Use Spotless for code style management in ST

Posted by wenjun <we...@apache.org>.
+1

On Fri, Sep 2, 2022 at 3:15 PM JUN GAO <ga...@apache.org> wrote:
>
> +1
>
> Lucifer Tyrant <ty...@gmail.com> 于2022年8月30日周二 18:21写道:
>
> > +1, it's a very good advice.
> >
> > Chao Tian
> > BR
> >
> > CalvinKirs <ac...@163.com> 于2022年8月30日周二 18:20写道:
> >
> > > Hi,
> > > +1, I quite agree with you
> > >
> > >
> > > Best wishes!
> > > Calvin Kirs
> > >
> > >
> > > On 08/30/2022 18:14,范佳<fa...@qq.com.INVALID> wrote:
> > > +1
> > >
> > > These features look exciting.
> > >
> > > ________________________
> > >
> > > Jia Fan
> > >
> > >
> > >
> > > 2022年8月30日 17:54,Chufeng Gao <ch...@gmail.com> 写道:
> > >
> > > Hi developers,
> > >
> > > Currently, ST uses the `Checkstyle` plugin for style and formatting
> > checks.
> > > I propose that we replace `Checkstyle` with `Spotless`.
> > >
> > > Huge advantage of using `Spotless`[1][2] over `CheckStyle` is in addition
> > > to check the formatting of the code it also has `apply` goal that fixes
> > all
> > > the style and formatting errors automatically with a single line of
> > command
> > > `mvn spotless:apply`. `Spotless` does not rely on IDE so that
> > > new contributors do not have to spend time setting up their IDE with
> > > checkstyle.
> > > Furthermore, we could configure `git pre-commit hook` to
> > > trigger `Spotless` and in this way contributors no more need to worry
> > about
> > > formatting and style issues as they get fixed automatically
> > > when contributors run `git commit xxx`.
> > >
> > > FYI, we have replaced `Checkstyle` with `Spotless` in the Apache
> > > DolphinScheduler project. You could refer to the related issues[3], PRs
> > and
> > > discussions[4] for details.
> > >
> > > If you have any suggestions or concerns, you are very welcome to comment
> > in
> > > this email thread or in issue #2492 [5]
> > >
> > >
> > > [1] https://github.com/diffplug/spotless
> > > [2] https://github.com/diffplug/spotless/tree/main/plugin-maven
> > > [3] https://github.com/apache/dolphinscheduler/issues/10963
> > > [4] https://lists.apache.org/thread/9sqvd1wlfgkyn2y926l732zj1n3z7xkx
> > > [5] https://github.com/apache/incubator-seatunnel/issues/2492
> > >
> > > Thanks!
> > >
> > > *Best Regards,*
> > >
> > > *Chufeng (Eric) Gao*
> > >
> > >
> >
>
>
> --
>
> Best Regards
>
> ------------
>
> EricJoy2048
> gaojun2048@gmail.com