adds work on sql-formatter-org/sql-formatter/issues/184

Author: carywreams

sql-formatter-org/.gitignore

@@ -0,0 +1 @@
+node_modules

sql-formatter-org/Makefile

@@ -0,0 +1,18 @@
+AFTER:= $(patsubst before%.sql,after%.sql,$(wildcard before_*.sql))
+INTERIM:= $(patsubst before%.sql,interim%.sql,$(wildcard before_*.sql))
+
+interim_%.sql: before_%.sql
+	npx sql-formatter --config sql-formatter.json $< > $@
+
+after_%.sql: interim_%.sql
+	sed 's/\sdelimiter.*/\ndelimiter ;/g' $< > $@
+
+clean:
+	rm -f $(AFTER)
+	rm -f $(INTERIM)
+
+all: $(AFTER) $(INTERIM)
+
+.PHONY: all clean
+
+# ORIG npx sql-formatter -l mysql --config sql-formatter.json $< | sed 's/\sdelimiter.*/\ndelimiter ;/g' > $@

sql-formatter-org/README.md

@@ -0,0 +1,62 @@
+# sql-formatter-org issue 184, re ad-hoc support for delimiter support
+
++   [original report of failure](https://github.com/sql-formatter-org/sql-formatter/issues/184#issuecomment-1860370692)
++   [source of before_00.sql snippet](https://github.com/sql-formatter-org/sql-formatter/issues/184#issuecomment-1877062290)
+
+## My Goal
+
+I use sql-formatter as part of my workflow to build stored procedures from
+one or more CTEs that may be used in one or more stored procedures (CTE re-use).
+Generally, I have the following practices, which narrows the scope of the solution
+I'm in search of:
+
++   each CTE is defined in its own file, so that it may be included in a stored procedure source file via gpp
++   each stored procedure is defined in a single file
++   each stored procedure includes an ``END`` statement
++   each stored procedure file features a delimiter statement at the beginning of the file and a balancing delimiter statement at the end of the file:
+
+```
+delimiter $$
+
+drop procedure if exists procedure_name $$
+
+create procedure procedure_name ()
+BEGIN
+
+    #include cte00.sql
+    ,
+    #include ctr00.sql
+.
+.
+.
+END $$
+
+delimiter ;
+```
+
+## Filenames and Purposes
+
++   ``before`` series files capture originally authored input to be formatted
++   ``interim`` series files capture sql-formatter output
++   ``after`` series files capture my sed-manipulated sql-formatter output attempting to correct for delimiter usage
+
+
+## Observed to this point
+
++   output from sql-formatter combines lines that do not end with ``;``
++   lines using delimiters _other than_ `;` will be combined with the next line of source
++   the effect of combining lines by sql-formatter can be seen in the interim files
+
+
+## CONFIG Changes
+
+had to remove these config entries after upgrading to sql-formatter v15.0.2
+
+```
+  "commaPosition": "after",
+  "tabulateAlias": true,
+```
+
+currently using only two config options to specify my selection of mysql for
+both the language and dialect options. Other than that, the default
+sql-formatter options are being used.

sql-formatter-org/after_00.sql

@@ -0,0 +1,6 @@
+-- original reported complaint
+DROP Procedure IF EXISTS `Test`;
+
+DELIMITER $$ CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test` () NO SQL
+Select
+  1 $$ DELIMITER;

sql-formatter-org/after_01.sql

@@ -0,0 +1,9 @@
+-- my approach with blank line between END and final
+delimiter ;
+delimiter $$
+DROP Procedure IF EXISTS `Test` $$ CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test` () NO SQL
+Select
+  1;
+
+END $$
+delimiter ;

sql-formatter-org/after_02.sql

@@ -0,0 +1,7 @@
+delimiter DLMTR184
+DROP Procedure IF EXISTS `Test` DLMTR184 CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test` () NO SQL
+Select
+  1;
+
+END DLMTR184
+delimiter ;

sql-formatter-org/after_03.sql

@@ -0,0 +1,5 @@
+DROP Procedure IF EXISTS `Test`;
+
+CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test` () NO SQL
+Select
+  1 $$

sql-formatter-org/before_00.sql

@@ -0,0 +1,9 @@
+-- original reported complaint
+
+DROP Procedure IF EXISTS `Test`;
+
+DELIMITER $$
+CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test`()
+    NO SQL
+Select 1$$
+DELIMITER ;

sql-formatter-org/before_01.sql

@@ -0,0 +1,10 @@
+-- my approach with blank line between END and final delimiter at EOF
+delimiter $$
+
+DROP Procedure IF EXISTS `Test`$$
+
+CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test`()
+    NO SQL
+Select 1;
+END $$
+delimiter ;

sql-formatter-org/before_02.sql

@@ -0,0 +1,9 @@
+delimiter DLMTR184
+
+DROP Procedure IF EXISTS `Test` DLMTR184
+
+CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test`()
+    NO SQL
+Select 1;
+END DLMTR184
+delimiter ;

sql-formatter-org/before_03.sql

@@ -0,0 +1,5 @@
+DROP Procedure IF EXISTS `Test`;
+
+CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test`()
+    NO SQL
+Select 1$$

sql-formatter-org/interim_00.sql

@@ -0,0 +1,6 @@
+-- original reported complaint
+DROP Procedure IF EXISTS `Test`;
+
+DELIMITER $$ CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test` () NO SQL
+Select
+  1 $$ DELIMITER;

sql-formatter-org/interim_01.sql

@@ -0,0 +1,7 @@
+-- my approach with blank line between END and final delimiter at EOF
+delimiter $$
+DROP Procedure IF EXISTS `Test` $$ CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test` () NO SQL
+Select
+  1;
+
+END $$ delimiter;

sql-formatter-org/interim_02.sql

@@ -0,0 +1,6 @@
+delimiter DLMTR184
+DROP Procedure IF EXISTS `Test` DLMTR184 CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test` () NO SQL
+Select
+  1;
+
+END DLMTR184 delimiter;

sql-formatter-org/interim_03.sql

@@ -0,0 +1,5 @@
+DROP Procedure IF EXISTS `Test`;
+
+CREATE /* DEFINER=`zeugnis_nm_dev`@`localhost` */ PROCEDURE `Test` () NO SQL
+Select
+  1 $$

sql-formatter-org/package-lock.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "sql-formatter": "^15.0.2"
+  }
+}

sql-formatter-org/package.json

@@ -0,0 +1,4 @@
+{
+  "language": "mysql",
+  "dialect": "mysql"
+}

sql-formatter-org/sql-formatter.json

@@ -0,0 +1,13 @@
+{
+  "language": "mysql",
+  "dialect": "mysql",
+  "tabWidth": 2,
+  "useTabs": false,
+  "keywordCase": "upper",
+  "indentStyle": "tabularLeft",
+  "logicalOperatorNewline": "before",
+  "expressionWidth": 80,
+  "linesBetweenQueries": 0,
+  "denseOperators": false,
+  "newlineBeforeSemicolon":false
+}