NPL Maven plugin

Introduction

The NPL Maven Plugin supports various NPL-related operations to be executed as part of a build. It serves as the main entry point for all build tools.

To install and configure Maven itself (as well as repository access), please follow the instructions provided here.

Goals

This section describes the supported operations.

npl-compile

Compilation invokes the NPL compiler on the sources. It serves as a means to verify that the code indeed compiles without actually running it.

npl-test-compile

Compilation invokes the NPL compiler on the test sources. It verifies that the test code compiles without actually running it.

Setting maven.test.skip (or mavenTestSkip) behaves similarly to the Maven Surefire plugin maven.test.skip property, tests are neither compiled nor executed.

npl-test

NPL tests may be run as part of the Maven test phase. The plugin will scan all files in the test directory for the presence of tests, and run them.

A summary of test results is printed for every run. Files that do not contain any tests will not show up in the summary output. Individual tests are not visible in the test result summary unless they fail. A failing test will cause the entire build to fail.

Setting skipTests behaves similarly to the Maven Surefire plugin skipTests property, tests are compiled, but not executed.

Similarly, setting skipNPLTests allows one to skip execution of NPL tests. This property can be useful if you want to disable execution of NPL tests only, while still executing other tests, e.g. integration tests.

npl-puml

Generates UML files from your NPL sources in the form of PlantUML files. Based on the sources property below.

See the UML Generator for more details.

This goal can be skipped using skipPumlGeneration.

npl-contrib

Unpacks all available NPL contributor libraries into a target build folder. Use mvn generate-sources or mvn compile to unpack. This step is necessary prior to development in IntelliJ.

This goal can be skipped using skipNPLContribUnpack.

npl-codegen

See the Kotlin code generator for more details.

This goal can be skipped using skipNPLGeneration.

npl-multigen

Generates multi-node notifications. It is based on sources property below.

This goal can be skipped using skipMultiGeneration.

npl-api

Generates the OpenAPI specifications. See the OpenAPI generator for more details.

This goal can be skipped using skipOpenAPIGeneration.

Configuration

Properties

The following configuration properties are available:

The goals correspond to the sections described in goals.

The goals correspond to the sections described in goals.

Example setup

A complete sample configuration looks as follows:

<build>
    <plugins>
        <plugin>
            <groupId>com.noumenadigital.platform</groupId>
            <artifactId>npl-maven-plugin</artifactId>
            <!-- Make sure this version matches your platform version! -->
            <version>2024.2.0</version>
            <executions>
                <execution>
                    <goals>
                        <goal>npl-contrib</goal>
                        <goal>npl-api</goal>
                        <goal>npl-puml</goal>
                        <goal>npl-compile</goal>
                        <goal>npl-test-compile</goal>
                        <goal>npl-test</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <tag>app-1.0.0</tag>
                <enableCompilerOptimisations>true</enableCompilerOptimisations>
                <nplContribPath>${project.basedir}/npl-contrib</nplContribPath>
            </configuration>
        </plugin>
    </plugins>
</build>

Please note that in certain cases, the IntelliJ project settings need to be adjusted such that generated sources are not excluded (File -> Project structure, look for Modules under Project Settings).