Kontakt

Improved Component Report

Posted on Donnerstag, 24th Februar, 2011

Yesterday I made some changes to the Tapestry’s component report which will make the report even more useful. As of version 5.3 the report will:

  1. Accept several root packages for a single library
  2. Mark deprecated components and/or parameters as we are used to from our IDE

If you used the component report plugin for your own components, you already know that before Tapestry 5.3 you needed to add the following to the reporting/plugins section of your POM:

<plugin>
    <groupId>org.apache.tapestry</groupId>
    <artifactId>tapestry-component-report</artifactId>
    <version>5.2.4</version>
    <configuration>
       <rootPackage>org.example.lib</rootPackage>
    </configuration>
</plugin>

As of Tapestry 5.3 the plugin is able to generate a component reference for a library with several root packages. So, the report configuration requires a new rootPackages element which may contain several rootPackage elements.

  <plugin>
    <groupId>org.apache.tapestry</groupId>
    <artifactId>tapestry-component-report</artifactId>
    <version>5.3.0-SNAPSHOT</version>
    <configuration>
       <rootPackages>
          <rootPackage>org.example.lib</rootPackage>
          <rootPackage>com.acme.library</rootPackage>
       </rootPackages>
   </configuration>
</plugin>

Now let’s see an example how the component report for a library with multiple root package will look like.

The screenshot above demonstrates that for each provided root package the component report generates an individual component reference. Furthermore you can see that deprecated components are canceled so that you immediately know which components will be removed in the upcoming releases.

The detail page for a deprecated component is shown below.

Also deprecated component parameters are now highlighted, as shown in the following screenshot.

As you know the component report is a Maven plugin and so can’t be used by non-Maven users. We are planing to untie the report from Maven, so that you can generate the component reference with any build tool you like.

Kommentare sind geschlossen.

Tapestry 5 Blog - Copyright © 2009 - Eclectic Theme by Your Inspiration Web - Powered by WordPress