feat(sage-monorepo): integrate SQL formatter and linter (ARCH-296) (#…

…2863)

.devcontainer/devcontainer.json

@@ -29,6 +29,7 @@
         "alefragnani.Bookmarks",
         "Angular.ng-template",
         "dbaeumer.vscode-eslint",
+        "dorzey.vscode-sqlfluff",
         "eamodio.gitlens",
         "emeraldwalk.RunOnSave",
         "esbenp.prettier-vscode",

.prettierrc.yml

@@ -3,4 +3,5 @@ printWidth: 100
 singleQuote: true
 plugins:
   - prettier-plugin-java
+  - prettier-plugin-sql
   - prettier-plugin-tailwindcss

.vscode/settings.json

@@ -10,6 +10,8 @@
   "scss.validate": false,
   "stylelint.enable": true,
   "stylelint.validate": ["css", "scss"],
+  "sqlfluff.executablePath": "${workspaceFolder}/.venv/bin/sqlfluff",
+  "sqlfluff.format.enabled": false,
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
   "editor.tabSize": 2,

apps/openchallenges/postgres/docker-entrypoint-initdb.d/init-db.sql

@@ -1,4 +1,9 @@
+-- sqlfluff:dialect:postgres
 -- keycloak
-CREATE USER keycloak WITH ENCRYPTED PASSWORD 'changeme';
+CREATE USER keycloak
+WITH
+  ENCRYPTED PASSWORD 'changeme';
+
 CREATE DATABASE keycloak;
-GRANT ALL PRIVILEGES ON DATABASE keycloak TO keycloak;
+
+GRANT all PRIVILEGES ON DATABASE keycloak TO keycloak;

apps/openchallenges/user-service/session.sql

@@ -1,15 +1,17 @@
+-- sqlfluff:dialect:mariadb
 -- @block list users
-
-SELECT * FROM challenge_user;
+SELECT
+  *
+FROM
+  challenge_user;
 
 -- @block delete user by id
-
-DELETE FROM challenge_user WHERE id=1;
+DELETE FROM challenge_user
+WHERE
+  id = 1;
 
 -- @block delete all users
-
 DELETE FROM challenge_user;
 
 -- @block delete flyway schema history
-
-DELETE FROM flyway_schema_history;
+DELETE FROM flyway_schema_history;

lint-staged.config.js

@@ -33,4 +33,11 @@ module.exports = {
     // Lint Dockerfiles with Hadolint
     `hadolint ${filenames.join(' ')}`,
   ],
+
+  '**/*.{sql}': (filenames) => [
+    // Format files with Prettier
+    `prettier --write ${filenames.join(' ')}`,
+    // Lint files with SQLFluff
+    `poetry run sqlfluff lint ${filenames.join(' ')}`,
+  ],
 };

package.json

@@ -163,6 +163,7 @@
     "postcss-url": "^10.1.3",
     "prettier": "3.3.3",
     "prettier-plugin-java": "2.6.4",
+    "prettier-plugin-sql": "0.18.1",
     "prettier-plugin-tailwindcss": "0.6.8",
     "primeicons": "7.0.0",
     "primeng": "17.18.8",