Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-02 02:51:42 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3f0d7bc2c495bdf2a42e8d49e4ebb92c6fea18ce
allwpilib/styleguide/checkstyle-suppressions.xml

25 lines
1.4 KiB
XML
Raw Normal View History

Applies Google Styleguide to Java parts of the library (#23) This was partially applied to simulation but simulation is a bit of a mess and has a lot of duplicated code.
2016-05-20 12:07:40 -04:00
<?xml version="1.0"?>
Format HTML and XML files (#944) Generated by wpilibsuite/styleguide#52.
2018-05-15 23:58:20 -07:00
<!DOCTYPE
suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
Applies Google Styleguide to Java parts of the library (#23) This was partially applied to simulation but simulation is a bit of a mess and has a lot of duplicated code.
2016-05-20 12:07:40 -04:00
<suppressions>
[build] Add spotless for other files (#3007) Adds spotless formatting for Gradle, xml, md, and gitignore files. yml linting is not performed as it requires a dependency on npm.
2020-12-30 16:17:20 -08:00
<suppress files=".*test.*" checks="MissingJavadocMethod" />
[build] Bring naming checkstyle rules up to date with Google Style guide (#1781) Also update Checkstyle to 8.38. Google changed their style guide from the last time we imported it. This PR brings in those naming changes. The change they made is allowing single letter member, parameter, and local variable names. They also added a lambda naming scheme and I thought it would be good to bring that in too.
2020-12-29 09:27:48 -08:00
<suppress files=".*wpilibjIntegrationTests.*"
[build] Add spotless for other files (#3007) Adds spotless formatting for Gradle, xml, md, and gitignore files. yml linting is not performed as it requires a dependency on npm.
2020-12-30 16:17:20 -08:00
checks="MissingJavadocMethod" />
[build] Fix checkstyle rules to allow Windows paths (#5839)
2023-10-27 19:56:58 -04:00
<suppress files="wpimath.*"
Don't force public variables to use Hungarian notation (#8774) People generally have expressed a dislike for the Hungarian notation used in member variables, especially in examples/templates, and our styleguide shouldn't be forced on downstream consumers, so this removes all Hungarian notation from the examples/templates. There are _some_ benefits to Hungarian for private member variables (like knowing what's a member vs. local in a PR review) so we'll keep private member variables the same for now, but public variables should no longer use Hungarian notation, since it looks much worse. A new PMD XPath rule has been added to accomplish this goal. Some other non-compliant variables were fixed for the new rule.
2026-04-25 14:32:08 -04:00
checks="(LocalVariableName|MethodName|MethodTypeParameterName|ParameterName)" />
Enable checkstyle on cscore, ntcore, wpiutil (#1032) Also update to version 8.10.
2018-05-24 00:31:04 -04:00
<suppress files=".*JNI.*"
Clean up Java warning suppressions (#4433) Checkstyle naming conventions were changed to allow most of what's in wpimath. Naming rules were disabled completely in wpimath since almost all suppressions are for math notation.
2022-09-24 00:13:55 -07:00
checks="(EmptyLineSeparator|LineLength|MissingJavadocMethod|ParameterName)" />
[commands] Add Commands v3 framework (#6518) The framework fundamentally relies on the continuation API added in Java 21 (which is currently internal to the JDK). Continuations allow for call stacks to be saved to the heap and resumed later. The async framework allows command bodies to be written in an imperative style. However, an async command will need to be actively cooperative and periodically call coroutine.yield() in loops to yield control back to the command scheduler to let it process other commands. There are also some other additions like priority levels (as opposed to a blanket yes/no for ignoring incoming commands), factories requiring names be provided for commands, and the scheduler tracking all running commands and not just the highest-level groups. However, those changes aren't unique to an async framework, and could just as easily be used in a traditional command framework.
2025-10-10 16:47:22 -04:00
<!-- Disable checks for generated protobuf files -->
<suppress files=".*generated[/\\].*[/\\]proto[/\\].*"
Don't force public variables to use Hungarian notation (#8774) People generally have expressed a dislike for the Hungarian notation used in member variables, especially in examples/templates, and our styleguide shouldn't be forced on downstream consumers, so this removes all Hungarian notation from the examples/templates. There are _some_ benefits to Hungarian for private member variables (like knowing what's a member vs. local in a PR review) so we'll keep private member variables the same for now, but public variables should no longer use Hungarian notation, since it looks much worse. A new PMD XPath rule has been added to accomplish this goal. Some other non-compliant variables were fixed for the new rule.
2026-04-25 14:32:08 -04:00
checks="(CustomImportOrder|EmptyLineSeparator|LeftCurly|LineLength|JavadocParagraph|MissingJavadocMethod|OverloadMethodsDeclarationOrder|SummaryJavadoc|UnnecessaryParentheses|OperatorWrap|JavadocMethod|JavadocTagContinuationIndentation)" />
[wpilib,commands] Use Jinja to generate HID classes (#6274)
2024-06-08 12:59:07 -04:00
<suppress files="wpilibj[/\\]src[/\\]generated.*"
checks="MethodName" />
[wpiunits] Java units API rewrite (#6958) Java generics are too limited to do what we need. This refactors generic code previously in Unit and Measure into unit-specific classes that can have unit-safe math operations (notably, times and divide) that can return values in known units instead of a wildcarded Measure<?>. Unit-specific measure implementations are automatically generated by ./wpiunits/generate_units.py, which generates generic interfaces and mutable and immutable implementations of those interfaces. These make up the bulk of the diff of this PR (approximately 9300 LOC). This also adds units for angular and linear velocities, accelerations, and momenta; moment of inertia; and torque.
2024-09-07 13:59:29 -04:00
<!-- Disable checkstyle for generated unit files -->
<suppress files="wpiunits[/\\]src[/\\]generated.*" checks=".*"/>
[build] Upgrade to Java 21 (#7547) Signed-off-by: Jade Turner <spacey-sooty@proton.me> Co-authored-by: sciencewhiz <sciencewhiz@users.noreply.github.com>
2025-07-26 06:45:40 +08:00
<suppress files="wpilibj[/\\]src[/\\]main[/\\]java[/\\]edu[/\\]wpi[/\\]first[/\\]wpilibj[/\\]I2C.java"
checks="OverloadMethodsDeclarationOrder" />
[build] Add LineLength suppression for generated version file (#8530) I managed to get a length of 101 characters when building locally
2026-01-02 09:47:48 -07:00
<!-- Disable LineLength for generated version file -->
<suppress files="wpilibj[/\\]build[/\\]generated.*" checks="LineLength"/>
Applies Google Styleguide to Java parts of the library (#23) This was partially applied to simulation but simulation is a bit of a mess and has a lot of duplicated code.
2016-05-20 12:07:40 -04:00
</suppressions>
Reference in New Issue Copy Permalink