Skip to content

Improve example of custom rule #890

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
merged 2 commits into from
Jun 26, 2025
Merged

Improve example of custom rule #890

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a268d6
Improve example of custom rule
slawekjaranowski Jun 21, 2025
ef7c274
add maven.compiler.release to example
slawekjaranowski Jun 26, 2025
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
3 changes: 1 addition & 2 deletions enforcer-api/src/custom-rule-sample/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
<properties>
<api.version>${project.version}</api.version>
<mavenVersion>${mavenVersion}</mavenVersion>
<!-- use JDK 1.8 or 11 -->
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>
Expand Down Expand Up @@ -66,7 +65,7 @@
<!-- generate index of project components -->
<groupId>org.eclipse.sisu</groupId>
<artifactId>sisu-maven-plugin</artifactId>
<version>0.9.0.M1</version>
<version>${version.sisu-maven-plugin}</version>
<executions>
<execution>
<goals>
Expand Down
15 changes: 10 additions & 5 deletions enforcer-api/src/custom-rule-sample/src/main/java/org/example/custom/rule/MyCustomRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import javax.inject.Named;

import java.util.List;
import java.util.Objects;

import org.apache.maven.enforcer.rule.api.AbstractEnforcerRule;
import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
Expand All @@ -49,14 +50,18 @@ public class MyCustomRule extends AbstractEnforcerRule {

// Inject needed Maven components

@Inject
private MavenProject project;
private final MavenProject project;

@Inject
private MavenSession session;
private final MavenSession session;

private final RuntimeInformation runtimeInformation;

@Inject
private RuntimeInformation runtimeInformation;
public MyCustomRule(MavenProject project, MavenSession session, RuntimeInformation runtimeInformation) {
this.project = Objects.requireNonNull(project);
this.session = Objects.requireNonNull(session);
this.runtimeInformation = Objects.requireNonNull(runtimeInformation);
}

public void execute() throws EnforcerRuleException {

Expand Down