Merge pull request #540 from ixartz/Oxlint

feat: use Oxlint instead ESLint and use Ultracite preset

Author: ixartz

.coderabbit.yaml

@@ -13,8 +13,7 @@ reviews:
   collapse_walkthrough: false
   path_instructions:
     - path: '**/*.{ts,tsx}'
-      instructions:
-        'Review the Typescript and React code for conformity with best practices in React, and Typescript. Highlight any deviations.'
+      instructions: 'Review the Typescript and React code for conformity with best practices in React, and Typescript. Highlight any deviations.'
   auto_review:
     enabled: true
     ignore_title_keywords:

.env

@@ -14,7 +14,7 @@ NEXT_PUBLIC_POSTHOG_HOST=https://us.i.posthog.com
 
 # Database
 # Local database with PGLite, already included in the project, no Docker needed
-# Need a database for production? Check out https://www.prisma.io/?via=nextjsboilerplate
+# Need a database for production? Check out https://get.neon.com/BMFYNtx
 # Tested and compatible with Next.js Boilerplate
 DATABASE_URL=postgresql://postgres:postgres@127.0.0.1:5432/postgres
 

.env.production

@@ -32,7 +32,7 @@ NEXT_PUBLIC_LOGGING_LEVEL=info
 
 # Database
 # Using an incorrect DATABASE_URL value, Next.js build will timeout and you will get the following error: "because it took more than 60 seconds"
-# Need a database for production? Check out https://www.prisma.io/?via=nextjsboilerplate
+# Need a database for production? Check out https://get.neon.com/BMFYNtx
 # Tested and compatible with Next.js Boilerplate
 # DATABASE_URL=postgresql://postgres@localhost:5432/postgres
 

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

@@ -37,5 +37,6 @@ runs:
       with:
         path: |
           .next
+          next-env.d.ts
         key: nextjs-build-${{ inputs.node-version }}-${{ github.sha }}
         fail-on-cache-miss: true

.github/workflows/CI.yml

@@ -39,58 +39,48 @@ jobs:
           NEXT_PUBLIC_SENTRY_DISABLED: 'true' # Only upload Sentry source maps in deployment
           NEXT_PUBLIC_APP_URL: http://localhost:3008
 
-      - if: matrix.node-version == '22.x' && success()
+      - if: matrix.node-version == '24.x' && success()
         name: Cache Next.js build output
         uses: actions/cache/save@v5
         with:
           path: |
             .next
+            next-env.d.ts
           key: nextjs-build-${{ matrix.node-version }}-${{ github.sha }}
 
-  static:
+  unit:
     strategy:
       matrix:
-        node-version: [22.x]
+        node-version: [24.x]
 
-    name: Run static checks
+    name: Run unit tests
     runs-on: ubuntu-latest
     timeout-minutes: 10
 
     steps:
       - uses: actions/checkout@v6
-        with:
-          fetch-depth: 0 # Retrieve Git history, needed to verify commits
 
       - name: Set up Node.js environment
         uses: ./.github/actions/setup-project
         with:
           node-version: ${{ matrix.node-version }}
 
-      - if: github.event_name == 'pull_request'
-        name: Validate all commits from PR
-        run: npx commitlint --from $BASE_SHA --to $HEAD_SHA --verbose
-        env:
-          BASE_SHA: ${{ github.event.pull_request.base.sha }}
-          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
-
-      - name: Linter
-        run: npm run lint
-
-      - name: Type checking
-        run: npm run check:types
-
-      - name: Check dependencies
-        run: npm run check:deps
+      - name: Run unit tests
+        uses: docker://mcr.microsoft.com/playwright:v1.58.2
+        with:
+          args: npm run test -- --coverage
 
-      - name: I18n check
-        run: npm run check:i18n
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
-  unit:
+  storybook:
     strategy:
       matrix:
-        node-version: [22.x]
+        node-version: [24.x]
 
-    name: Run unit tests
+    name: Run Storybook
     runs-on: ubuntu-latest
     timeout-minutes: 10
 
@@ -102,42 +92,52 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
-      - name: Run unit tests
+      - name: Run storybook tests
         uses: docker://mcr.microsoft.com/playwright:v1.58.2
         with:
-          args: npm run test -- --coverage
-
-      - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v5
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+          args: npm run storybook:test
 
-  storybook:
+  static:
     strategy:
       matrix:
-        node-version: [22.x]
+        node-version: [24.x]
 
-    name: Run Storybook
+    name: Run static checks
     runs-on: ubuntu-latest
     timeout-minutes: 10
