Skip to content

Consulo plugins are built using Maven with the maven-consulo-plugin. The plugin handles dependencies, code generation, and packaging.

The standard pom.xml configuration for a Consulo plugin:

xml
<project>
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>my-consulo-plugin</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>consulo-plugin</packaging>

    <build>
        <plugins>
            <plugin>
                <groupId>consulo.maven</groupId>
                <artifactId>maven-consulo-plugin</artifactId>
                <extensions>true</extensions>
                <executions>
                    <execution>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>generate-icon</goal>
                            <goal>generate-localize</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

    <dependencies>
        <!-- Consulo API dependencies -->
    </dependencies>
</project>

For a working example, see the Consulo Simple Plugin Template.

Below are a series of guides to developing and deploying Maven-based Consulo Plugins: