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

google_checks.xml: remove xpath suppression and false-positive indentation violations for block codes #15769

Open
Zopsss opened this issue Oct 12, 2024 · 1 comment · May be fixed by #16515
Open

google_checks.xml: remove xpath suppression and false-positive indentation violations for block codes #15769

Zopsss opened this issue Oct 12, 2024 · 1 comment · May be fixed by #16515
Labels
approved bug google style indentation
Milestone
10.19.0

Comments

@Zopsss
Copy link
Member

Zopsss commented Oct 12, 2024

I have read check documentation: https://checkstyle.org/checks/misc/indentation.html
I have downloaded the latest checkstyle from: https://checkstyle.org/cmdline.html#Download_and_Run
I have executed the cli and showed it below, as cli describes the problem better than 1,000 words

Detected at #14294

In google_checks.xml, Indentation module gives false-positive error for following type of blocks:

{
  int x = 99;
}

Example:

/** Test... */
public class Test {
  private static void indentationIssue(int condition) {
    { // line 4, false-positive
      System.out.println("True");
    } // line 6, false-positive
  }

  { // good, no violation
    System.out.println("False");
  } // good, no violation

    { // line 13, expected
      System.out.println("False");
    } // line 15, expected

  class Inner {
    void test() {
      { // line 19, false-positive
        System.out.println("True");
      } // line 21, false-positive
    }
  }
}
$ java -jar .\checkstyle-10.18.2-all.jar -c .\google_checks.xml .\Test.java
Starting audit...
[WARN] C:\checkstyle testing\.\Test.java:4:5: 'block lcurly' has incorrect indentation level 4, expected level should be 6. [Indentation]
[WARN] C:\checkstyle testing\.\Test.java:6:5: 'block rcurly' has incorrect indentation level 4, expected level should be 6. [Indentation]
[WARN] C:\checkstyle testing\.\Test.java:13:5: 'block lcurly' has incorrect indentation level 4, expected level should be 2. [Indentation]
[WARN] C:\checkstyle testing\.\Test.java:14:7: 'block' child has incorrect indentation level 6, expected level should be 4. [Indentation]
[WARN] C:\checkstyle testing\.\Test.java:15:5: 'block rcurly' has incorrect indentation level 4, expected level should be 2. [Indentation]
[WARN] C:\checkstyle testing\.\Test.java:19:7: 'block lcurly' has incorrect indentation level 6, expected level should be 8. [Indentation]
[WARN] C:\checkstyle testing\.\Test.java:21:7: 'block rcurly' has incorrect indentation level 6, expected level should be 8. [Indentation]
Audit done.

@romani suggested to use suppression to suppress these false-positives until we find a way to fix it at: #14294 (comment)

The suppression is:

    <module name="SuppressionXpathSingleFilter">
      <property name="checks" value="Indentation"/>
      <property name="query" value="//SLIST/SLIST"/>
    </module>
    <module name="SuppressionXpathSingleFilter">
      <property name="checks" value="Indentation"/>
      <property name="query" value="//SLIST/SLIST/RCURLY"/>
    </module>
    <module name="Indentation">
      <property name="basicOffset" value="2"/>
      <property name="braceAdjustment" value="2"/>
      <property name="caseIndent" value="2"/>
      <property name="throwsIndent" value="4"/>
      <property name="lineWrappingIndentation" value="4"/>
      <property name="arrayInitIndent" value="2"/>
    </module>

Adding this suppression will suppress all indentation violations for above mentioned type of blocks whether they're correct or not but we need to use it till we find a fix.

As part of this issue, we need to find a way to fix this false-positive and remove the suppression.
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Oct 12, 2024
@Zopsss
Issue checkstyle#15769: added suppression for separate code blocks an…
aa5061a 
…d updated documentation
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Oct 13, 2024
@Zopsss
Issue checkstyle#15769: added suppression for separate code blocks an…
f069e74 
…d updated documentation
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Oct 13, 2024
@Zopsss
Issue checkstyle#15769: added suppression for separate code blocks an…
5c29fb4 
…d updated documentation
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Oct 14, 2024
@Zopsss
Issue checkstyle#15769: added suppression for separate code blocks an…
d9455dd 
…d updated documentation
@Zopsss Zopsss mentioned this issue Oct 15, 2024
Merged
@Zopsss Zopsss moved this to In Progress in Refine Google Style Guide Oct 15, 2024
Zopsss added a commit to Zopsss/checkstyle that referenced this issue Oct 15, 2024
@Zopsss
Issue checkstyle#15769: added suppression for separate code blocks an…
7f6f42a 
…d updated documentation
@romani romani changed the title false-positive indentation violations for block codes in google_checks.xml google_checks.xml: remove xpath suppression and false-positive indentation violations for block codes Oct 16, 2024
rdiachenko pushed a commit that referenced this issue Oct 19, 2024
@Zopsss @rdiachenko
Issue #15769: added suppression for separate code blocks and updated …
68cc0dc 
…documentation
@github-actions github-actions bot added this to the 10.19.0 milestone Oct 19, 2024
@romani romani added the bug label Oct 19, 2024
@romani romani mentioned this issue Oct 19, 2024
Closed
@praveenyadahalli
Copy link
Contributor

I am on it

mohitsatr added a commit to mohitsatr/checkstyle that referenced this issue Mar 10, 2025
@mohitsatr
Issue checkstyle#15769: fix false-positive indentation violations for…
ffcf264 
… block codes
@mohitsatr mohitsatr linked a pull request Mar 10, 2025 that will close this issue
Open
mohitsatr added a commit to mohitsatr/checkstyle that referenced this issue Mar 10, 2025
@mohitsatr
Issue checkstyle#15769: fix false-positive indentation violations for…
fbfa4b1 
… block codes
mohitsatr added a commit to mohitsatr/checkstyle that referenced this issue Mar 24, 2025
@mohitsatr
Issue checkstyle#15769: fix false-positive indentation violations for…
78e1fb8 
… block codes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
approved bug google style indentation
Projects
None yet
Milestone
10.19.0
Development

Successfully merging a pull request may close this issue.

Issue #15769: fix false-positive indentation violations for block codes mohitsatr/checkstyle
3 participants
@romani @praveenyadahalli @Zopsss