chore: Review formatting and linting rules + add pre-commit hook

.git-blame-ignore-revs

@@ -3,3 +3,4 @@
 
 # Linting commits
 6efc953b9f7f648f2be59295a78ce1180f12b32d
+337cd93ac40295935a5bbf9268d820bddf9630e0

.github/workflows/lint.yml

@@ -13,6 +13,9 @@ on:
 jobs:
   lint:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
     env:
       THUMBNAIL_URL: ${{ vars.THUMBNAIL_URL }}
 
@@ -21,6 +24,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
 
       - name: Install bun
         uses: oven-sh/setup-bun@v2
@@ -30,21 +34,3 @@ jobs:
 
       - name: Run linter
         run: bun run lint
-
-      - name: Check for changes
-        id: verify-changed-files
-        run: |
-          if [ -n "$(git status --porcelain)" ]; then
-            echo "changed=true" >> $GITHUB_OUTPUT
-          else
-            echo "changed=false" >> $GITHUB_OUTPUT
-          fi
-
-      - name: Commit linter changes
-        if: steps.verify-changed-files.outputs.changed == 'true'
-        run: |
-          git config --local user.email "[email protected]"
-          git config --local user.name "GitHub Action"
-          git add .
-          git commit -m "🔧 Auto-fix: ESLint formatting and fixes"
-          git push

.github/workflows/tests.yml

@@ -22,9 +22,11 @@ jobs:
 
       - name: Install bun
         uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
 
       - name: Install dependencies
         run: bun install
 
       - name: Run tests
-        run: bun test
+        run: bun test

.husky/pre-commit

@@ -0,0 +1 @@
+bun run lint-staged

.prettierignore

