feat(ci): add style check step and integrate Prettier for code formatting

Author: muhammadqzaih

.github/workflows/ci.yml

@@ -22,4 +22,22 @@ jobs:
         run: npm ci
 
       - name: Run Tests with Coverage
-        run: npm run test -- --coverage
+        run: npm run test -- --coverage
+  style:
+    name: Style
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Check Formatting
+        run: npm run format:check

README.md

@@ -6,13 +6,13 @@ MuhammadQzih's version of Boot.dev's Notely app
 This repo contains the typescript starter code for the "Notely" application for the "Learn CICD" course on [Boot.dev](https://boot.dev).
 
 ## Local Development
+
 Create a `.env` file in the root of the project with the following contents:
 
 ```bash
 PORT="8080"
 ```
 
-
 Run the server:
 
 ```bash

package-lock.json

@@ -10,7 +10,8 @@
     "build": "npx tsc",
     "start": "node dist/main.js",
     "dev": "npx tsc && node dist/main.js",
-    "test": "vitest --run"
+    "test": "vitest --run",
+    "format:check": "prettier --check ."
   },
   "devDependencies": {
     "@types/cors": "^2.8.17",
@@ -19,6 +20,7 @@
     "@vitest/coverage-v8": "^4.0.18",
     "drizzle-kit": "^0.28.1",
     "globals": "^15.12.0",
+    "prettier": "3.8.1",
     "tsx": "^4.19.2",
     "typescript": "^5.6.3",
     "vitest": "^4.0.18"

package.json

@@ -17,4 +17,4 @@ describe("getAPIKey", () => {
 
     expect(() => getAPIKey(headers)).toThrow();
   });
-});
+});