+    needs: [build]
 
     steps:
       - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0 # Retrieve Git history, needed to verify commits
 
       - name: Set up Node.js environment
         uses: ./.github/actions/setup-project
         with:
           node-version: ${{ matrix.node-version }}
+          restore-nextjs-cache: true
 
-      - name: Run storybook tests
-        uses: docker://mcr.microsoft.com/playwright:v1.58.2
-        with:
-          args: npm run storybook:test
+      - if: github.event_name == 'pull_request'
+        name: Validate all commits from PR
+        run: npx commitlint --from $BASE_SHA --to $HEAD_SHA --verbose
+        env:
+          BASE_SHA: ${{ github.event.pull_request.base.sha }}
+          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
+
+      - name: Linter
+        run: npm run lint
+
+      - name: Check dependencies
+        run: npm run check:deps
+
+      - name: I18n check
+        run: npm run check:i18n
 
   e2e:
     strategy:
       matrix:
-        node-version: [22.x]
+        node-version: [24.x]
 
     name: Run E2E tests
     runs-on: ubuntu-latest

.github/workflows/checkly.yml

@@ -11,7 +11,7 @@ jobs:
   test-e2e:
     strategy:
       matrix:
-        node-version: [22.x]
+        node-version: [24.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     # Only run when the deployment was successful

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
   release:
     strategy:
       matrix:
-        node-version: [22.x]
+        node-version: [24.x]
 
     name: Create a new release
     runs-on: ubuntu-latest

.oxfmtrc.jsonc

@@ -0,0 +1,36 @@
+// Ultracite oxfmt Configuration
+// https://oxc.rs/docs/guide/usage/formatter/config-file-reference.html
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "arrowParens": "always",
+  "bracketSameLine": false,
+  "bracketSpacing": true,
+  "endOfLine": "lf",
+  "experimentalSortImports": {
+    "ignoreCase": true,
+    "newlinesBetween": false,
+    "order": "asc"
+  },
+  "experimentalSortPackageJson": true,
+  "jsxSingleQuote": false,
+  "printWidth": 80,
+  "quoteProps": "as-needed",
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "useTabs": false,
+  "ignorePatterns": ["migrations/*", "*.md"],
+  "sortTailwindcss": {
+    "stylesheet": "src/styles/global.css"
+  },
+  // Keep JSON/JSONC output consistent between the CLI and VS Code, more info at https://github.com/oxc-project/oxc-vscode/issues/140
+  "overrides": [
+    {
+      "files": ["**/*.json", "**/*.jsonc"],
+      "options": {
+        "trailingComma": "none"
+      }
+    }
+  ]
+}

.oxlintrc.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "extends": [
+    "./node_modules/ultracite/config/oxlint/core/.oxlintrc.json",
+    "./node_modules/ultracite/config/oxlint/next/.oxlintrc.json",
+    "./node_modules/ultracite/config/oxlint/react/.oxlintrc.json"
+  ],
+  "rules": {
+    "no-warning-comments": "off", // Allow TODO and FIXME comments
+    "no-inline-comments": "off",
+
+    "sort-keys": "off",
+    "func-style": "off",
+
+    "typescript/no-unsafe-assignment": "off",
+    "typescript/no-unsafe-member-access": "off",
+    "typescript/no-unsafe-call": "off",
+    "typescript/strict-boolean-expressions": "off",
+    "typescript/consistent-type-definitions": ["error", "type"], // Use `type` instead of `interface`
+    "typescript/no-misused-promises": "off", // React Hook Form's handleSubmit returns a Promise-typed handler
+
+    "react-perf/jsx-no-new-function-as-prop": "off",
+
+    "unicorn/filename-case": "off", // Impossible to enforce consistent filename case due to multiple conventions
+
+    // --- JSDoc Rules ---
+    "jsdoc/require-param": "error",
+    "jsdoc/require-param-description": "error",
+    "jsdoc/require-returns": "error",
+    "jsdoc/require-returns-description": "error"
+  },
+  "options": {
+    "reportUnusedDisableDirectives": "error"
+  }
+}

.storybook/main.ts

@@ -1,21 +1,13 @@
 import type { StorybookConfig } from '@storybook/nextjs-vite';
 
 const config: StorybookConfig = {
-  stories: [
-    '../src/**/*.mdx',
-    '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)',
-  ],
-  addons: [
-    '@storybook/addon-docs',
-    '@storybook/addon-a11y',
-  ],
+  stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
+  addons: ['@storybook/addon-docs', '@storybook/addon-a11y'],
   framework: {
     name: '@storybook/nextjs-vite',
     options: {},
   },
-  staticDirs: [
-    '../public',
-  ],
+  staticDirs: ['../public'],
   features: {
     experimentalRSC: true,
   },