@@ -0,0 +1,4 @@
+**/.next/*
+**/dist/*
+*.hbs
+node_modules/*

.prettierrc

@@ -2,7 +2,5 @@
   "tabWidth": 2,
   "trailingComma": "all",
   "singleQuote": true,
-  "jsxSingleQuote": true,
-  "cssEnable": ["css", "less", "sass", "scss"],
-  "jsonEnable": ["json", "jsonc"]
+  "jsxSingleQuote": true
 }

.vscode/settings.json

@@ -1,32 +1,17 @@
 {
-    "editor.formatOnSave": true,
-    "eslint.validate": [
-        "typescript"
-    ],
-    "eslint.run": "onType",
-    "eslint.format.enable": true,
-    "mdx.server.enable": true,
-    "editor.codeActionsOnSave": {
-        "source.fixAll": "explicit"
-    },
-    "workbench.colorCustomizations": {
-        "activityBar.activeBackground": "#fac977",
-        "activityBar.background": "#fac977",
-        "activityBar.foreground": "#15202b",
-        "activityBar.inactiveForeground": "#15202b99",
-        "activityBarBadge.background": "#069a62",
-        "activityBarBadge.foreground": "#e7e7e7",
-        "commandCenter.border": "#15202b99",
-        "sash.hoverBorder": "#fac977",
-        "statusBar.background": "#f8b646",
-        "statusBar.foreground": "#15202b",
-        "statusBarItem.hoverBackground": "#f6a315",
-        "statusBarItem.remoteBackground": "#f8b646",
-        "statusBarItem.remoteForeground": "#15202b",
-        "titleBar.activeBackground": "#f8b646",
-        "titleBar.activeForeground": "#15202b",
-        "titleBar.inactiveBackground": "#f8b64699",
-        "titleBar.inactiveForeground": "#15202b99"
-    },
-    "peacock.color": "#f8b646"
-}
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "eslint.validate": ["typescript", "javascript"],
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "eslint.run": "onType",
+  "eslint.useFlatConfig": true,
+  "eslint.format.enable": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  }
+}

NoteBlockWorld.code-workspace

@@ -1,74 +1,72 @@
 {
-    "folders": [
-        {
-            "path": ".",
-            "name": "Root"
-        },
-        {
-            "path": "./apps/backend",
-            "name": "Backend"
-        },
-        {
-            "path": "./apps/frontend",
-            "name": "Frontend"
-        },
-        {
-            "path": "./packages/configs",
-            "name": "configs"
-        },
-        {
-            "path": "./packages/database",
-            "name": "database"
-        },
-        {
-            "path": "./packages/song",
-            "name": "song"
-        },
-        {
-            "path": "./packages/sounds",
-            "name": "sounds"
-        },
-        {
-            "path": "./packages/thumbnail",
-            "name": "thumbnail"
-        },
-    ],
-    "settings": {
-        "window.title": "${dirty}${rootName}${separator}${profileName}${separator}${appName}",
-        "editor.formatOnSave": true,
-        "eslint.validate": [
-            "typescript"
-        ],
-        "eslint.run": "onType",
-        "eslint.format.enable": true,
-        "mdx.server.enable": true,
-        "editor.codeActionsOnSave": {
-            "source.fixAll": "explicit"
-        },
-        "search.exclude": {
-            "**/.git": true,
-            "**/node_modules": true,
-            "**/dist": true,
-        },
-        "workbench.colorCustomizations": {
-            "activityBar.activeBackground": "#fac977",
-            "activityBar.background": "#fac977",
-            "activityBar.foreground": "#15202b",
-            "activityBar.inactiveForeground": "#15202b99",
-            "activityBarBadge.background": "#069a62",
-            "activityBarBadge.foreground": "#e7e7e7",
-            "commandCenter.border": "#15202b99",
-            "sash.hoverBorder": "#fac977",
-            "statusBar.background": "#f8b646",
-            "statusBar.foreground": "#15202b",
-            "statusBarItem.hoverBackground": "#f6a315",
-            "statusBarItem.remoteBackground": "#f8b646",
-            "statusBarItem.remoteForeground": "#15202b",
-            "titleBar.activeBackground": "#f8b646",
-            "titleBar.activeForeground": "#15202b",
-            "titleBar.inactiveBackground": "#f8b64699",
-            "titleBar.inactiveForeground": "#15202b99"
-        },
-        "peacock.color": "#f8b646"
-    }
-}
+  "folders": [
+    {
+      "path": ".",
+      "name": "Root",
+    },
+    {
+      "path": "./apps/backend",
+      "name": "Backend",
+    },
+    {
+      "path": "./apps/frontend",
+      "name": "Frontend",
+    },
+    {
+      "path": "./packages/configs",
+      "name": "configs",
+    },
+    {
+      "path": "./packages/database",
+      "name": "database",
+    },
+    {
+      "path": "./packages/song",
+      "name": "song",
+    },
+    {
+      "path": "./packages/sounds",
+      "name": "sounds",
+    },
+    {
+      "path": "./packages/thumbnail",
+      "name": "thumbnail",
+    },
+  ],
+  "settings": {
+    "window.title": "${dirty}${rootName}${separator}${profileName}${separator}${appName}",
+    "editor.formatOnSave": true,
+    "eslint.validate": ["typescript"],
+    "eslint.run": "onType",
+    "eslint.format.enable": true,
+    "mdx.server.enable": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll": "explicit",
+    },
+    "search.exclude": {
+      "**/.git": true,
+      "**/node_modules": true,
+      "**/dist": true,
+    },
+    "workbench.colorCustomizations": {
+      "activityBar.activeBackground": "#fac977",
+      "activityBar.background": "#fac977",
+      "activityBar.foreground": "#15202b",
+      "activityBar.inactiveForeground": "#15202b99",
+      "activityBarBadge.background": "#069a62",
+      "activityBarBadge.foreground": "#e7e7e7",
+      "commandCenter.border": "#15202b99",
+      "sash.hoverBorder": "#fac977",
+      "statusBar.background": "#f8b646",
+      "statusBar.foreground": "#15202b",
+      "statusBarItem.hoverBackground": "#f6a315",
+      "statusBarItem.remoteBackground": "#f8b646",
+      "statusBarItem.remoteForeground": "#15202b",
+      "titleBar.activeBackground": "#f8b646",
+      "titleBar.activeForeground": "#15202b",
+      "titleBar.inactiveBackground": "#f8b64699",
+      "titleBar.inactiveForeground": "#15202b99",
+    },
+    "peacock.color": "#f8b646",
+  },
+}

apps/backend/nest-cli.json

