Package org.machanism.machai.maven

Class Process

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.machanism.machai.maven.Process

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="process",
      defaultPhase=INSTALL)
public class Process
extends org.apache.maven.plugin.AbstractMojo

Maven plugin Mojo to handle document processing in a Maven-based project.

This Mojo scans the root directory of the project, processes documentation using an external AI provider and project layout structure, and facilitates automated document assistance. Document scanning can be adjusted to process only inputs or utilize a specific chat model as needed.

 Example Usage in POM:
 <plugin>
   <groupId>org.machanism.machai</groupId>
   <artifactId>gw-maven-plugin</artifactId>
   <version>${project.version}</version>
   <executions>
     <execution>
       <goals>
         <goal>process</goal>
       </goals>
     </execution>
   </executions>
 </plugin>
 

Since:

0.0.2

Author:

Viktor Tovstyi

Field Summary

Fields

Modifier and Type	Field	Description
protected File	basedir	Project base directory.
protected String	chatModel	The chat model to use for AI assistance in documentation generation e.g.
protected org.apache.maven.project.MavenProject	project	The MavenProject instance provided by Maven.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
Process()

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

chatModel

@Parameter(property="gw.chatModel")
protected String chatModel

The chat model to use for AI assistance in documentation generation e.g. "OpenAI:gpt-5", default value: "None".

basedir

@Parameter(defaultValue="${basedir}",
           required=true,
           readonly=true)
protected File basedir

Project base directory. Set by Maven.

project

@Parameter(readonly=true,
           defaultValue="${project}")
protected org.apache.maven.project.MavenProject project

The MavenProject instance provided by Maven.

Constructor Details

Process

public Process()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException