chromium-style-5.0.xml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
  3. <!--
  4. See installation instructions: https://sites.google.com/a/chromium.org/dev/developers/checkstyle
  5. -->
  6. <module name="Checker">
  7. <property name="severity" value="warning"/>
  8. <property name="charset" value="UTF-8"/>
  9. <module name="SuppressionFilter">
  10. <property name="file" value="tools/android/checkstyle/suppressions.xml"/>
  11. </module>
  12. <module name="SuppressWarningsFilter"/>
  13. <module name="TreeWalker">
  14. <module name="SuppressWarningsHolder"/>
  15. <module name="AvoidStarImport">
  16. <property name="severity" value="error"/>
  17. </module>
  18. <module name="IllegalCatch">
  19. <property name="severity" value="info"/>
  20. </module>
  21. <module name="ModifierOrder">
  22. <message key="mod.order" value="&quot;{0}&quot; modifier out of order with the JLS suggestions. The correct order: public protected private abstract default static final transient volatile synchronized native strictfp. See https://crbug.com/1003711 for details."/>
  23. <property name="severity" value="error"/>
  24. </module>
  25. <module name="RedundantImport">
  26. <message key="import.redundant" value="Redundant import: {0}."/>
  27. <property name="severity" value="error"/>
  28. </module>
  29. <module name="UnusedImports">
  30. <message key="import.unused" value="Unused import: {0}."/>
  31. <property name="severity" value="error"/>
  32. <property name="processJavadoc" value="true"/>
  33. </module>
  34. <module name="JavadocType">
  35. <property name="severity" value="warning"/>
  36. <property name="tokens" value="INTERFACE_DEF, CLASS_DEF"/>
  37. <property name="scope" value="public"/>
  38. <property name="allowedAnnotations" value="NativeMethods"/>
  39. <message key="javadoc.missing" value="Public classes and interfaces require JavaDoc comments."/>
  40. </module>
  41. <module name="JavadocMethod">
  42. <property name="severity" value="info"/>
  43. <property name="scope" value="public"/>
  44. <property name="allowMissingParamTags" value="true"/>
  45. <property name="allowMissingPropertyJavadoc" value="true"/>
  46. <property name="allowMissingReturnTag" value="true"/>
  47. <property name="allowMissingThrowsTags" value="true"/>
  48. </module>
  49. <module name="PackageName">
  50. <property name="severity" value="error"/>
  51. <property name="format" value="^[a-z]+(\.[a-z][a-z0-9_]{1,})*$"/>
  52. </module>
  53. <module name="SimplifyBooleanExpression">
  54. <property name="severity" value="error"/>
  55. </module>
  56. <module name="SimplifyBooleanReturn">
  57. <property name="severity" value="error"/>
  58. </module>
  59. <module name="TypeName">
  60. <property name="severity" value="error"/>
  61. </module>
  62. <module name="ConstantName">
  63. <property name="severity" value="error"/>
  64. <property name="format" value="^([A-Z][A-Z0-9]*(_[A-Z0-9]+)*)|(s[A-Z][a-zA-Z0-9]*)$"/>
  65. <message key="name.invalidPattern" value="Static final field names must either be all caps (e.g. int HEIGHT_PX) for 'true' constants, or start with s (e.g. AtomicInteger sNextId or Runnable sSuspendTask) for fields with mutable state or that don't 'feel' like constants."/>
  66. </module>
  67. <!-- Non-public, non-static field names start with m. -->
  68. <module name="MemberName">
  69. <property name="severity" value="error"/>
  70. <property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/>
  71. <property name="applyToPublic" value="false"/>
  72. <message key="name.invalidPattern" value="Non-public, non-static field names start with m."/>
  73. </module>
  74. <!-- Static field names start with s. -->
  75. <module name="StaticVariableName">
  76. <property name="severity" value="error"/>
  77. <property name="format" value="^s[A-Z][a-zA-Z0-9]*$"/>
  78. <property name="applyToPublic" value="false"/>
  79. <message key="name.invalidPattern" value="Static field names start with s."/>
  80. </module>
  81. <module name="MethodName">
  82. <property name="id" value="MethodNameCheck"/>
  83. <property name="severity" value="error"/>
  84. <property name="format" value="^(([a-z][a-zA-Z0-9_]*)|(__constructor__))$"/>
  85. <message key="name.invalidPattern" value="Method names should start with a lower case letter (e.g. getWidth())"/>
  86. </module>
  87. <module name="ParameterName">
  88. <property name="severity" value="error"/>
  89. </module>
  90. <module name="LocalFinalVariableName">
  91. <property name="severity" value="error"/>
  92. <property name="format" value="^m|s|((([ms][a-z0-9])|([a-ln-rt-z]))[a-zA-Z0-9]*)$"/>
  93. <message key="name.invalidPattern" value="Local variables should be camel-cased (e.g. int minWidth = 4)."/>
  94. </module>
  95. <module name="LocalVariableName">
  96. <property name="severity" value="error"/>
  97. <property name="format" value="^m|s|((([ms][a-z0-9])|([a-ln-rt-z]))[a-zA-Z0-9]*)$"/>
  98. <message key="name.invalidPattern" value="Local variables should be camel-cased (e.g. int minWidth = 4)."/>
  99. </module>
  100. <module name="FallThrough">
  101. <property name="severity" value="error"/>
  102. <property name="reliefPattern" value=".*"/>
  103. </module>
  104. <module name="NoFinalizer">
  105. <property name="severity" value="info"/>
  106. </module>
  107. <module name="NeedBraces">
  108. <property name="severity" value="error"/>
  109. <property name="allowSingleLineStatement" value="true"/>
  110. </module>
  111. <module name="RegexpSinglelineJava">
  112. <property name="id" value="StringBufferCheck"/>
  113. <property name="severity" value="error"/>
  114. <property name="format" value="StringBuffer"/>
  115. <property name="ignoreComments" value="true"/>
  116. <property name="message" value="Avoid StringBuffer; use StringBuilder instead, which is faster (it's not thread-safe, but this is almost never needed)"/>
  117. </module>
  118. <module name="RegexpSinglelineJava">
  119. <property name="id" value="AlertDialogCheck"/>
  120. <property name="severity" value="warning"/>
  121. <property name="format" value="android\.app\.AlertDialog"/>
  122. <property name="ignoreComments" value="true"/>
  123. <property name="message" value="Avoid android.app.AlertDialog; if possible, use android.support.v7.app.AlertDialog instead, which has a Material look on all devices. (Some parts of the codebase can’t depend on the support library, in which case android.app.AlertDialog is the only option)"/>
  124. </module>
  125. <module name="RegexpSinglelineJava">
  126. <property name="id" value="UseSharedPreferencesManagerFromChromeCheck"/>
  127. <property name="severity" value="warning"/>
  128. <property name="format" value="(getAppSharedPreferences|getDefaultSharedPreferences)"/>
  129. <property name="ignoreComments" value="true"/>
  130. <property name="message" value="Use SharedPreferencesManager instead to access app-wide SharedPreferences from //src/chrome."/>
  131. </module>
  132. <module name="RegexpSinglelineJava">
  133. <property name="id" value="DefaultSharedPreferencesCheck"/>
  134. <property name="severity" value="error"/>
  135. <property name="format" value="getDefaultSharedPreferences"/>
  136. <property name="ignoreComments" value="true"/>
  137. <property name="message" value="Use ContextUtils.getAppSharedPreferences() instead to access app-wide SharedPreferences."/>
  138. </module>
  139. <module name="RegexpSinglelineJava">
  140. <property name="id" value="ConcurrentHashMapCheck"/>
  141. <property name="severity" value="error"/>
  142. <property name="format" value="ConcurrentHashMap"/>
  143. <property name="ignoreComments" value="true"/>
  144. <property name="message" value="ConcurrentHashMap has a bug on some Android versions. Use Collections.synchronizedMap() instead (crbug.com/905903)."/>
  145. </module>
  146. <module name="RegexpSinglelineJava">
  147. <property name="id" value="StrictModeContextIgnoredCheck"/>
  148. <property name="severity" value="error"/>
  149. <property name="format" value="try .*StrictModeContext (?!ignored).*="/>
  150. <property name="ignoreComments" value="true"/>
  151. <property name="message" value="Please name the StrictModeContext variable &quot;ignored&quot; (crbug.com/767058#c4)."/>
  152. </module>
  153. <module name="RegexpSinglelineJava">
  154. <!-- Tests are also allowed to use System.exit if need be, please add dirs to tools/android/checkstyle/suppressions.xml -->
  155. <property name="id" value="SystemExitCheck"/>
  156. <property name="severity" value="error"/>
  157. <property name="format" value="System\.exit\("/>
  158. <property name="ignoreComments" value="true"/>
  159. <property name="message" value="Throw an exception instead of calling System#exit (crbug.com/1000651)."/>
  160. </module>
  161. <module name="RegexpSinglelineJava">
  162. <property name="id" value="AndroidButtonWidgetCheck"/>
  163. <property name="severity" value="warning"/>
  164. <property name="format" value="extends\ Button|extends\ AppCompatButton"/>
  165. <property name="ignoreComments" value="true"/>
  166. <property name="message" value="Use org.chromium.ui.widget.ButtonCompat instead of Button and AppCompatButton if possible; ButtonCompat is a Material-styled button with a customizable background color. On L devices, this is a true Material button. On earlier devices, the button is similar but lacks ripples and a shadow. (crbug.com/775198)"/>
  167. </module>
  168. <module name="RegexpSinglelineJava">
  169. <property name="id" value="SetTextColorAndSetTextSizeCheck"/>
  170. <property name="severity" value="warning"/>
  171. <property name="format" value="\.setTextColor\(|\.setTextSize\("/>
  172. <property name="ignoreComments" value="true"/>
  173. <property name="message" value="If possible, please use #setTextAppearance to set one of the pre-defined text appearance styles in src/ui/android/java/res/values-v17/styles.xml, instead of using #setTextColor or #setTextSize. This will ensure that your programmatically set text styles stay in-sync with text styles used in the rest of Chrome. (crbug.com/775198)"/>
  174. </module>
  175. <module name="RegexpSinglelineJava">
  176. <property name="id" value="ActivityScenarioLaunch"/>
  177. <property name="severity" value="warning"/>
  178. <property name="format" value="ActivityScenario\.launch"/>
  179. <property name="ignoreComments" value="true"/>
  180. <property name="message" value="Launching an ActivityScenario manually is error prone for any test run in a batch. Failing to #close will cause the Activity to leak into the next test. Consider replacing with ActivityScenarioRule. (https://crbug.com/1338271)"/>
  181. </module>
  182. </module>
  183. </module>