Built by Maven

Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal Description
typescript:compile This goal compiles the typescript sources. It does so by calling the compile script, which in turn simply calls tsc.
typescript:deploy This goal deploys the npm package by calling npm publish.
typescript:diff-package This goal compares the build configuration specified by the current project object model and compares it to the current package.json - any difference is written to the json file specified by defaultValues so that any other execution of different goals of the typescript-maven-plugin will honour those differences.
typescript:generate-project This goal generates the files `package.json`, `ts-config.json` and `tsconfig.spec.json` from its configuration. It also generates a second `package.json` file inside the distribution directory. The second file will be the one distributed with the package. It contains only the basic project information needed in a package, omitting build specific information.
typescript:help Display help information on typescript-maven-plugin.
Call mvn typescript:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
typescript:npm-install This goal basically executes npm install.
typescript:package This goal packages the npm package by calling npm pack. Additionally, this attaches the package created, the `package.json` file and the `package-lock.json` file to the project so that the maven default install and deploy plugins will install/deploy them.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.9.0
JDK 17

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version Maven JDK
from 4.0.9 to 4.0.10 - 17

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>de.eitco.cicd</groupId>
          <artifactId>typescript-maven-plugin</artifactId>
          <version>4.0.10</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>de.eitco.cicd</groupId>
        <artifactId>typescript-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"