#51 Output should behave like Javadoc, JUnit

release_2.3
closed
Oliver Burn
Other (70)
5
2012-10-10
2002-06-19
Steve Magoun
No

CheckStyle's formatted output should be set up like the output from Javadoc and JUnitreport. The directory structure produced by running the XSL files in /contrib should look like this:

/FooProject
/docs
/checkstyle
/com
/foo

Javadoc produces a similar tree:

/FooProject
/docs
/api
/com
/foo

Here's what CheckStyle currently produces on my machine:

/FooProject
/docs
/checkstyle
/files
/Users
/steve
/development
/FooProject
/src
/com
/foo

That hierarchy unnecessarily huge, but more importantly it's inconsistent - each developer will have a different hierarchy on his/her machine. That makes linking to it from other HTML documents very difficult.

Discussion

  • Oliver Burn
    Oliver Burn
    2002-07-01

    Logged In: YES
    user_id=218824

    I thought about this a great deal and in the end concluded
    that the best approach would be to support a new flag which
    specifies a base directory. In reporting file names, they are
    relative to this directory. The advantages of this approach are:

    • It does not break any existing style sheets
    • It solves problems running the style sheets on different
      platforms
    • It does not introduce issues into the Checkstyle code to
      handle parsing of files to determine package names before
      reporting errors (what happens if a file is unparsable).

    This new flag has been implemented and is in CVS. I have
    also added a new target in build.xml to run all the style
    sheets in contrib/.