Plugin Documentation

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

Goals

Goals available for this plugin:

Goal	Description
typescript-generator:generate	Generates TypeScript declaration file from specified java classes. For more information see README and Wiki on GitHub.
typescript-generator:help	Display help information on typescript-generator-maven-plugin. Call `mvn typescript-generator:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.

System Requirements

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

Maven	3.0
JDK	17

System Requirements History

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

Plugin Version	Maven	JDK
3.4.9	-	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.codecentric.typescript-generator</groupId>
          <artifactId>typescript-generator-maven-plugin</artifactId>
          <version>3.4.9</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>de.codecentric.typescript-generator</groupId>
        <artifactId>typescript-generator-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

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