chore: enforce code formatting with Prettier

.github/workflows/prettier.yml

@@ -0,0 +1,41 @@
+name: Prettier Check
+
+on:
+  pull_request:
+    paths:
+      - "extension/**"
+      - "eduaid_web/**"
+      - "eduaid_desktop/**"
+      - ".prettierrc"
+      - ".prettierignore"
+
+jobs:
+  prettier:
+    name: Check Formatting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Check extension formatting
+        run: |
+          cd extension
+          npm ci || npm install --legacy-peer-deps
+          npm run format:check
+
+      - name: Check eduaid_web formatting
+        run: |
+          cd eduaid_web
+          npm ci || npm install --legacy-peer-deps
+          npm run format:check
+
+      - name: Check eduaid_desktop formatting
+        run: |
+          cd eduaid_desktop
+          npm ci || npm install --legacy-peer-deps
+          npm run format:check

.prettierignore

@@ -0,0 +1,12 @@
+node_modules/
+dist/
+build/
+*.min.js
+*.min.css
+LICENSE.md
+package-lock.json
+backend/
+Model_experimentation/
+Model_training/
+Testing/
+readme-assets/

.prettierrc

@@ -0,0 +1,12 @@
+{
+  "semi": true,
+  "singleQuote": false,
+  "jsxSingleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 80,
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}

eduaid_desktop/package.json

@@ -13,7 +13,9 @@
     "build:electron": "npm run build && electron-builder",
     "build:all": "npm run build && electron-builder --mac --win --linux",
     "pack": "electron-builder --dir",
-    "dist": "npm run build:web && npm run copy:web && electron-builder"
+    "dist": "npm run build:web && npm run copy:web && electron-builder",
+    "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,css,md}\"",
+    "format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,css,md}\""
   },
   "keywords": [
     "eduaid",
@@ -28,6 +30,7 @@
     "concurrently": "^8.2.2",
     "electron": "^27.0.0",
     "electron-builder": "^24.6.4",
+    "prettier": "3.8.1",
     "wait-on": "^7.2.0"
   },
   "build": {

eduaid_web/package.json

@@ -21,7 +21,9 @@
     "start": "react-scripts start",
     "build": "react-scripts build",
     "test": "react-scripts test",
-    "eject": "react-scripts eject"
+    "eject": "react-scripts eject",
+    "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,css,md}\"",
+    "format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,css,md}\""
   },
   "eslintConfig": {
     "extends": [
@@ -42,6 +44,7 @@
     ]
   },
   "devDependencies": {
+    "prettier": "3.8.1",
     "tailwindcss": "^3.4.9"
   }
 }

extension/package.json

@@ -6,7 +6,9 @@
   "scripts": {
     "dev": "vite",
     "build": "vite build",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,css,md,html}\"",
+    "format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,css,md,html}\""
   },
   "dependencies": {
     "pdf-lib": "^1.17.1",
@@ -23,6 +25,7 @@
     "@vitejs/plugin-react": "^3.1.0",
     "autoprefixer": "^10.4.14",
     "postcss": "^8.4.21",
+    "prettier": "3.8.1",
     "tailwindcss": "^3.3.1",
     "vite": "^4.2.0"
   }

package.json

@@ -0,0 +1,12 @@
+{
+  "name": "eduaid-root",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "format": "prettier --write .",
+    "check-format": "prettier --check ."
+  },
+  "devDependencies": {
+    "prettier": "3.8.1"
+  }
+}