fj-doc-maven-plugin verify documentation

Author: fugerit79

fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/tool/FreeMarkerTemplateSyntaxVerifier.java

@@ -119,7 +119,7 @@ public VerifyTemplateOutput verify(File baseFolder, Configuration cfg, Propertie
         } );
     }
 
-    public void generateReport( VerifyTemplateOutput output, Properties params ) throws IOException {
+    public void generateReport( VerifyTemplateOutput output, Properties params ) {
         boolean generateReport = BooleanUtils.isTrue( params.getProperty( PARAM_GENERATE_REPORT ) );
         if ( generateReport ) {
             String reportOutputFolder = params.getProperty( PARAM_REPORT_OUTPUT_FOLDER );
@@ -136,6 +136,7 @@ public void generateReport( VerifyTemplateOutput output, Properties params ) thr
                 try (ByteArrayOutputStream buffer = new ByteArrayOutputStream()) {
                     FreeMarkerDocProcess.getInstance().fullProcess( chainId, DocProcessContext.newContext( "output", output ), type, buffer );
                     FileIO.writeBytes( buffer.toByteArray(), reportFile );
+                    log.info( "report generated : {}", reportFile.getCanonicalPath() );
                 } catch ( Exception e ) {
                     throw new ConfigRuntimeException(
                             String.format( "Fail to generate report in folder %s, error : %s", reportOutputFolder, e.getMessage() ), e );

fj-doc-maven-plugin/README.md

@@ -70,20 +70,46 @@ mvn org.fugerit.java:fj-doc-maven-plugin:add \
 
 ## Goal : verify
 
-add Venus Doc Configuration to an existing project
+verify the templates in a FreeMarker configuration (folder), note: it can be used on any Apache FreeMarker configuration, not only Fugerit Venus Doc.
 
 *Quickstart* :
 
+### Verify existing FreeMarker configuration
+
 ```shell
 mvn org.fugerit.java:fj-doc-maven-plugin:verify -DtemplateBasePath=./src/test/resources/fj_doc_test/template-fail
 ```
 
-verify the templates in a FreeMarker configuration (folder), note: it can be used on any Apache FreeMarker configuration, not only Fugerit Venus Doc.
+### Verify FreeMarker configuration at maven build time
+
+```xml
+  <plugin>
+    <groupId>org.fugerit.java</groupId>
+    <artifactId>fj-doc-maven-plugin</artifactId>
+    <version>${fj-doc-version}</version>
+    <executions>
+      <execution>
+        <id>daogen</id>
+        <phase>compile</phase>
+        <goals>
+          <goal>verify</goal>
+        </goals>
+      </execution>
+    </executions>
+    <configuration>
+      <templateBasePath>${project.basedir}/src/main/resources/fugerit-blank/template</templateBasePath>
+      <generateReport>true</generateReport>
+      <failOnErrors>true</failOnErrors>
+      <reportOutputFolder>${project.build.directory}/freemarker-syntax-verify-report</reportOutputFolder>
+    </configuration>
+  </plugin>
+```
 
 | parameter           | required | default       | description                                                                                                        |
 |---------------------|----------|---------------|--------------------------------------------------------------------------------------------------------------------|
 | templateBasePath    | true     |               | Path to base folder containing FreeMarker templates                                                                |
 | freemarkerVersion   | false    | latest stable | FreeMarker configuration ( i.e. 2.3.33)                                                                            |
 | templateFilePattern | false    |               | Filter on templates to be checked, regex on filename, i.e. ".{0,}[.]ftl"                                           |
 | failOnErrors        | true     | true          | If set to true the build will fail when template syntax errors will be found, otherwise errors will be only logged |
-
+| generateReport      | false    | false         | If set to true a report will be generated (and property 'reportOutputFolder' will be olso required).               |
+| reportOutputFolder  | false    |               | Output folder for the generated report.                                                                            |