-
Notifications
You must be signed in to change notification settings - Fork 153
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
83 changed files
with
1,582 additions
and
784 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
130 changes: 0 additions & 130 deletions
130
...api/src/custom-rule-sample/src/main/java/org/apache/maven/enforcer/rule/MyCustomRule.java
This file was deleted.
Oops, something went wrong.
103 changes: 103 additions & 0 deletions
103
enforcer-api/src/custom-rule-sample/src/main/java/org/example/custom/rule/MyCustomRule.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| // START SNIPPET: rule-implementation | ||
| package org.example.custom.rule; | ||
|
|
||
| import javax.inject.Inject; | ||
| import javax.inject.Named; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import org.apache.maven.enforcer.rule.api.AbstractEnforcerRule; | ||
| import org.apache.maven.enforcer.rule.api.EnforcerRuleException; | ||
| import org.apache.maven.execution.MavenSession; | ||
| import org.apache.maven.project.MavenProject; | ||
| import org.apache.maven.rtinfo.RuntimeInformation; | ||
|
|
||
| /** | ||
| * Custom Enforcer Rule - example | ||
| */ | ||
| @Named("myCustomRule") // rule name - must start from lowercase character | ||
| public class MyCustomRule extends AbstractEnforcerRule { | ||
|
|
||
| /** | ||
| * Simple param. This rule fails if the value is true. | ||
| */ | ||
| private boolean shouldIfail = false; | ||
|
|
||
| /** | ||
| * Rule parameter as list of items. | ||
| */ | ||
| private List<String> listParameters; | ||
|
|
||
| // Inject needed Maven components | ||
|
|
||
| @Inject | ||
| private MavenProject project; | ||
|
|
||
| @Inject | ||
| private MavenSession session; | ||
|
|
||
| @Inject | ||
| private RuntimeInformation runtimeInformation; | ||
|
|
||
| public void execute() throws EnforcerRuleException { | ||
|
|
||
| getLog().info("Retrieved Target Folder: " + project.getBuild().getDirectory()); | ||
| getLog().info("Retrieved ArtifactId: " + project.getArtifactId()); | ||
| getLog().info("Retrieved Project: " + project); | ||
| getLog().info("Retrieved Maven version: " + runtimeInformation.getMavenVersion()); | ||
| getLog().info("Retrieved Session: " + session); | ||
| getLog().warnOrError("Parameter shouldIfail: " + shouldIfail); | ||
| getLog().info(() -> "Parameter listParameters: " + listParameters); | ||
|
|
||
| if (this.shouldIfail) { | ||
| throw new EnforcerRuleException("Failing because my param said so."); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * If your rule is cacheable, you must return a unique id when parameters or conditions | ||
| * change that would cause the result to be different. Multiple cached results are stored | ||
| * based on their id. | ||
| * <p> | ||
| * The easiest way to do this is to return a hash computed from the values of your parameters. | ||
| * <p> | ||
| * If your rule is not cacheable, then you don't need to override this method or return null | ||
| */ | ||
| @Override | ||
| public String getCacheId() { | ||
| //no hash on boolean...only parameter so no hash is needed. | ||
| return Boolean.toString(shouldIfail); | ||
| } | ||
|
|
||
| /** | ||
| * A good practice is provided toString method for Enforcer Rule. | ||
| * <p> | ||
| * Output is used in verbose Maven logs, can help during investigate problems. | ||
| * | ||
| * @return rule description | ||
| */ | ||
| @Override | ||
| public String toString() { | ||
| return String.format("MyCustomRule[level=%s, shouldIfail=%b]", getLevel(), shouldIfail); | ||
| } | ||
| } | ||
| // END SNIPPET: rule-implementation |
Oops, something went wrong.