Skip to content
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

Jump to bottom

Fixed spellings and some formatting #733

Merged
merged 1 commit into from
Mar 25, 2024
Merged

Fixed spellings and some formatting #733

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions RULES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
170 changes: 85 additions & 85 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/cflint/CF.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public class CF {
public static final String CFDBINFO = "cfdbinfo";

/**
* CFDeafulatCase Tag.
* CFDefaultCase Tag.
*/
public static final String CFDEFAULTCASE = "cfdefaultcase";

Expand Down Expand Up @@ -195,7 +195,7 @@ public class CF {
public static final String CFQUERYPARAM = "cfqueryparam";

/**
* CFRegistory Tag.
* CFRegistry Tag.
*/
public static final String CFREGISTRY = "cfregistry";

Expand Down Expand Up @@ -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";

Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/cflint/cli/CFLintCLI.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/cflint/cli/Settings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";

Expand Down Expand Up @@ -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";

Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/cflint/config/BaseConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/cflint/config/CFLintConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/cflint/plugins/CFLintScannerAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/com/cflint/plugins/CFLintStructureListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -32,7 +32,7 @@ public interface CFLintStructureListener {

/**
* Called when processing a new component has started
*
*
* @param context
* Current context
* @param bugs
Expand All @@ -42,7 +42,7 @@ public interface CFLintStructureListener {

/**
* Called when processing of current component has ended
*
*
* @param context
* Current context
* @param bugs
Expand All @@ -52,7 +52,7 @@ public interface CFLintStructureListener {

/**
* Called when processing of a new function has started
*
*
* @param context
* Current context
* @param bugs
Expand All @@ -62,7 +62,7 @@ public interface CFLintStructureListener {

/**
* Called when processing of current function has ended
*
*
* @param context
* Current context
* @param bugs
Expand Down