Use devcontainer (#21)

* Add development container configuration and update Dockerfile for permissions

* Add Python and sqlfluff for SQL linting in development container

* Update super-linter configuration to use latest version and exclude specific files from validation

* Add RunOnSave extension and configure SQLFluff auto-fix on save

* Update super-linter workflow to trigger on pushes to the main branch

Author: Vianpyro

.devcontainer/Dockerfile

@@ -0,0 +1,20 @@
+FROM alpine:latest
+
+# Install common tools
+RUN apk add --no-cache bash git \
+    mariadb mariadb-client \
+    python3 py3-pip
+
+# Install sqlfluff for SQL linting
+RUN ["/bin/bash", "-c", "pip3 --disable-pip-version-check --no-cache-dir install sqlfluff --break-system-packages"]
+
+# Setup default user
+ARG USERNAME=vscode
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+
+RUN addgroup -g $USER_GID -S $USERNAME && \
+    adduser -u $USER_UID -S -G $USERNAME -s /bin/bash $USERNAME
+
+# Switch to the default user
+USER $USERNAME

.devcontainer/devcontainer.json

@@ -0,0 +1,18 @@
+{
+    "name": "Smart Cooking Database Development Container",
+    "dockerFile": "Dockerfile",
+    "customizations": {
+        "settings": {
+            "terminal.integrated.shell.linux": "/bin/bash"
+        },
+        "vscode": {
+            "extensions": [
+                "mtxr.sqltools-driver-mysql",
+                "dorzey.vscode-sqlfluff",
+                "emeraldwalk.RunOnSave"
+            ]
+        }
+    },
+    "postStartCommand": "sqlfluff fix",
+    "remoteUser": "vscode"
+}

.gitattributes

@@ -1,2 +1,3 @@
+* text=auto
 *.sql linguist-language=sql
 *.sql linguist-detectable=true

.github/workflows/super-linter.yml

@@ -2,7 +2,9 @@
 name: Lint
 
 on:
-  push: null
+  push:
+    branches:
+      - main
   pull_request: null
 
 permissions: {}
@@ -15,22 +17,19 @@ jobs:
     permissions:
       contents: read
       packages: read
-      # To report GitHub Actions status checks
       statuses: write
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          # super-linter needs the full git history to get the
-          # list of files that changed across commits
           fetch-depth: 0
 
       - name: Super-linter
-        uses: super-linter/super-linter@v7.2.1
+        uses: super-linter/super-linter@v7
         env:
-          # To report GitHub Actions status checks
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VALIDATE_ALL_CODEBASE: false
           VALIDATE_JSON_PRETTIER: false
           SQLFLUFF_CONFIG_FILE: .sqlfluff
+          FILTER_REGEX_EXCLUDE: "(.devcontainer/Dockerfile|.github/pull_request_template.md|.github/ISSUE_TEMPLATE/*.md)"

.vscode/settings.json

@@ -7,5 +7,13 @@
     "editor.formatOnSave": true,
     "files.insertFinalNewline": true,
     "files.trimFinalNewlines": true,
-    "files.trimTrailingWhitespace": true
+    "files.trimTrailingWhitespace": true,
+    "emeraldwalk.runonsave": {
+        "commands": [
+            {
+                "match": "*.sql",
+                "cmd": "sqlfluff fix '${fileBasename}'"
+            }
+        ]
+    }
 }

Dockerfile

@@ -20,11 +20,9 @@ RUN find "${TEMP_SQL_DIR:?}/" -type f -name "*.sql" | while read -r file; do \
     done && \
     rm -rf "${TEMP_SQL_DIR:?}/"
 
-# Set ownership
-RUN chown -R dbuser:dbuser /docker-entrypoint-initdb.d
-
-# Adjust permissions on the MySQL data directory
-RUN chown -R dbuser:dbuser /var/lib/mysql /etc/mysql
+# Set ownership and adjust permissions on the MySQL data directory
+RUN chown -R dbuser:dbuser /docker-entrypoint-initdb.d && \
+    chown -R dbuser:dbuser /var/lib/mysql /etc/mysql
 
 # Expose the default MariaDB port (3306)
 EXPOSE 3306