Fixed spellings and some formatting

cflint · Mar 25, 2024 · f024e72 · f024e72
1 parent 208c354
commit f024e72
Show file tree

Hide file tree

Showing 38 changed files with 273 additions and 274 deletions.
diff --git a/RULES.md b/RULES.md
@@ -96,7 +96,7 @@ QueryNew statement should specify data types.
 
 **Severity**: WARNING
 
-**Message**: QueryNew statement should specify datatypes.
+**Message**: QueryNew statement should specify data types.
 
 ### VarScoper
 
@@ -230,7 +230,7 @@ Argument is missing a hint.
 
 **Severity**: INFO
 
-**Message**: Argument *variable* is missing a hint.  Use javadoc style annotations on cfscript functions.
+**Message**: Argument *variable* is missing a hint.  Use Javadoc style annotations on cfscript functions.
 
 ### ArgumentTypeChecker
 
@@ -392,7 +392,7 @@ Avoid use of arrayNew statements. Use [] instead.
 
 **Severity**: INFO
 
-**Message**: Use implict array construction instead (= []).
+**Message**: Use implicit array construction instead (= []).
 
 ### ComplexBooleanExpressionChecker
 
@@ -720,7 +720,7 @@ CFM File starts with upper case.
 
 #### AVOID_USING_CREATEOBJECT
 
-Avoid use of creatObject statements.
+Avoid use of createObject statements.
 
 **Severity**: INFO
 

diff --git a/pom.xml b/pom.xml
@@ -301,93 +301,93 @@
 			<id>deploy</id>
 			<build>
 				<plugins>
-		 	<!-- deployment -->
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-source-plugin</artifactId>
-				<version>2.4</version>
-				<executions>
-					<execution>
-						<id>attach-sources</id>
-						<goals>
-							<goal>jar</goal>
-						</goals>
-					</execution>
-				</executions>
-			</plugin>
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-javadoc-plugin</artifactId>
-				<version>2.10.1</version>
-				<executions>
-					<execution>
-						<id>attach-javadocs</id>
-						<goals>
-							<goal>jar</goal>
-						</goals>
-					</execution>
-				</executions>
-			</plugin>
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-gpg-plugin</artifactId>
-				<version>1.5</version>
-				<executions>
-					<execution>
-						<id>sign-artifacts</id>
-						<phase>verify</phase>
-						<goals>
-							<goal>sign</goal>
-						</goals>
-					</execution>
-				</executions>
-			</plugin>
-			<plugin>
-				<groupId>org.codehaus.mojo</groupId>
-				<artifactId>license-maven-plugin</artifactId>
-				<version>1.8</version>
-				<configuration>
-					<verbose>false</verbose>
-					<addSvnKeyWords>true</addSvnKeyWords>
-				</configuration>
-				<executions>
-					<execution>
-						<id>first</id>
-						<goals>
-							<goal>update-file-header</goal>
-						</goals>
-						<phase>process-sources</phase>
+					<!-- deployment -->
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-source-plugin</artifactId>
+						<version>2.4</version>
+						<executions>
+							<execution>
+								<id>attach-sources</id>
+								<goals>
+									<goal>jar</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-javadoc-plugin</artifactId>
+						<version>2.10.1</version>
+						<executions>
+							<execution>
+								<id>attach-javadocs</id>
+								<goals>
+									<goal>jar</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-gpg-plugin</artifactId>
+						<version>1.5</version>
+						<executions>
+							<execution>
+								<id>sign-artifacts</id>
+								<phase>verify</phase>
+								<goals>
+									<goal>sign</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.codehaus.mojo</groupId>
+						<artifactId>license-maven-plugin</artifactId>
+						<version>1.8</version>
 						<configuration>
-							<licenseName>bsd_2</licenseName>
-							<roots>
-								<root>src/main/java</root>
-								<root>src/test</root>
-							</roots>
-							<includes>
-								<include>*.java</include>
-							</includes>
-							<excludes>
-								<exclude>cfml.dictionary*</exclude>
-							</excludes>
+							<verbose>false</verbose>
+							<addSvnKeyWords>true</addSvnKeyWords>
 						</configuration>
