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.

Sign up for GitHub

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

Jump to bottom

Define severity for google style config by variable #15053

Closed
romani opened this issue Jun 20, 2024 · 2 comments
Closed

Define severity for google style config by variable #15053

romani opened this issue Jun 20, 2024 · 2 comments
Labels
approved new feature
Milestone
10.18.0

Comments

@romani
Copy link
Member

romani commented Jun 20, 2024 •
edited
Loading 

$ cat Test.java 
import java.util.Arrays;

public class Test {
}

$ java -jar checkstyle-10.17.0-all.jar -c /google_checks.xml Test.java
Starting audit...
[WARN] /var/tmp/Test.java:3:1: Missing a Javadoc comment. [MissingJavadocType]
Audit done.

checkstyle/src/main/resources/google_checks.xml

Line 24 in 4fe32fc

<property name="severity" value="warning"/>

this severity was big question for many years some people like it was warn, some prefer error.

Expected:

$ java -Dorg.checkstyle.google.severity=error -jar checkstyle-10.XX.0-all.jar \
        -c /google_checks.xml Test.java
Starting audit...
[ERROR] /var/tmp/Test.java:3:1: Missing a Javadoc comment. [MissingJavadocType]
Audit done

for Windows:
java -D"org.checkstyle.google.severity=error" -jar checkstyle-10.XX.0-all.jar -c /google_checks.xml Test.java

new section above https://checkstyle.org/google_style.html#Google_Suppressions "Overrides" that mention what variable to use to get new severity.

If system properly is not working.
should use -p propertiesFile - Sets the property files to load. where it is just property.
@romani
Copy link
Member Author

romani commented Jun 20, 2024

this becomes an issue at #15028 (comment)

@romani romani mentioned this issue Jun 20, 2024
Merged
@romani romani changed the title Allow defining severity for google style config throught system variable Define severity for google style config throught system variable Jun 20, 2024
@romani romani changed the title Define severity for google style config throught system variable Define severity for google style config by system variable Jun 20, 2024
@romani
Copy link
Member Author

romani commented Jun 20, 2024 •
edited
Loading

@Zopsss , in PR please prove by CLI that it is working or better please make junit test , here is examples

checkstyle/src/test/java/com/puppycrawl/tools/checkstyle/MainTest.java

Line 1654 in 4fe32fc

assertMainReturnCode(-1, "-c", "/google_checks.xml", filePath, "-e", filePath);

and

checkstyle/src/test/java/com/puppycrawl/tools/checkstyle/MainTest.java

Line 1722 in 4fe32fc

assertMainReturnCode(0, "-c", getPath("InputMainConfig-custom-root-module.xml"),

Zopsss added a commit to Zopsss/checkstyle that referenced this issue Jun 20, 2024
@Zopsss
Issue checkstyle#15053: Made google style guide severity property def…
536dd8e 
…ine-able by system variable
@Zopsss Zopsss mentioned this issue Jun 20, 2024
Merged
@Zopsss Zopsss moved this to In Progress in Refine Google Style Guide Jun 21, 2024
romani pushed a commit to Zopsss/checkstyle that referenced this issue Jun 21, 2024
@Zopsss @romani
Issue checkstyle#15053: Made google style guide severity property def…
674cb7b 
…ine-able by system variable
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Jun 21, 2024
@Zopsss
Issue checkstyle#15053: Made google style guide severity property def…
23c3ccc 
…ine-able by system variable
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Jun 21, 2024
@Zopsss
Issue checkstyle#15053: Made google style guide severity property def…
c73f45d 
…ine-able by system variable
@romani romani changed the title Define severity for google style config by system variable Define severity for google style config by variable Jun 21, 2024
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Jun 21, 2024
@Zopsss
Issue checkstyle#15053: Made google style guide severity property def…
45ecd29 
…ine-able by system variable
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Jun 22, 2024
@Zopsss
Issue checkstyle#15053: Made google style guide severity property def…
9f16287 
…ine-able by system variable
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Jun 22, 2024
@Zopsss
Issue checkstyle#15053: Made google style guide severity property def…
49af32e 
…ine-able by system variable
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Jun 22, 2024
@Zopsss
Issue checkstyle#15053: Made google style guide severity property def…
d2e76af 
…ine-able by system variable
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Jun 23, 2024
@Zopsss
Issue checkstyle#15053: Made google style guide severity property def…
012932d 
…ine-able by system variable
rnveach pushed a commit that referenced this issue Jun 23, 2024
@Zopsss @rnveach
Issue #15053: Made google style guide severity property define-able b…
a7462da 
…y system variable
@github-actions github-actions bot added this to the 10.18.0 milestone Jun 23, 2024
@rnveach rnveach closed this as completed Jun 23, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Refine Google Style Guide Jun 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
approved new feature
Projects
No open projects
Refine Google Style Guide
Status: Done
Milestone
10.18.0
Development

No branches or pull requests
2 participants
@romani @rnveach