Add prettier and eslint to project

.github/workflows/deploy.yml

@@ -2,7 +2,7 @@ name: Deploy
 
 on:
   workflow_run:
-    workflows: ["Create and publish a Docker image"]
+    workflows: ['Create and publish a Docker image']
     branches: [main]
     types:
       - completed
@@ -12,19 +12,19 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
-    - name: Setup SSH key
-      shell: bash
-      env:
-        SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
-      run: |
-        mkdir -p ~/.ssh
-        echo "${SSH_PRIVATE_KEY}" | base64 -d > ${HOME}/.ssh/deploy.id_rsa
-        chmod 700 ${HOME}/.ssh/deploy.id_rsa
-    - name: Update Docker container
-      shell: bash
-      run: |
-        ssh -i ${HOME}/.ssh/deploy.id_rsa -o StrictHostKeyChecking=no root@saturn.munichmakerlab.de << EOF
-          docker pull ghcr.io/munichmakerlab/website:main
-          systemctl restart docker-website.service
-          systemctl status docker-website.service
-        EOF
+      - name: Setup SSH key
+        shell: bash
+        env:
+          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
+        run: |
+          mkdir -p ~/.ssh
+          echo "${SSH_PRIVATE_KEY}" | base64 -d > ${HOME}/.ssh/deploy.id_rsa
+          chmod 700 ${HOME}/.ssh/deploy.id_rsa
+      - name: Update Docker container
+        shell: bash
+        run: |
+          ssh -i ${HOME}/.ssh/deploy.id_rsa -o StrictHostKeyChecking=no root@saturn.munichmakerlab.de << EOF
+            docker pull ghcr.io/munichmakerlab/website:main
+            systemctl restart docker-website.service
+            systemctl status docker-website.service
+          EOF

.github/workflows/docker-build-push.yml

@@ -55,4 +55,4 @@ jobs:
         with:
           subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
           subject-digest: ${{ steps.push.outputs.digest }}
-          push-to-registry: true
+          push-to-registry: true

.github/workflows/lint-pr.yml

@@ -0,0 +1,27 @@
+name: Lint & Format Check for Pull Requests
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run ESLint
+        run: npm run lint
+
+      - name: Check formatting with Prettier
+        run: npm run format:check

.prettierrc

@@ -0,0 +1,13 @@
+{
+  "printWidth": 120,
+  "singleQuote": true,
+  "plugins": ["prettier-plugin-astro"],
+  "overrides": [
+    {
+      "files": "*.astro",
+      "options": {
+        "parser": "astro"
+      }
+    }
+  ]
+}

README.md

@@ -33,6 +33,8 @@ All commands are run from the root of the project, from a terminal:
 | `npm run preview`         | Preview your build locally, before deploying     |
 | `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
 | `npm run astro -- --help` | Get help using the Astro CLI                     |
+| `npm run lint`            | Lint the project with ESLint                     |
+| `npm run format:check`    | Check Code Styling with Prettier                 |
 
 ## 👀 Want to learn more?
 

astro.config.mjs

@@ -16,6 +16,6 @@ export default defineConfig({
   integrations: [markdoc(), mdx(), icon(), vue()],
   output: 'static',
   adapter: node({
-    mode: 'standalone'
-  })
-});
+    mode: 'standalone',
+  }),
+});

eslint.config.mjs

@@ -0,0 +1,18 @@
+import js from '@eslint/js';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+import pluginVue from 'eslint-plugin-vue';
+import eslintPluginAstro from 'eslint-plugin-astro';
+import eslintConfigPrettier from 'eslint-config-prettier/flat';
+
+export default [
+  { ignores: ['.astro/', 'dist/'] },
+  { files: ['**/*.{js,mjs,cjs,ts,mts,cts,vue}'], languageOptions: { globals: globals.browser } },
+  js.configs.recommended,
+  ...tseslint.configs.recommended,
+  ...pluginVue.configs['flat/essential'],
+  { files: ['**/*.vue'], languageOptions: { parserOptions: { parser: tseslint.parser } } },
+  { rules: { 'vue/multi-word-component-names': 'off' } },
+  ...eslintPluginAstro.configs.recommended,
+  eslintConfigPrettier,
+];

markdoc.config.json

@@ -1,12 +1,12 @@
 [
-    {
-      "id": "website",
-      "path": "src/content",
-      "schema": {
-        "path": "markdoc.config.mjs",
-        "type": "esm",
-        "property": "default",
-        "watch": true
-      }
+  {
+    "id": "website",
+    "path": "src/content",
+    "schema": {
+      "path": "markdoc.config.mjs",
+      "type": "esm",
+      "property": "default",
+      "watch": true
     }
-  ]
+  }
+]