Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MCHECKSTYLE-397] support ${config_loc} on checkstyle xml #36

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

qxo
Copy link

@qxo qxo commented Sep 19, 2020

we can use config_loc as: ${config_loc}/suppressions.xml.

with this PR, we can use same checkstyle.xml which contains ${config_loc}

for eclipsecs ${config_loc} is a variable of Eclipse and it will refer to the same directory where the checkstyle.xml is present.
ref: https://checkstyle.org/eclipse-cs/#!/properties

https://issues.apache.org/jira/projects/MCHECKSTYLE/issues/MCHECKSTYLE-397

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MCHECKSTYLE-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MCHECKSTYLE-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

we can use config_loc as: ${config_loc}/suppressions.xml.

with this PR, we can use same checkstyle.xml which contains ${config_loc}

for eclipsecs ${config_loc} is a variable of Eclipse and it will refer to the same directory where the checkstyle.xml is present.
ref: https://checkstyle.org/eclipse-cs/#!/properties
@qxo
Copy link
Author

qxo commented Sep 19, 2020

mvn -Prun-its clean verify failed on my PC because my network issue:

javax.net.ssl.SSLException: Connection reset
    at sun.security.ssl.Alert.createSSLException (Alert.java:127)
    at sun.security.ssl.TransportContext.fatal (TransportContext.java:321)
    at sun.security.ssl.TransportContext.fatal (TransportContext.java:264)
    at sun.security.ssl.TransportContext.fatal (TransportContext.java:259)
    at sun.security.ssl.SSLTransport.decode (SSLTransport.java:137)
    at sun.security.ssl.SSLSocketImpl.decode (SSLSocketImpl.java:1152)

@elharo elharo changed the title support ${config_loc} on checkstyle xml [MCHECKSTYLE-397] support ${config_loc} on checkstyle xml Nov 25, 2020
Copy link
Contributor

@elharo elharo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could use some tests.

@lrozenblyum
Copy link

lrozenblyum commented Jul 22, 2022

@bmarwell @elharo it's really a nice feature to have in the plug-in.
Currently enabling suppressions for a Maven multi-module project is much more complex than it could be.
${config_loc} support should enable seamless experience for Checkstyle users.

So could I for example continue work on this feature if it has chances for merge?
As I understand this pull request remarks should be solved?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants