You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by GitBox <gi...@apache.org> on 2022/08/26 07:52:00 UTC

[GitHub] [incubator-seatunnel] lhyundeadsoul opened a new pull request, #2535: add CheckStyle-IDEA Plugin introduction

lhyundeadsoul opened a new pull request, #2535:
URL: https://github.com/apache/incubator-seatunnel/pull/2535

   CheckStyle-IDEA Plugin
   
   <!--
   
   Thank you for contributing to SeaTunnel! Please make sure that your code changes
   are covered with tests. And in case of new features or big changes
   remember to adjust the documentation.
   
   Feel free to ping committers for the review!
   
   ## Contribution Checklist
   
     - Make sure that the pull request corresponds to a [GITHUB issue](https://github.com/apache/incubator-seatunnel/issues).
   
     - Name the pull request in the form "[Feature] [component] Title of the pull request", where *Feature* can be replaced by `Hotfix`, `Bug`, etc.
   
     - Minor fixes should be named following this pattern: `[hotfix] [docs] Fix typo in README.md doc`.
   
   -->
   
   ## Purpose of this pull request
   
   <!-- Describe the purpose of this pull request. For example: This pull request adds checkstyle plugin.-->
   
   ## Check list
   
   * [ ] Code changed are covered with tests, or it does not need tests for reason:
   * [ ] If any new Jar binary package adding in your PR, please add License Notice according
     [New License Guide](https://github.com/apache/incubator-seatunnel/blob/dev/docs/en/contribution/new-license.md)
   * [ ] If necessary, please update the documentation to describe the new feature. https://github.com/apache/incubator-seatunnel/tree/dev/docs
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [incubator-seatunnel] lhyundeadsoul commented on a diff in pull request #2535: add CheckStyle-IDEA Plugin introduction

Posted by GitBox <gi...@apache.org>.
lhyundeadsoul commented on code in PR #2535:
URL: https://github.com/apache/incubator-seatunnel/pull/2535#discussion_r955803238


##########
docs/en/contribution/setup.md:
##########
@@ -46,6 +46,12 @@ See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plug
 Before running the following example, you should also install JetBrains IntelliJ IDEA's [Lombok plugin](https://plugins.jetbrains.com/plugin/6317-lombok).
 See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html#install-plugins) if you want to.
 
+### Install JetBrains IDEA CheckStyle-IDEA Plugin
+
+Before coding, you should also install JetBrains IntelliJ IDEA's [CheckStyle-IDEA plugin](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea).
+See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html#install-plugins) if you want to.
+Next, you should go to `Preferences -> Editor -> Code style -> Scheme -> Import Scheme -> CheckStyle Configration` and import `tools/checkstyle/checkStyle.xml`

Review Comment:
   Do you mean I should add `If the user wants to change to automatic formatting, these configurations are also required`  to the doc?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [incubator-seatunnel] CalvinKirs merged pull request #2535: add CheckStyle-IDEA Plugin introduction

Posted by GitBox <gi...@apache.org>.
CalvinKirs merged PR #2535:
URL: https://github.com/apache/incubator-seatunnel/pull/2535


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [incubator-seatunnel] CalvinKirs commented on a diff in pull request #2535: add CheckStyle-IDEA Plugin introduction

Posted by GitBox <gi...@apache.org>.
CalvinKirs commented on code in PR #2535:
URL: https://github.com/apache/incubator-seatunnel/pull/2535#discussion_r955803989


##########
docs/en/contribution/setup.md:
##########
@@ -46,6 +46,12 @@ See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plug
 Before running the following example, you should also install JetBrains IntelliJ IDEA's [Lombok plugin](https://plugins.jetbrains.com/plugin/6317-lombok).
 See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html#install-plugins) if you want to.
 
+### Install JetBrains IDEA CheckStyle-IDEA Plugin
+
+Before coding, you should also install JetBrains IntelliJ IDEA's [CheckStyle-IDEA plugin](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea).
+See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html#install-plugins) if you want to.
+Next, you should go to `Preferences -> Editor -> Code style -> Scheme -> Import Scheme -> CheckStyle Configration` and import `tools/checkstyle/checkStyle.xml`

Review Comment:
   yes



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [incubator-seatunnel] ic4y commented on pull request #2535: add CheckStyle-IDEA Plugin introduction

Posted by GitBox <gi...@apache.org>.
ic4y commented on PR #2535:
URL: https://github.com/apache/incubator-seatunnel/pull/2535#issuecomment-1228267990

   checkstyle also needs to be configured
   <img width="946" alt="image" src="https://user-images.githubusercontent.com/83933160/186872566-53b3f129-291d-4e50-8fd4-a3562a33be43.png">
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [incubator-seatunnel] lhyundeadsoul commented on pull request #2535: add CheckStyle-IDEA Plugin introduction

Posted by GitBox <gi...@apache.org>.
lhyundeadsoul commented on PR #2535:
URL: https://github.com/apache/incubator-seatunnel/pull/2535#issuecomment-1228275861

   > checkstyle also needs to be configured <img alt="image" width="946" src="https://user-images.githubusercontent.com/83933160/186872566-53b3f129-291d-4e50-8fd4-a3562a33be43.png">
   
   I haven't configured this, but it works. Is it essential?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [incubator-seatunnel] ic4y commented on pull request #2535: add CheckStyle-IDEA Plugin introduction

Posted by GitBox <gi...@apache.org>.
ic4y commented on PR #2535:
URL: https://github.com/apache/incubator-seatunnel/pull/2535#issuecomment-1228290979

   > > checkstyle also needs to be configured <img alt="image" width="946" src="https://user-images.githubusercontent.com/83933160/186872566-53b3f129-291d-4e50-8fd4-a3562a33be43.png">
   > 
   > I haven't configured this, but it works. Is it essential?
   
    I think so.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [incubator-seatunnel] CalvinKirs commented on a diff in pull request #2535: add CheckStyle-IDEA Plugin introduction

Posted by GitBox <gi...@apache.org>.
CalvinKirs commented on code in PR #2535:
URL: https://github.com/apache/incubator-seatunnel/pull/2535#discussion_r955788422


##########
docs/en/contribution/setup.md:
##########
@@ -46,6 +46,12 @@ See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plug
 Before running the following example, you should also install JetBrains IntelliJ IDEA's [Lombok plugin](https://plugins.jetbrains.com/plugin/6317-lombok).
 See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html#install-plugins) if you want to.
 
+### Install JetBrains IDEA CheckStyle-IDEA Plugin
+
+Before coding, you should also install JetBrains IntelliJ IDEA's [CheckStyle-IDEA plugin](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea).
+See [install plugins for IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html#install-plugins) if you want to.
+Next, you should go to `Preferences -> Editor -> Code style -> Scheme -> Import Scheme -> CheckStyle Configration` and import `tools/checkstyle/checkStyle.xml`

Review Comment:
   Preferences -> Editor -> Code Style -> Java
   If the user wants to change to automatic formatting, these configurations are also required



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org