You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@streampipes.apache.org by GitBox <gi...@apache.org> on 2022/11/30 14:22:32 UTC

[GitHub] [streampipes] RobertIndie opened a new issue, #820: Enable check style for the project

RobertIndie opened a new issue, #820:
URL: https://github.com/apache/streampipes/issues/820

   ### Body
   
   This is the issue to track the progress of check-style enablement for all modules. 
   If you want to take over some of the modules, please feel free to leave a comment here. And thanks for all your contribution!  :smiley:
   
   Only the first level of sub-modules are listed here. If you feel that some of the modules(eg. `streampipes-extensions`) are heavy, please continue to split them into smaller tasks in this issue.
   
   - [ ] streampipes-archetype-extensions-jvm
   - [ ] streampipes-archetype-pe-sinks-flink
   - [ ] streampipes-archetype-pe-processors-flink
   - [ ] streampipes-commons
   - [ ] streampipes-service-discovery-api
   - [ ] streampipes-logging
   - [ ] streampipes-model-shared
   - [ ] streampipes-vocabulary
   - [ ] streampipes-model
   - [ ] streampipes-model-client
   - [ ] streampipes-test-utils
   - [ ] streampipes-serializers-json
   - [ ] streampipes-service-discovery-consul
   - [ ] streampipes-service-discovery
   - [ ] streampipes-service-base
   - [ ] streampipes-config
   - [ ] streampipes-messaging
   - [ ] streampipes-messaging-kafka
   - [ ] streampipes-storage-api
   - [ ] streampipes-storage-couchdb
   - [ ] streampipes-storage-management
   - [ ] streampipes-data-explorer
   - [ ] streampipes-connect-api
   - [ ] streampipes-dataformat
   - [ ] streampipes-sdk
   - [ ] streampipes-rest-shared
   - [ ] streampipes-container
   - [ ] streampipes-dataformat-cbor
   - [ ] streampipes-dataformat-fst
   - [ ] streampipes-dataformat-json
   - [ ] streampipes-dataformat-smile
   - [ ] streampipes-messaging-jms
   - [ ] streampipes-messaging-mqtt
   - [ ] streampipes-messaging-nats
   - [ ] streampipes-security-jwt
   - [ ] streampipes-user-management
   - [ ] streampipes-mail
   - [ ] streampipes-resource-management
   - [ ] streampipes-measurement-units
   - [ ] streampipes-pipeline-management
   - [ ] streampipes-data-export
   - [ ] streampipes-rest-core-base
   - [ ] streampipes-connect
   - [ ] streampipes-connect-container-master
   - [ ] streampipes-rest
   - [ ] streampipes-platform-services
   - [ ] streampipes-backend
   - [ ] streampipes-client
   - [ ] streampipes-service-extensions-base
   - [ ] streampipes-connect-container-worker
   - [ ] streampipes-container-standalone
   - [ ] streampipes-container-extensions
   - [ ] streampipes-maven-plugin
   - [ ] streampipes-extensions
   - [ ] streampipes-pipeline-elements-shared
   - [ ] streampipes-connect-adapters
   - [ ] streampipes-connect-adapters-iiot
   - [ ] streampipes-sdk-bundle
   - [ ] streampipes-wrapper
   - [ ] streampipes-wrapper-standalone
   - [ ] streampipes-processors-filters-jvm
   - [ ] streampipes-wrapper-siddhi
   - [ ] streampipes-processors-filters-siddhi
   - [ ] streampipes-processors-transformation-jvm
   - [ ] streampipes-sinks-brokers-jvm
   - [ ] streampipes-sinks-databases-jvm
   - [ ] streampipes-data-explorer-commons
   - [ ] streampipes-sinks-internal-jvm
   - [ ] streampipes-sinks-notifications-jvm
   - [ ] streampipes-processors-enricher-jvm
   - [ ] streampipes-processors-change-detection-jvm
   - [ ] streampipes-extensions-all-iiot
   - [ ] streampipes-processors-image-processing-jvm
   - [ ] streampipes-processors-text-mining-jvm
   - [ ] streampipes-processors-geo-jvm
   - [ ] streampipes-pipeline-elements-all-jvm
   - [ ] streampipes-extensions-all-jvm
   - [ ] streampipes-wrapper-distributed
   - [ ] streampipes-wrapper-flink
   - [ ] streampipes-processors-aggregation-flink
   - [ ] streampipes-processors-enricher-flink
   - [ ] streampipes-processors-geo-flink
   - [ ] streampipes-processors-pattern-detection-flink
   - [ ] streampipes-processors-statistics-flink
   - [ ] streampipes-processors-text-mining-flink
   - [ ] streampipes-processors-transformation-flink
   - [ ] streampipes-sinks-databases-flink
   - [ ] streampipes-pipeline-elements-all-flink
   - [ ] streampipes-pipeline-elements-data-simulator
   - [ ] streampipes-sources
   - [ ] streampipes-sources-watertank-simulator
   - [ ] streampipes-sources-vehicle-simulator
   - [ ] streampipes-performance-tests
   - [ ] streampipes-wrapper-kafka-streams
   - [ ] streampipes-wrapper-python
   - [ ] integration https://github.com/apache/streampipes/pull/814
   
   Note: The above todo tasks are generated by the command `mvn --also-make dependency:tree | grep maven-dependency-plugin | awk '{ print "- [ ] "$(NF-1) }' `. Please tell me if there are any problems.
   
   
   
   
   ### StreamPipes Committer
   
   - [X] I acknowledge that I am a maintainer/committer of the Apache StreamPipes project.


