Details
-
Type:
Improvement
-
Status:
Closed
-
Priority:
Trivial
-
Resolution: Fixed
-
Affects Version/s: 1.0-beta-7
-
Fix Version/s: 1.0-beta-10
-
Component/s: None
-
Labels:None
Description
Save text below in plugins\maven-checkstyle-plugin-1.1\jalopy-checkstyle.properties.
You can then use it in a project by setting the property
maven.checkstyle.format = jalopy
Some things that jalopy tries to fix - like lines > 80 chars - are still checked because there are some lines jalopy can't split. I've left the header file out of this, but again thats something jalopy
can't always fix.
NB this requires checkstyle 2.4, the 1.1 plugin depends on 2.3.
- A Checkstyle setup that ignores anything that jalopy can fix,
- for any project that uses both.
- The point of this is that you never get errors simply because
- of a mismatch in the jalopy and checkstyle setups.
- Everything here is in the order it appears in the
- checkstyle manual http://checkstyle.sourceforge.net/config.html
- to make it easier to find the documentation.
- CHECKS FOR JAVADOC COMMENTS
- javadoc checks are broken in jalopy, and anyway it
- can't write docs for you - so we will use checkstyle.
checkstyle.javadoc.scope = private
checkstyle.require.package.html = false
checkstyle.require.version = false
checkstyle.allow.no.author = false - dont stop me documenting RuntimeExceptions!
checkstyle.javadoc.checkUnusedThrows = false
- CHECKS FOR NAMING CONVENTIONS
- these are the checkstyle defaults
- jalopy cannot safely alter names.
checkstyle.pattern.member = ^[a-z][a-zA-Z0-9]*$
checkstyle.pattern.publicmember = ^f[A-Z][a-zA-Z0-9]*$
checkstyle.pattern.const = ^[A-Z]([A-Z0-9_]*[A-Z0-9])?$
checkstyle.pattern.static = ^[a-z][a-zA-Z0-9]*$
checkstyle.pattern.parameter = ^[a-z][a-zA-Z0-9]*$
checkstyle.pattern.package = ^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9])$
checkstyle.pattern.type = ^[A-Z][a-zA-Z0-9]*$
checkstyle.pattern.method = ^[a-z][a-zA-Z0-9]*$
checkstyle.pattern.localvar = ^[a-z][a-zA-Z0-9]*$
checkstyle.pattern.localfinalvar = ^[a-z][a-zA-Z0-9]*$
- CHECKS FOR HEADERS
- leave this to jalopy. This will not always be correct!!
checkstyle.header.file =
checkstyle.header.regexp = false
checkstyle.header.ignoreline =
- CHECKS FOR IMPORTS
- leave this to jalopy
checkstyle.ignore.imports = true
- CHECKS FOR SIZE VIOLATIONS
- still check these because jalopy can't fix every line.
checkstyle.maxlinelen = 80
checkstyle.tab.width = 4
checkstyle.ignore.importlength = false
checkstyle.ignore.maxlinelen = @version
checkstyle.maxmethodlen = 150
checkstyle.maxconstructorlen = 150
checkstyle.maxfilelen = 2000
checkstyle.maxparameters = 7
- CHECKS FOR WHITESPACE
- leave this to jalopy
checkstyle.allow.tabs = true
checkstyle.ignore.whitespace = true - this is the variant in the checkstyle manual
checkstyle.ignore.whitespace.cast = true - and this is what was in maven?
checkstyle.ignore.cast.whitespace = true
checkstyle.paren.pad = ignore
checkstyle.wrap.operator = ignore
- CHECKS FOR MODIFIERS
- These are semantic checks, so jalopy can't fix them
checkstyle.ignore.public.in.interface = false
checkstyle.allow.protected = false
checkstyle.allow.package = false
- CHECKS FOR BRACES
- leave this to jalopy
checkstyle.ignore.braces = true - still check for empty try/catch/finally
checkstyle.block.try = stmt
checkstyle.block.catch = text
checkstyle.block.finally = stmt
checkstyle.lcurly.type = ignore
checkstyle.lcurly.method = ignore
checkstyle.lcurly.other = ignore
checkstyle.rcurly.type = ignore
checkstyle.rcurly.method = ignore
checkstyle.rcurly.other = ignore
- MISCELLANEOUS CHECKS
checkstyle.pattern.todo = TODO:
checkstyle.ignore.longell = false
checkstyle.illegal.instantiations =
Issue Links
- is depended upon by
-
MAVEN-401
Release maven-b10
-
It's in wiki for the time being. Move to xdoc at some point during a wiki sweep.
http://nagoya.apache.org/wiki/apachewiki.cgi?Maven/JalopyCheckstyleHarmony