Merge pull request #416 from ixartz/unlighthouse

feat: add unlighthouse in CI

Author: ixartz

.github/actions/setup-project/action.yml

@@ -5,6 +5,10 @@ inputs:
   node-version:
     description: Node.js version
     required: true
+  restore-nextjs-cache:
+    description: Whether to restore Next.js build cache
+    required: false
+    default: 'false'
 
 runs:
   using: composite
@@ -26,3 +30,12 @@ runs:
       if: steps.cache-node-modules.outputs.cache-hit != 'true'
       shell: bash
       run: npm ci
+
+    - name: Restore Next.js build output
+      if: inputs.restore-nextjs-cache == 'true'
+      uses: actions/cache/restore@v4
+      with:
+        path: |
+          .next
+        key: nextjs-build-${{ inputs.node-version }}-${{ github.sha }}
+        fail-on-cache-miss: true

.github/workflows/CI.yml

@@ -96,14 +96,6 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
-      - name: Restore Next.js build output
-        uses: actions/cache/restore@v4
-        with:
-          path: |
-            .next
-          key: nextjs-build-${{ matrix.node-version }}-${{ github.sha }}
-          fail-on-cache-miss: true
-
       - name: Run unit tests
         uses: docker://mcr.microsoft.com/playwright:v1.53.1
         with:
@@ -131,14 +123,6 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
-      - name: Restore Next.js build output
-        uses: actions/cache/restore@v4
-        with:
-          path: |
-            .next
-          key: nextjs-build-${{ matrix.node-version }}-${{ github.sha }}
-          fail-on-cache-miss: true
-
       - name: Run storybook tests
         uses: docker://mcr.microsoft.com/playwright:v1.53.1
         with:
@@ -162,14 +146,7 @@ jobs:
         uses: ./.github/actions/setup-project
         with:
           node-version: ${{ matrix.node-version }}
-
-      - name: Restore Next.js build output
-        uses: actions/cache/restore@v4
-        with:
-          path: |
-            .next
-          key: nextjs-build-${{ matrix.node-version }}-${{ github.sha }}
-          fail-on-cache-miss: true
+          restore-nextjs-cache: true
 
       - name: Run E2E tests
         uses: docker://mcr.microsoft.com/playwright:v1.53.1
@@ -198,6 +175,28 @@ jobs:
           path: test-results/
           retention-days: 7
 
+  lighthouse:
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    name: Run unlighthouse
+    runs-on: ubuntu-latest
+    needs: [build]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node.js environment
+        uses: ./.github/actions/setup-project
+        with:
+          node-version: ${{ matrix.node-version }}
+          restore-nextjs-cache: true
+
+      - name: Run unlighthouse
+        run: |
+          npm run test:lighthouse
+
   synchronize-with-crowdin:
     name: GitHub PR synchronize with Crowdin
     runs-on: ubuntu-latest

.gitignore

@@ -13,6 +13,7 @@
 # testing
 /coverage
 /vitest-test-results
+.unlighthouse
 
 # next.js
 /.next/

README.md

@@ -145,7 +145,8 @@ Developer experience first, extremely flexible code structure and only keep what
 - 👤 Passwordless Authentication with Magic Links, Multi-Factor Auth (MFA), Social Auth (Google, Facebook, Twitter, GitHub, Apple, and more), Passwordless login with Passkeys, User Impersonation
 - 📦 Type-safe ORM with DrizzleORM, compatible with PostgreSQL, SQLite, and MySQL
 - 💽 Offline and local development database with PGlite
-- 🌐 Multi-language (i18n) with [next-intl](https://next-intl-docs.vercel.app/) and [Crowdin](https://l.crowdin.com/next-js)
+- ☁️ Remote and production database with [Prisma Postgres](https://www.prisma.io/?via=nextjs-boilerplate)
+- 🌐 Multi-language (i18n) with next-intl and [Crowdin](https://l.crowdin.com/next-js)
 - ♻️ Type-safe environment variables with T3 Env
 - ⌨️ Form handling with React Hook Form
 - 🔴 Validation library with Zod
@@ -177,9 +178,9 @@ Developer experience first, extremely flexible code structure and only keep what
 - 🗺️ Sitemap.xml and robots.txt
 - 👷 Automatic dependency updates with Dependabot
 - ⌘ Database exploration with Drizzle Studio and CLI migration tool with Drizzle Kit
-- ⚙️ [Bundler Analyzer](https://www.npmjs.com/package/@next/bundle-analyzer)
+- ⚙️ Bundler Analyzer
 - 🌈 Include a FREE minimalist theme
-- 💯 Maximize lighthouse score
+- 💯 Maximize lighthouse score with Unlighthouse
 
 Built-in feature from Next.js:
 

knip.config.ts

@@ -3,6 +3,7 @@ import type { KnipConfig } from 'knip';
 const config: KnipConfig = {
   ignore: [
     'checkly.config.ts',
+    'unlighthouse.config.ts',
     'src/libs/I18n.ts',
     'src/types/I18n.ts',
     'tests/**/*.ts',