@@ -1,21 +1,19 @@
 {
-    "$schema": "https://json.schemastore.org/nest-cli",
-    "collection": "@nestjs/schematics",
-    "sourceRoot": "src",
-    "entryFile": "server/src/main.js",
-    "compilerOptions": {
-        "deleteOutDir": true,
-        "plugins": [
-            "@nestjs/swagger/plugin"
-        ],
-        "assets": [
-            {
-                "include": "mailing/templates/**/*.{hbs,png}",
-                "outDir": "dist/server/src/",
-                "exclude": "dist/**/*"
-            },
-            "**/assets/**/*"
-        ],
-        "watchAssets": true
-    }
-}
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "entryFile": "server/src/main.js",
+  "compilerOptions": {
+    "deleteOutDir": true,
+    "plugins": ["@nestjs/swagger/plugin"],
+    "assets": [
+      {
+        "include": "mailing/templates/**/*.{hbs,png}",
+        "outDir": "dist/server/src/",
+        "exclude": "dist/**/*"
+      },
+      "**/assets/**/*"
+    ],
+    "watchAssets": true
+  }
+}

apps/backend/src/app.module.ts

@@ -21,7 +21,7 @@ import { UserModule } from './user/user.module';
   imports: [
     ConfigModule.forRoot({
       isGlobal: true,
-      envFilePath: ['.env.development', '.env.production'],
+      envFilePath: ['.env.test', '.env.development', '.env.production'],
       validate,
     }),
     //DatabaseModule,

apps/backend/src/auth/auth.service.ts

@@ -1,10 +1,10 @@
-import type { UserDocument } from '@nbw/database';
-import { CreateUser } from '@nbw/database';
 import { Inject, Injectable, Logger } from '@nestjs/common';
 import { JwtService } from '@nestjs/jwt';
 import axios from 'axios';
 import type { Request, Response } from 'express';
 
+import { CreateUser } from '@nbw/database';
+import type { UserDocument } from '@nbw/database';
 import { UserService } from '@server/user/user.service';
 
 import { DiscordUser } from './types/discordProfile';

apps/backend/src/file/file.service.spec.ts

@@ -5,13 +5,14 @@ import { beforeEach, describe, expect, it, jest, mock } from 'bun:test';
 
 import { FileService } from './file.service';
 
-mock.module('@aws-sdk/client-s3', () => {
-  const mS3Client = {
-    send: jest.fn(),
-  };
+// Create a mock S3Client instance
+const mockS3Client = {
+  send: jest.fn(),
+};
 
+mock.module('@aws-sdk/client-s3', () => {
   return {
-    S3Client: jest.fn(() => mS3Client),
+    S3Client: jest.fn(() => mockS3Client),
     GetObjectCommand: jest.fn(),
     PutObjectCommand: jest.fn(),
     HeadBucketCommand: jest.fn(),
@@ -31,6 +32,10 @@ describe('FileService', () => {
   let s3Client: S3Client;
 
   beforeEach(async () => {
+    // Reset the mock before each test
+    mockS3Client.send.mockClear();
+    mockS3Client.send.mockResolvedValue({});
+
     const module: TestingModule = await Test.createTestingModule({
       providers: [
         FileService,
@@ -62,8 +67,7 @@ describe('FileService', () => {
     }).compile();
 
     fileService = module.get<FileService>(FileService);
-
-    s3Client = new S3Client({});
+    s3Client = mockS3Client as any;
   });
 
   it('should be defined', () => {
@@ -72,13 +76,15 @@ describe('FileService', () => {
 
   describe('verifyBucket', () => {
     it('should verify the buckets successfully', async () => {
+      // The constructor already called verifyBucket, so we expect 2 calls from constructor
+      // When we call verifyBucket again, we expect 2 more calls (total 4)
       (s3Client.send as jest.Mock)
         .mockResolvedValueOnce({}) // Mock for the first bucket
         .mockResolvedValueOnce({}); // Mock for the second bucket
 
       await fileService['verifyBucket']();
 
-      // Ensure the mock was called twice
+      // Ensure the mock was called 4 times total (2 from constructor + 2 from explicit call)
       expect(s3Client.send).toHaveBeenCalledTimes(4);
     });