Prepare for release

Author: gretard

README.md

@@ -123,6 +123,59 @@ Please configure additional properties:
 - When you want SQL plugin execution ( this will disable pssql plugin): 
 `sonar.lang.patterns.plsqlopen=na`
 
+## Using command line tools
+With the plugin - there are additional 2 cli tools available (they are not required for sonar execution):
+
+ - **sql-sca-cli.jar** - allows to execute sql code analysis from the command line
+ - **rulesHelper.jar** - command line helper tool for writing custom sql rules
+ 
+### sql-sca-cli
+Usage:
+
+- ```java -jar sql-sca-cli.jar --help``` - will print help
+- ```java -jar sql-sca-cli.jar```  - will scan current directory
+- ```java -jar sql-sca-cli.jar -i /home/test``` - will scan test directory
+ 
+Full help info:
+ ```usage: sql-sca-cli
+ -c,--custom-rules-path <arg>           path to custom rules directory,
+                                        defaults to current directory
+ -csuffix,--custom-rules-suffix <arg>   custom rules suffix, defaults to:
+                                        .customRules
+ -d,--dialect <arg>                     SQL dialect, defaults to: tsql,
+                                        possible values: [TSQL, PSSQL,
+                                        MYSQL, VSQL, PSSQLV2]
+ -h,--help                              show help
+ -i,--input <arg>                       input directory for analysis,
+                                        defaults to current directory
+ -p,--prefixes <arg>                    file prefixes for analysis,
+                                        defaults to: .sql
+ -warnOnly,--warnOnly                   flag whether tool should report
+                                        warnings only
+```
+
+### rulesHelper
+Usage:
+
+- ```java -jar rulesHelper.jar``` - will print help
+- ```java -jar rulesHelper.jar print text "SELECT * FROM dbo.test;" tsql``` - will print parsed AST tree for TSQL dialect
+
+Full help info:
+
+```
+Please pass the following: 
+	action (print or  verify)
+	type (text or  file)
+	value (sql string or path to folder) 
+	dialect (tsql, pssql, mysql, pssql, pssqlv2) 
+Example:
+print text "SELECT * FROM dbo.test;" tsql
+
+Example:
+verify file "c:/tests/customRules.rules;" mysql
+```
+
+
 ## Contributing ##
 Added container definitions for easy development with VSCode. Download the [remote containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) and let it figure out the maven targets. 
 <img width="1917" alt="vscode_remote_containers_extension_maven" src="https://user-images.githubusercontent.com/3657015/125957363-653c9f6f-b5cc-4a3c-96ef-9dc18d0f8bfb.png">

src/sonar-sql-plugin/pom.xml

@@ -70,6 +70,12 @@
 			<version>4.13.2</version>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>commons-cli</groupId>
+			<artifactId>commons-cli</artifactId>
+			<version>1.5.0</version>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>com.fasterxml.jackson.dataformat</groupId>
 			<artifactId>jackson-dataformat-xml</artifactId>

src/sonar-sql-plugin/src/main/java/org/antlr/sql/dialects/Dialects.java

@@ -1,6 +1,8 @@
 package org.antlr.sql.dialects;
 
+import java.util.Arrays;
 import java.util.Collections;
+import java.util.LinkedList;
 import java.util.List;
 
 import org.antlr.sql.dialects.rules.CommonRules;
@@ -15,6 +17,24 @@ public AntlrContext parse(String text) {
 		return parse(text, Collections.emptyList());
 	}
 
+	public List<SqlRules> getDialectRules(SqlRules... additionalRules) {
+		var rules = new LinkedList<SqlRules>();
+		SQLDialectRules.INSTANCE.getRules().forEach(r -> {
+			if (r.getDialect() == null || this.name().equalsIgnoreCase(r.getDialect())) {
+				rules.add(r);
+			}
+
+		});
+
+		rules.addAll(CommonRules.INSTANCE.getRules());
+		rules.addAll(Arrays.asList(additionalRules));
+		return rules;
+	}
+
+	public AntlrContext parseInitialContext(String text) {
+		return this.dialect.parse(text);
+	}
+
 	public AntlrContext parse(String text, List<SqlRules> rules) {
 		AntlrContext ctx = this.dialect.parse(text);
 		ctx.initialContents = text;

src/sonar-sql-plugin/src/main/java/org/sonar/plugins/sql/issues/RuleToCheck.java

@@ -57,6 +57,22 @@ public static List<RuleToCheck> createCodeList2(SqlRules... list) {
         return items;
     }
 
+
+    public static List<RuleToCheck> createCodeList2(List<SqlRules> list) {
+        List<RuleToCheck> items = new LinkedList<>();
+        for (SqlRules item : list) {
+            item.getRule().forEach(rule -> {
+                if (rule.getRuleAppliesTo() == null || "code".equalsIgnoreCase(rule.getRuleAppliesTo())) {
+                    items.add(new RuleToCheck(item, rule));
+                }
+            });
+        }
+
+        return items;
+    }
+
+    
+    
     public static List<RuleToCheck> createCommentsList(SqlRules... list) {
         List<RuleToCheck> items = new LinkedList<>();
         for (SqlRules item : list) {

src/sonar-sql-plugin/src/test/java/org/antlr/sql/tools/RulesHelperTool.java

@@ -24,7 +24,7 @@ public static void main(String[] args) throws FileNotFoundException, IOException
             System.out.println("\taction (print or  verify)");
             System.out.println("\ttype (text or  file)");
             System.out.println("\tvalue (sql string or path to folder) ");
-            System.out.println("\tdialect (tsql, pssql, mysql) ");
+            System.out.println("\tdialect (tsql, pssql, mysql, pssql, pssqlv2) ");
 
             System.out.println("Example:\r\nprint text \"SELECT * FROM dbo.test;\" tsql\r\n");
             System.out.println("Example:\r\nverify file \"c:/tests/customRules.rules;\" mysql");