Built by Maven

check-syntax

Full name:

org.thewonderlemming.c4plantuml:c4plantuml-maven-plugin:1.0.0:check-syntax

Description:

Analyzes the C4 source files found in the output directory to look for any syntax error. Any error will be written to the standard output and will eventually fail the build.

You can find detailed examples on the dedicated examples page.

Attributes:
  • Requires a Maven project to be executed.
  • Binds to a default lifecycle phase: compile.
  • Uses the project.build.sourceEncoding property to set the C4 source files encoding.

Optional parameters

Name Type Since Description
<sourceFileExtension> String 1.0.0 Extension for the C4 source files.
Default value is: .puml
Case insensitive: Yes

Parameter details

<sourceFileExtension>

Extension for the C4 source files.

The following snippet changes the value of the <sourceFileExtension> to .c4.

<build>
    <plugins>
        <plugin>
            <groupId>org.thewonderlemming.c4plantuml</groupId>
            <artifactId>c4plantuml-maven-plugin</artifactId>
            <version>1.0.0-RC1</version>
            <executions>
                <execution>
                    <id>checking-syntax-errors-in-c4-files</id>
                    <goals>
                        <goal>check-syntax</goal>
                    </goals>
                    <configuration>
                        <sourceFileExtension>.c4</sourceFileExtension>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • Default: .puml
  • Case insensitive: Yes