-					</execution>
-				</executions>
-			</plugin>
-			<plugin>
-				<groupId>org.sonatype.plugins</groupId>
-				<artifactId>nexus-staging-maven-plugin</artifactId>
-				<version>1.6.5</version>
-				<extensions>true</extensions>
-				<configuration>
-					<serverId>ossrh</serverId>
-					<nexusUrl>https://oss.sonatype.org/</nexusUrl>
-					<autoReleaseAfterClose>false</autoReleaseAfterClose>
-				</configuration>
-			</plugin>
-			<!-- end deployment -->
-			     </plugins>
-		      </build>
-	       </profile>
+						<executions>
+							<execution>
+								<id>first</id>
+								<goals>
+									<goal>update-file-header</goal>
+								</goals>
+								<phase>process-sources</phase>
+								<configuration>
+									<licenseName>bsd_2</licenseName>
+									<roots>
+										<root>src/main/java</root>
+										<root>src/test</root>
+									</roots>
+									<includes>
+										<include>*.java</include>
+									</includes>
+									<excludes>
+										<exclude>cfml.dictionary*</exclude>
+									</excludes>
+								</configuration>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.sonatype.plugins</groupId>
+						<artifactId>nexus-staging-maven-plugin</artifactId>
+						<version>1.6.5</version>
+						<extensions>true</extensions>
+						<configuration>
+							<serverId>ossrh</serverId>
+							<nexusUrl>https://oss.sonatype.org/</nexusUrl>
+							<autoReleaseAfterClose>false</autoReleaseAfterClose>
+						</configuration>
+					</plugin>
+					<!-- end deployment -->
+				</plugins>
+			</build>
+		</profile>
 	</profiles>
 
 	<!-- mvn versions:set -DnewVersion=1.2.1 -->

