You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by el...@apache.org on 2025/06/29 13:45:03 UTC
(maven-enforcer) branch spell created (now d94044e)
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a change to branch spell
in repository https://gitbox.apache.org/repos/asf/maven-enforcer.git
at d94044e Fix a grab bag of typos and minor grammar errors
This branch includes the following new commits:
new d94044e Fix a grab bag of typos and minor grammar errors
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(maven-enforcer) 01/01: Fix a grab bag of typos and minor grammar errors
Posted by el...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch spell
in repository https://gitbox.apache.org/repos/asf/maven-enforcer.git
commit d94044e1c63defe02b51ababadec515495fbd67d
Author: Elliotte Rusty Harold <el...@ibiblio.org>
AuthorDate: Sun Jun 29 09:44:54 2025 -0400
Fix a grab bag of typos and minor grammar errors
---
CONTRIBUTING.md | 2 +-
.../java/org/apache/maven/enforcer/rule/api/EnforcerRule.java | 6 +++---
.../java/org/apache/maven/enforcer/rules/BannedRepositories.java | 2 +-
.../main/java/org/apache/maven/enforcer/rules/ExternalRules.java | 2 +-
.../org/apache/maven/enforcer/rules/ReactorModuleConvergence.java | 8 ++++----
.../org/apache/maven/enforcer/rules/RequirePluginVersions.java | 2 +-
.../enforcer/rules/checksum/NormalizeLineSeparatorReader.java | 2 +-
.../org/apache/maven/enforcer/rules/utils/ArtifactMatcher.java | 8 ++++----
.../maven/enforcer/rules/version/AbstractVersionEnforcer.java | 6 +++---
.../apache/maven/enforcer/rules/TestRequireNoRepositories.java | 4 ++--
.../apache/maven/enforcer/rules/TestRequirePluginVersions.java | 4 ++--
.../enforcer/rules/property/TestRequireEnvironmentVariable.java | 2 +-
.../main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java | 2 +-
.../maven/plugins/enforcer/internal/EnforcerRuleManagerTest.java | 2 +-
14 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index dc07b9f..c8ba264 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -17,7 +17,7 @@
Contributing to Apache Maven Enforcer
======================
-You have found a bug or you have an idea for a cool new feature? Contributing
+You have found a bug, or you have an idea for a cool new feature? Contributing
code is a great way to give something back to the open source community. Before
you dig right into the code there are a few guidelines that we need
contributors to follow so that we can have a chance of keeping on top of
diff --git a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java
index 8999726..dba86da 100644
--- a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java
+++ b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRule.java
@@ -38,7 +38,7 @@ public interface EnforcerRule extends EnforcerRuleBase {
* message as a warning.
*
* @param helper The helper provides access to the log, MavenSession and has
- * helpers to get common components. It is also able to lookup components
+ * helpers to get common components. It is also able to look up components
* by class name.
* @throws EnforcerRuleException the enforcer rule exception
*/
@@ -56,14 +56,14 @@ public interface EnforcerRule extends EnforcerRuleBase {
/**
* If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to
- * allow double checking of the results. Most of the time this can be done by generating unique ids, but sometimes
+ * allow double-checking of the results. Most of the time this can be done by generating unique ids, but sometimes
* the results of objects returned by the helper need to be queried. You may for example, store certain objects in
* your rule and then query them later.
*
* @param cachedRule the last cached instance of the rule. This is to be used by the rule to
* potentially determine if the results are still valid (ie if the configuration has been
* overridden)
- * @return <code>true</code> if the stored results are valid for the same id.
+ * @return <code>true</code> if the stored results are valid for the same id
*/
boolean isResultValid(@Nonnull EnforcerRule cachedRule);
diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java
index 8347965..ca375ca 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java
@@ -31,7 +31,7 @@ import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
import org.apache.maven.project.MavenProject;
/**
- * This rule checks that this project's maven session whether have banned repositories.
+ * This rule checks whether this project's maven session has banned repositories.
*
* @author <a href="mailto:wangyf2010@gmail.com">Simon Wang</a>
*/
diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ExternalRules.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ExternalRules.java
index 540024b..ccaee83 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ExternalRules.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ExternalRules.java
@@ -209,7 +209,7 @@ public final class ExternalRules extends AbstractEnforcerRuleConfigProvider {
| TransformerFactoryConfigurationError e) {
throw new RuntimeException("Could not open resource " + xsltLocation);
} catch (TransformerException e) {
- throw new RuntimeException("Could not transform " + sourceLocation + " usinng XSLT " + xsltLocation);
+ throw new RuntimeException("Could not transform " + sourceLocation + " using XSLT " + xsltLocation);
}
}
}
diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java
index afceb8e..ff29608 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java
@@ -35,7 +35,7 @@ import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.StringUtils;
/**
- * This rule will check if a multi module build will follow the best practices.
+ * This rule will check if a multi-module build will follow the best practices.
*
* @author Karl-Heinz Marbaise
* @since 1.4
@@ -192,7 +192,7 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule
}
}
} else {
- // This situation is currently ignored, cause it's handled by existModulesWithoutParentsInReactor()
+ // This situation is currently ignored because it's handled by existModulesWithoutParentsInReactor()
}
}
@@ -254,7 +254,7 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule
}
/**
- * Assume we have a module which is a child of a multi module build but this child does not have a parent. This
+ * Assume we have a module which is a child of a multi-module build but this child does not have a parent. This
* method will exactly search for such cases.
*
* @param sortedProjects The sorted list of the reactor modules.
@@ -304,7 +304,7 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule
/**
* Go through the list of modules in the builds and check if we have dependencies. If yes we will check every
- * dependency based on groupId/artifactId if it belongs to the multi module build. In such a case it will be checked
+ * dependency based on groupId/artifactId if it belongs to the multi-module build. In such a case it will be checked
* if the version does fit the version in the rest of build.
*
* @param reactorVersion the version of the reactor
diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java
index 324749a..fa92e05 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java
@@ -496,7 +496,7 @@ public final class RequirePluginVersions extends AbstractStandardEnforcerRule {
+ lifecycle.getId());
allPlugins.addAll(getAllPlugins(project, lifecycle));
} catch (BuildFailureException e) {
- // i'm going to swallow this because the
+ // swallow this because the
// user may have declared a phase that
// doesn't exist for every module.
}
diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/checksum/NormalizeLineSeparatorReader.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/checksum/NormalizeLineSeparatorReader.java
index 172261a..553c61d 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/checksum/NormalizeLineSeparatorReader.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/checksum/NormalizeLineSeparatorReader.java
@@ -23,7 +23,7 @@ import java.io.IOException;
import java.io.Reader;
/**
- * Converts Unix line separators to Windows ones and vice-versa.
+ * Converts Unix line separators to Windows ones and vice versa.
*/
class NormalizeLineSeparatorReader extends FilterReader {
diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactMatcher.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactMatcher.java
index 7d90039..086414f 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactMatcher.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactMatcher.java
@@ -222,13 +222,13 @@ public final class ArtifactMatcher {
}
/**
- * Copied from Artifact.VersionRange. This is tweaked to handle singular ranges properly. Currently the default
+ * Copied from Artifact.VersionRange. This is tweaked to handle singular ranges properly. Currently, the default
* containsVersion method assumes a singular version means allow everything. This method assumes that "2.0.4" ==
* "[2.0.4,)"
*
- * @param allowedRange range of allowed versions.
- * @param theVersion the version to be checked.
- * @return true if the version is contained by the range.
+ * @param allowedRange range of allowed versions
+ * @param theVersion the version to be checked
+ * @return true if the version is contained by the range
*/
public static boolean containsVersion(VersionRange allowedRange, ArtifactVersion theVersion) {
ArtifactVersion recommendedVersion = allowedRange.getRecommendedVersion();
diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/AbstractVersionEnforcer.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/AbstractVersionEnforcer.java
index 80ffbb4..f9417e1 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/AbstractVersionEnforcer.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/AbstractVersionEnforcer.java
@@ -51,9 +51,9 @@ abstract class AbstractVersionEnforcer extends AbstractStandardEnforcerRule {
/**
* Compares the specified version to see if it is allowed by the defined version range.
*
- * @param variableName name of variable to use in messages (Example: "Maven" or "Java" etc).
- * @param requiredVersionRange range of allowed versions.
- * @param actualVersion the version to be checked.
+ * @param variableName name of variable to use in messages.For example, "Maven" or "Java".
+ * @param requiredVersionRange range of allowed versions
+ * @param actualVersion the version to be checked
* @throws EnforcerRuleException the enforcer rule exception
*/
// CHECKSTYLE_OFF: LineLength
diff --git a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequireNoRepositories.java b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequireNoRepositories.java
index 62892ba..c490777 100644
--- a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequireNoRepositories.java
+++ b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequireNoRepositories.java
@@ -165,7 +165,7 @@ class TestRequireNoRepositories {
}
/**
- * The model contains a single repository which is is not allowed by the default rules.
+ * The model contains a single repository which is not allowed by the default rules.
*/
@Test
void testAllBannedWithRepository() {
@@ -179,7 +179,7 @@ class TestRequireNoRepositories {
}
/**
- * The model contains a single plugin repository which is is not allowed by the default rules.
+ * The model contains a single plugin repository which is not allowed by the default rules.
*/
@Test
void testAllBannedWithPluginRepository() {
diff --git a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequirePluginVersions.java b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequirePluginVersions.java
index 511ca40..9026d4a 100644
--- a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequirePluginVersions.java
+++ b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequirePluginVersions.java
@@ -115,7 +115,7 @@ class TestRequirePluginVersions {
source.setArtifactId("foo");
source.setGroupId("group");
- // setup the plugins. I'm setting up the foo group
+ // set up the plugins. I'm setting up the foo group
// with a few bogus entries and then a real one.
// to test that the list is exhaustively
// searched for versions before giving up.
@@ -192,7 +192,7 @@ class TestRequirePluginVersions {
Plugin source = new Plugin();
source.setGroupId("group");
- // setup the plugins.
+ // set up the plugins.
List<Plugin> plugins = new ArrayList<>();
plugins.add(EnforcerTestUtils.newPlugin("group", "a-artifact", "1.0-${SNAPSHOT}"));
plugins.add(EnforcerTestUtils.newPlugin("group", "b-artifact", "${1.0}"));
diff --git a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/property/TestRequireEnvironmentVariable.java b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/property/TestRequireEnvironmentVariable.java
index 9e97fd4..f8ea03f 100755
--- a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/property/TestRequireEnvironmentVariable.java
+++ b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/property/TestRequireEnvironmentVariable.java
@@ -76,7 +76,7 @@ class TestRequireEnvironmentVariable {
// expected to catch this.
}
- // can't really predict what a PATH will looks like, just enforce it ain't empty
+ // can't really predict what a PATH will look like, just enforce it ain't empty
rule.setRegex(".{1,}");
try {
rule.execute();
diff --git a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java
index 4f2eb79..5747c9b 100644
--- a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java
+++ b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java
@@ -355,7 +355,7 @@ public class EnforceMojo extends AbstractMojo {
/**
* Create rules configuration based on command line provided rules list.
*
- * @return an configuration in case where rules list is present or empty
+ * @return a configuration in case where rules list is present or empty
*/
private Optional<PlexusConfiguration> createRulesFromCommandLineOptions() {
diff --git a/maven-enforcer-plugin/src/test/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleManagerTest.java b/maven-enforcer-plugin/src/test/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleManagerTest.java
index 6799d8c..c794f90 100644
--- a/maven-enforcer-plugin/src/test/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleManagerTest.java
+++ b/maven-enforcer-plugin/src/test/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleManagerTest.java
@@ -250,7 +250,7 @@ class EnforcerRuleManagerTest {
}
@Test
- void ruleLevelShouldBeDisoveredFromConfigured() throws Exception {
+ void ruleLevelShouldBeDiscoveredFromConfigured() throws Exception {
setupMocks();