Skip to content

Begin converting this plugin to Guice constructor injection #1000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slawekjaranowski merged 1 commit into from
Oct 12, 2025
Merged

Begin converting this plugin to Guice constructor injection #1000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions maven-plugin-plugin/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,12 @@
<artifactId>maven-resolver-util</artifactId>
<version>${resolverVersion}</version>
</dependency>
<dependency>
<groupId>javax.inject</groupId>
<artifactId>javax.inject</artifactId>
<version>1</version>
<scope>provided</scope>
</dependency>

<!-- plexus -->
<dependency>
Expand Down
15 changes: 9 additions & 6 deletions maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;

Expand All @@ -34,11 +33,6 @@
*
*/
public abstract class AbstractGeneratorMojo extends AbstractMojo {
/**
* The project currently being built.
*/
@Component
protected MavenProject project;

/**
* The goal prefix that will appear before the ":".
Expand Down Expand Up @@ -67,6 +61,15 @@ public abstract class AbstractGeneratorMojo extends AbstractMojo {
*/
protected static final String LS = System.lineSeparator();

/**
* The project currently being built.
*/
protected final MavenProject project;

protected AbstractGeneratorMojo(MavenProject project) {
this.project = project;
}

protected abstract void generate() throws MojoExecutionException;

@Override
Expand Down
16 changes: 12 additions & 4 deletions ...n-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
*/
package org.apache.maven.plugin.plugin;

import javax.inject.Inject;

import java.io.File;
import java.net.URI;
import java.util.Arrays;
Expand All @@ -38,6 +40,7 @@
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.apache.maven.tools.plugin.DefaultPluginToolsRequest;
import org.apache.maven.tools.plugin.ExtendedPluginDescriptor;
import org.apache.maven.tools.plugin.PluginToolsRequest;
Expand Down Expand Up @@ -262,11 +265,16 @@ public class DescriptorGeneratorMojo extends AbstractGeneratorMojo {
/**
* The component used for scanning the source tree for mojos.
*/
@Component
private MojoScanner mojoScanner;
private final MojoScanner mojoScanner;

@Component
protected BuildContext buildContext;
protected final BuildContext buildContext;

@Inject
public DescriptorGeneratorMojo(MavenProject project, MojoScanner mojoScanner, BuildContext buildContext) {
super(project);
this.mojoScanner = mojoScanner;
this.buildContext = buildContext;
}

public void generate() throws MojoExecutionException {

Expand Down
12 changes: 9 additions & 3 deletions maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/HelpGeneratorMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,19 @@
*/
package org.apache.maven.plugin.plugin;

import javax.inject.Inject;
import javax.lang.model.SourceVersion;

import java.io.File;
import java.util.Arrays;
import java.util.stream.Collectors;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.apache.maven.tools.plugin.generator.GeneratorException;
import org.apache.maven.tools.plugin.generator.PluginHelpGenerator;
import org.codehaus.plexus.util.StringUtils;
Expand Down Expand Up @@ -71,8 +72,13 @@ public class HelpGeneratorMojo extends AbstractGeneratorMojo {
/**
* Velocity component.
*/
@Component
private VelocityComponent velocity;
private final VelocityComponent velocity;

@Inject
public HelpGeneratorMojo(MavenProject project, VelocityComponent velocity) {
super(project);
this.velocity = velocity;
}

String getHelpPackageName() {
String packageName = null;
Expand Down
3 changes: 1 addition & 2 deletions maven-plugin-plugin/src/test/java/org/apache/maven/plugin/plugin/HelpGeneratorMojoTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ public static Stream<Arguments> packageNameShouldBeCorrect() {
@ParameterizedTest
@MethodSource
void packageNameShouldBeCorrect(MavenProject project, String expectedPackageName) {
HelpGeneratorMojo mojo = new HelpGeneratorMojo();
mojo.project = project;
HelpGeneratorMojo mojo = new HelpGeneratorMojo(project, null);

String packageName = mojo.getHelpPackageName();
assertEquals(expectedPackageName, packageName);
Expand Down