Merge pull request #230 from Trivadis/feature/issue-229-supress-syntax-errors

Feature/issue 229 suppress syntax errors

Author: PhilippSalvisberg

README.md

@@ -6,7 +6,7 @@ This repository provides formatter settings for the [coding style rules](https:/
 
 Settings are primarily provided for
 
-- [Oracle SQLcl, Version 22.2.0](https://www.oracle.com/tools/downloads/sqlcl-downloads.html)
+- [Oracle SQLcl, Version 22.2.1](https://www.oracle.com/tools/downloads/sqlcl-downloads.html)
 - [Oracle SQL Developer, Version 22.2.0](https://www.oracle.com/tools/downloads/sqldev-downloads.html)
 
 These settings have been defined and tested with the product versions mentioned above. They might not work in other versions.

sqlcl/README.md

@@ -28,7 +28,7 @@ We recommend you download, clone, or fork this repository when you plan to use [
 However, [`format.js`](format.js) also works as a standalone script. Here's the usage:
 
 ```
-Trivadis PL/SQL & SQL Formatter (format.js), version 22.2.0
+Trivadis PL/SQL & SQL Formatter (format.js), version 22.2.1
 
 usage: script format.js <rootPath> [options]
 
@@ -48,6 +48,11 @@ options:
   ignore=<file>   path to the file containing file patterns to ignore. Patterns are defined
                   per line. Each line represent a glob pattern. Empty lines and lines starting
                   with a hash sign (#) are ignored.
+  serr=<scope>    scope of syntax errors to be reported. By default all errors are reported.
+                  serr=none reports no syntax errors
+                  serr=all reports all syntax errors
+                  serr=ext reports syntax errors for files defined with ext option
+                  serr=mext reports syntax errors for files defined with mext option
   --help, -h,     print this help screen and exit
   --version, -v   print version and exit
   --register, -r  register SQLcl command tvdformat and exit
@@ -64,7 +69,7 @@ script (...)/plsql-formatter-settings/sqlcl/format.js --register
 Afterwards you can type `tvdformat` to get this usage help:
 
 ```
-Trivadis PL/SQL & SQL Formatter (tvdformat), version 22.2.0
+Trivadis PL/SQL & SQL Formatter (tvdformat), version 22.2.1
 
 usage: tvdformat <rootPath> [options]
 
@@ -84,6 +89,11 @@ options:
   ignore=<file>   path to the file containing file patterns to ignore. Patterns are defined
                   per line. Each line represent a glob pattern. Empty lines and lines starting
                   with a hash sign (#) are ignored.
+  serr=<scope>    scope of syntax errors to be reported. By default all errors are reported.
+                  serr=none reports no syntax errors
+                  serr=all reports all syntax errors
+                  serr=ext reports syntax errors for files defined with ext option
+                  serr=mext reports syntax errors for files defined with mext option
   --help, -h,     print this help screen and exit
   --version, -v   print version and exit
 ```

sqlcl/format.js

@@ -229,6 +229,11 @@ var printUsage = function (asCommand, standalone) {
     ctx.write("  ignore=<file>   path to the file containing file patterns to ignore. Patterns are defined\n");
     ctx.write("                  per line. Each line represent a glob pattern. Empty lines and lines starting\n");
     ctx.write("                  with a hash sign (#) are ignored.\n");
+    ctx.write("  serr=<scope>    scope of syntax errors to be reported. By default all errors are reported.\n");
+    ctx.write("                  serr=none reports no syntax errors\n");
+    ctx.write("                  serr=all reports all syntax errors\n");
+    ctx.write("                  serr=ext reports syntax errors for files defined with ext option\n");
+    ctx.write("                  serr=mext reports syntax errors for files defined with mext option\n");
     ctx.write("  --help, -h,     print this help screen and exit\n")
     ctx.write("  --version, -v   print version and exit\n")
     if (!asCommand && !standalone) {
@@ -302,6 +307,7 @@ var processAndValidateArgs = function (args) {
     var arboriPath = null;
     var ignorePath = null;
     var ignoreMatcher = null;
+    var serr = null;
     var files = [];
     var result = function (valid) {
         return {
@@ -312,6 +318,7 @@ var processAndValidateArgs = function (args) {
             xmlPath: xmlPath,
             arboriPath: arboriPath,
             ignoreMatcher: ignoreMatcher,
+            serr: serr,
             valid: valid
         };
     }
@@ -371,6 +378,9 @@ var processAndValidateArgs = function (args) {
             if (typeof configJson.ignore !== 'undefined') {
                 ignorePath = configJson.ignore;
             }
+            if (typeof configJson.serr !== 'undefined') {
+                serr = configJson.serr.toLowerCase();
+            }
             if (typeof configJson.files !== 'undefined') {
                 if (!Array.isArray(configJson.files)) {
                     ctx.write("files in " + rootPath + " is not an array.\n\n");
@@ -431,6 +441,10 @@ var processAndValidateArgs = function (args) {
             ignorePath = args[i].substring(7);
             continue;
         }
+        if (args[i].toLowerCase().indexOf("serr=") === 0) {
+            serr = args[i].substring(5).toLowerCase();
+            continue;
+        }
         ctx.write("invalid argument " + args[i] + ".\n\n");
         return result(false);
     }
@@ -482,6 +496,14 @@ var processAndValidateArgs = function (args) {
         }
         ignoreMatcher = createIgnoreMatcher(ignorePath);
     }
+    if (serr == null) {
+        serr = "all";
+    } else {
+        if (serr !== "all" && serr !== "none" && serr !== "ext" && serr != "mext") {
+            ctx.write("invalid scope '" + serr + "' for serr. Valid are: all, none, ext, mext.\n\n");
+            return result(false);
+        }
+    }
     return result(true);
 }
 
@@ -511,17 +533,26 @@ var isMarkdownFile = function (file, markdownExtensions) {
     return false;
 }
 
-var formatMarkdownFile = function (file, formatter) {
+var formatMarkdownFile = function (file, formatter, serr) {
     var original = readFile(file)
     var p = javaPattern.compile("(```\\s*sql\\s*\\n)(.+?)(\\n```)", javaPattern.DOTALL);
     var m = p.matcher(original);
     var result = "";
     var pos = 0;
+    var consoleOutput = false;
+    if (serr == "all" || serr == "mext") {
+        consoleOutput = true;
+    }
+    var sqlBlock = 0;
     while (m.find()) {
+        sqlBlock++;
+        ctx.write("#" + sqlBlock + "... ");
         result += original.substring(pos, m.end(1));
-        if (hasParseErrors(m.group(2), false)) {
+        if (hasParseErrors(m.group(2), consoleOutput)) {
+            ctx.write("skipped... ")
             result += original.substring(m.start(2), m.end(3));
         } else {
+            ctx.write("done... ")
             result += formatter.format(m.group(2));
             result += original.substring(m.end(2), m.end(3));
         }
@@ -546,24 +577,28 @@ var getLineSeparator = function (input) {
     return lineSep;
 }
 
-var formatFile = function (file, formatter) {
+var formatFile = function (file, formatter, serr) {
     var original = readFile(file)
-    if (hasParseErrors(original, true)) {
+    var consoleOutput = false;
+    if (serr == "all" || serr == "ext") {
+        consoleOutput = true;
+    }
+    if (hasParseErrors(original, consoleOutput)) {
         ctx.write("skipped.\n");
     } else {
         writeFile(file, formatter.format(original) + getLineSeparator(original));
         ctx.write("done.\n");
     }
 }
 
-var formatFiles = function (files, formatter, markdownExtensions) {
+var formatFiles = function (files, formatter, markdownExtensions, serr) {
     for (var i = 0; i < files.length; i++) {
         ctx.write("Formatting file " + (i + 1) + " of " + files.length + ": " + files[i].toString() + "... ");
         ctx.getOutputStream().flush();
         if (isMarkdownFile(files[i], markdownExtensions)) {
-            formatMarkdownFile(files[i], formatter);
+            formatMarkdownFile(files[i], formatter, serr);
         } else {
-            formatFile(files[i], formatter);
+            formatFile(files[i], formatter, serr);
         }
         ctx.getOutputStream().flush();
     }
@@ -617,7 +652,7 @@ var run = function (args) {
                 } else {
                     files = getFiles(options.rootPath, options.extensions, options.ignoreMatcher);
                 }
-                formatFiles(files, formatter, options.markdownExtensions);
+                formatFiles(files, formatter, options.markdownExtensions, options.serr);
             }
         }
     }

standalone/install_sqlcl_libs.sh

@@ -15,11 +15,13 @@ if ! test -f "${SQLCL_LIBDIR}/dbtools-common.jar"; then
 fi
 
 # define common Maven properties
-SQLCL_VERSION="22.2.0"
+SQLCL_VERSION="22.2.1"
 
 # install JAR files in local Maven repository, these libs are not available in public Maven repositories
-mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile=$SQLCL_LIBDIR/dbtools-common.jar
-mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile=$SQLCL_LIBDIR/dbtools-sqlcl.jar
+mvn install:install-file -Dfile=$SQLCL_LIBDIR/dbtools-common.jar \
+        -DgroupId=oracle.dbtools -DartifactId=dbtools-common -Dversion=$SQLCL_VERSION -Dpackaging=jar
+mvn install:install-file -Dfile=$SQLCL_LIBDIR/dbtools-sqlcl.jar \
+        -DgroupId=oracle.dbtools -DartifactId=dbtools-sqlcl -Dversion=$SQLCL_VERSION -Dpackaging=jar
 mvn install:install-file -Dfile=$SQLCL_LIBDIR/xmlparserv2_sans_jaxp_services.jar \
         -DgroupId=oracle.xml -DartifactId=xmlparserv2-sans-jaxp-services -Dversion=$SQLCL_VERSION -Dpackaging=jar
 mvn install:install-file -Dfile=$SQLCL_LIBDIR/orai18n.jar \

standalone/pom.xml

@@ -12,7 +12,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <jdk.version>11</jdk.version>
         <jdk.test.version>17</jdk.test.version>
-        <sqlcl.version>22.2.0</sqlcl.version>
+        <sqlcl.version>22.2.1</sqlcl.version>
         <graalvm.version>22.2.0</graalvm.version>
         <native.maven.plugin.version>0.9.13</native.maven.plugin.version>
         <reflections.version>0.10.2</reflections.version>