-- 
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: issues-unsubscribe@streampipes.apache.org.apache.org

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


[GitHub] [streampipes] RobertIndie commented on issue #820: Enable check style for the project

Posted by GitBox <gi...@apache.org>.
RobertIndie commented on issue #820:
URL: https://github.com/apache/streampipes/issues/820#issuecomment-1334026315

   Hi @tenthe 
   > How can I link the subtask (TODO) to pull requests?
   
   You can edit my Issue description and paste your PR link to the sub-task. And as you are doing now, you can link to this issue in your PR description.


-- 
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: issues-unsubscribe@streampipes.apache.org

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


[GitHub] [streampipes] tenthe commented on issue #820: Enable check style for the project

Posted by GitBox <gi...@apache.org>.
tenthe commented on issue #820:
URL: https://github.com/apache/streampipes/issues/820#issuecomment-1339663188

   @RobertIndie, currenlty I refactor the streampipes-extensions module.
   I just found out that the command `mvn validate` no longer returns an error when there is a checkstyle problem. 
   (e.g. `mvn validate -f streampipes-extensions/streampipes-processors-text-mining-flink`)
   Could this be related to the changes in #851 or is there something I am doing wrong?
   
   Do I need to configure anything in the module `streampipes-extensions`? 
   I only added this to all submodules:
   ```
   <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-checkstyle-plugin</artifactId>
   </plugin>
   ```


-- 
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: issues-unsubscribe@streampipes.apache.org

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


[GitHub] [streampipes] tenthe closed issue #820: Enable check style for the project

Posted by GitBox <gi...@apache.org>.
tenthe closed issue #820: Enable check style for the project
URL: https://github.com/apache/streampipes/issues/820


-- 
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: issues-unsubscribe@streampipes.apache.org

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


[GitHub] [streampipes] tenthe commented on issue #820: Enable check style for the project

Posted by GitBox <gi...@apache.org>.
tenthe commented on issue #820:
URL: https://github.com/apache/streampipes/issues/820#issuecomment-1341369334

   Ok, thans to the both of you. I used the first option and added it to PR #850.
   This PR should (hopefully) contain all checkstyle fixes for the `streampipes-extension` module


-- 
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: issues-unsubscribe@streampipes.apache.org

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


[GitHub] [streampipes] tenthe commented on issue #820: Enable check style for the project

Posted by GitBox <gi...@apache.org>.
tenthe commented on issue #820:
URL: https://github.com/apache/streampipes/issues/820#issuecomment-1333505376

   Hey @RobertIndie,
   I'll start with the module `streampipes-rest`.
   How can I link the subtask (TODO) to pull requests?


-- 
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: issues-unsubscribe@streampipes.apache.org

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


[GitHub] [streampipes] RobertIndie commented on issue #820: Enable check style for the project

Posted by GitBox <gi...@apache.org>.
RobertIndie commented on issue #820:
URL: https://github.com/apache/streampipes/issues/820#issuecomment-1340927204

   Hi @tenthe Thanks for your comment.
   > I just found out that the command mvn validate no longer returns an error when there is a checkstyle problem.
   
   I have created a PR to fix it: https://github.com/apache/streampipes/pull/853
   
   


-- 
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: issues-unsubscribe@streampipes.apache.org

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


[GitHub] [streampipes] tenthe commented on issue #820: Enable check style for the project

Posted by GitBox <gi...@apache.org>.
tenthe commented on issue #820:
URL: https://github.com/apache/streampipes/issues/820#issuecomment-1338172925

   Hi all, I just enabled checkstyle in the module `streampipes-processors-geo-jvm`. 
   There we have the case that some files have a different license (MIT). Further, there are other checkstyle `violations` (e.g. an author in comments) that we can't remove.
   How can we deal with such cases?
   
   An **example** can be found in package: `org.apache.streampipes.processors.geo.jvm.processor.revgeocoder.geocode.kdtree;`


-- 
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: issues-unsubscribe@streampipes.apache.org

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


[GitHub] [streampipes] RobertIndie commented on issue #820: Enable check style for the project

Posted by GitBox <gi...@apache.org>.
RobertIndie commented on issue #820:
URL: https://github.com/apache/streampipes/issues/820#issuecomment-1340945445

   Hi, @tenthe 
   > There we have the case that some files have a different license (MIT). Further, there are other checkstyle `violations` (e.g. an author in comments) that we can't remove.
   How can we deal with such cases?
   
   How about suppressing these files here: https://github.com/apache/streampipes/blob/dev/tools/maven/suppressions.xml
   I also found a way to apply different rules to different files: https://stackoverflow.com/questions/25894431/checkstyle-different-rules-for-different-files . But it may introduce some complexity.


-- 
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: issues-unsubscribe@streampipes.apache.org

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


[GitHub] [streampipes] bossenti commented on issue #820: Enable check style for the project

Posted by GitBox <gi...@apache.org>.
bossenti commented on issue #820:
URL: https://github.com/apache/streampipes/issues/820#issuecomment-1341253139

   Personally, I would prefer option 1 and only suppress the affected rules working with as less wildcards as possible.
   The second option can get easily confusing, as fas as I can imagine


-- 
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: issues-unsubscribe@streampipes.apache.org

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


[GitHub] [streampipes] bossenti closed issue #820: Enable check style for the project

Posted by GitBox <gi...@apache.org>.
bossenti closed issue #820: Enable check style for the project
URL: https://github.com/apache/streampipes/issues/820


-- 
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: issues-unsubscribe@streampipes.apache.org

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