diff --git a/src/main/java/com/cflint/CF.java b/src/main/java/com/cflint/CF.java
@@ -37,7 +37,7 @@ public class CF {
     public static final String CFDBINFO = "cfdbinfo";
 
     /**
-     * CFDeafulatCase Tag.
+     * CFDefaultCase Tag.
      */
     public static final String CFDEFAULTCASE = "cfdefaultcase";
 
@@ -195,7 +195,7 @@ public class CF {
     public static final String CFQUERYPARAM = "cfqueryparam";
 
     /**
-     * CFRegistory Tag.
+     * CFRegistry Tag.
      */
     public static final String CFREGISTRY = "cfregistry";
 
@@ -451,7 +451,7 @@ public class CF {
     public static final String ARGUMENTS = "arguments";
 
     /**
-     * CF scope cthread.
+     * CF scope cfthread.
      */
     public static final String CFTHREAD= "cfthread";
 

diff --git a/src/main/java/com/cflint/cli/CFLintCLI.java b/src/main/java/com/cflint/cli/CFLintCLI.java
@@ -82,8 +82,8 @@ public static void main(final String[] args) throws Exception {
         Option optionSTRICT_INCLUDE = new Option(Settings.STRICT_INCLUDE, false, "Check every include and try to parse it");
         Option optionLOGERROR = new Option(Settings.LOGERROR, false, "log parsing errors as bugs");
         Option optionE = new Option(Settings.E, false, "log parsing errors as bugs");
-        Option optionQUIET = new Option(Settings.QUIET, false, "quiet mode surpresses most linting error and commentary output");
-        Option optionQ = new Option(Settings.Q, false, "quiet mode surpresses most linting error and commentary output");
+        Option optionQUIET = new Option(Settings.QUIET, false, "quiet mode suppresses most linting error and commentary output");
+        Option optionQ = new Option(Settings.Q, false, "quiet mode suppresses most linting error and commentary output");
         Option optionDEBUG = new Option(Settings.DEBUG, false, "debug-level output during linting");
         Option optionD = new Option(Settings.D, false, "debug-level output during linting");
         Option optionHELP = new Option(Settings.HELP, false, DISPLAY_THIS_HELP);

diff --git a/src/main/java/com/cflint/cli/Settings.java b/src/main/java/com/cflint/cli/Settings.java
@@ -12,12 +12,12 @@ public class Settings {
     public static final String V = "v";
 
     /**
-     * quiet mode surpresses most linting error and commentary output
+     * quiet mode suppresses most linting error and commentary output
      */
     public static final String QUIET = "quiet";
 
     /**
-     * quiet mode surpresses most linting error and commentary output
+     * quiet mode suppresses most linting error and commentary output
      */
     public static final String Q = "q";
 
@@ -182,7 +182,7 @@ public class Settings {
     public static final String H = "h";
 
     /**
-     * List all rules orgered via teh groups they are in.
+     * List all rules ordered via the groups they are in.
      */
     public static final String LIST_RULE_GROUPS = "listrulegroups";
 

diff --git a/src/main/java/com/cflint/config/BaseConfig.java b/src/main/java/com/cflint/config/BaseConfig.java
@@ -11,7 +11,7 @@ public abstract class BaseConfig implements CFLintConfiguration{
 
     /**
      * get the string property from the configuration.
-     * This can be overriden with -DcheckerClass.propertyname=value
+     * This can be overridden with -DcheckerClass.propertyname=value
      *
      * @param linter    instance of current CFLintScanner plugin
      * @param name      the name of the parameter
@@ -42,7 +42,7 @@ public String getParameter(final CFLintScanner linter, final String name) {
 
     /**
      * get the string property from the configuration.  If it is null return empty string.
-     * This can be overriden with -DcheckerClass.propertyname=value
+     * This can be overridden with -DcheckerClass.propertyname=value
      *
      * @param linter    instance of current CFLintScanner plugin
      * @param name      the name of the parameter
@@ -59,7 +59,7 @@ public String getParameterNotNull(final CFLintScanner linter, final String name)
 
     /**
      * get the property from the configuration.
-     * This can be overriden with -DcheckerClass.propertyname=value
+     * This can be overridden with -DcheckerClass.propertyname=value
      *
      * @param linter    instance of current CFLintScanner plugin
      * @param name      the name of the parameter

diff --git a/src/main/java/com/cflint/config/CFLintConfiguration.java b/src/main/java/com/cflint/config/CFLintConfiguration.java
@@ -21,10 +21,10 @@ public interface CFLintConfiguration {
     void addExclude(PluginMessage pluginMessage);
 
     Collection<CFLintPluginInfo.PluginInfoRule> getRules();
-    
+
     /**
      * get the property from the configuration.
-     * This can be overriden with -DcheckerClass.propertyname=value
+     * This can be overridden with -DcheckerClass.propertyname=value
      *
      * @param name      the name of the parameter
      * @return          the value of the parameter

diff --git a/src/main/java/com/cflint/plugins/CFLintScannerAdapter.java b/src/main/java/com/cflint/plugins/CFLintScannerAdapter.java
@@ -60,7 +60,7 @@ public void setParameter(final String name, final Object value) {
     /**
      * @deprecated - Use context.getConfiguration().getParameter()
      * get the property from the configuration.
-     * This can be overriden with -DcheckerClass.propertyname=value
+     * This can be overridden with -DcheckerClass.propertyname=value
      *
      * @param name      the name of the parameter
      * @return          the value of the parameter

diff --git a/src/main/java/com/cflint/plugins/CFLintStructureListener.java b/src/main/java/com/cflint/plugins/CFLintStructureListener.java
@@ -3,16 +3,16 @@
 import com.cflint.BugList;
 
 /**
- * This interface supports plugins recieving structure notifications (file
+ * This interface supports plugins receiving structure notifications (file
  * start/end, component start/end, function start/end).
  *
- * Normally it is used for initialization or summarization types of behaviours.
+ * Normally it is used for initialization or summarization types of behaviors.
  */
 public interface CFLintStructureListener {
 
     /**
      * Called when processing of a new file has started
-     * 
+     *
      * @param fileName
      *            Name of the file that started
      * @param bugs
@@ -22,7 +22,7 @@ public interface CFLintStructureListener {
 
     /**
      * Called when processing of current file has ended
-     * 
+     *
      * @param fileName
      *            Name of the file that finished
      * @param bugs
@@ -32,7 +32,7 @@ public interface CFLintStructureListener {
 
     /**
      * Called when processing a new component has started
-     * 
+     *
      * @param context
      *            Current context
      * @param bugs
@@ -42,7 +42,7 @@ public interface CFLintStructureListener {
 
     /**
      * Called when processing of current component has ended
-     * 
+     *
      * @param context
      *            Current context
      * @param bugs
@@ -52,7 +52,7 @@ public interface CFLintStructureListener {
 
     /**
      * Called when processing of a new function has started
-     * 
+     *
      * @param context
      *            Current context
      * @param bugs
@@ -62,7 +62,7 @@ public interface CFLintStructureListener {
 
     /**
      * Called when processing of current function has ended
-     * 
+     *
      * @param context
      *            Current context
      * @param bugs