Nextra 3 x Pages Router

.eslintrc.cjs

@@ -13,7 +13,7 @@ const TAILWIND_CONFIG = {
 module.exports = {
   root: true,
   reportUnusedDisableDirectives: true,
-  ignorePatterns: ['next-env.d.ts'],
+  ignorePatterns: ['next-env.d.ts', 'generated-page-map.js'],
   overrides: [
     // Rules for all files
     {
@@ -24,8 +24,12 @@ module.exports = {
         'plugin:import/typescript',
         'prettier'
       ],
-      plugins: ['import', 'unicorn'],
+      plugins: ['import', 'unicorn', 'sonarjs'],
       rules: {
+        'no-extra-boolean-cast': [
+          'error',
+          { enforceForInnerExpressions: true }
+        ],
         'prefer-object-has-own': 'error',
         'logical-assignment-operators': [
           'error',
@@ -47,6 +51,24 @@ module.exports = {
         'unicorn/no-array-for-each': 'error',
         'unicorn/prefer-string-replace-all': 'error',
         '@typescript-eslint/prefer-for-of': 'error',
+        quotes: ['error', 'single', { avoidEscape: true }], // Matches Prettier, but also replaces backticks
+        '@typescript-eslint/no-unused-vars': [
+          'error',
+          {
+            argsIgnorePattern: '^_',
+            varsIgnorePattern: '^_' // allow underscores in destructuring
+          }
+        ],
+        'prefer-object-spread': 'error',
+        'prefer-arrow-callback': ['error', { allowNamedFunctions: true }],
+        'unicorn/prefer-at': 'error',
+        'sonarjs/no-small-switch': 'error',
+        'prefer-const': ['error', { destructuring: 'all' }],
+        'unicorn/prefer-array-index-of': 'error',
+        'sonarjs/no-unused-collection': 'error',
+        'unicorn/catch-error-name': 'error',
+        'unicorn/prefer-optional-catch-binding': 'error',
+        'unicorn/filename-case': 'error',
         // todo: enable
         '@typescript-eslint/no-explicit-any': 'off',
         '@typescript-eslint/no-non-null-assertion': 'off',
@@ -60,8 +82,8 @@ module.exports = {
       extends: [
         'plugin:react/recommended',
         'plugin:react/jsx-runtime',
-        'plugin:react-hooks/recommended',
-        'plugin:@next/next/recommended'
+        'plugin:react-hooks/recommended'
+        // 'plugin:@next/next/recommended'
       ],
       rules: {
         'react/prop-types': 'off',
@@ -99,15 +121,12 @@ module.exports = {
     {
       files: '**/*.{ts,tsx,cts,mts}',
       extends: [
+        'plugin:deprecation/recommended'
         // TODO: fix errors
         // 'plugin:@typescript-eslint/recommended-requiring-type-checking'
       ],
       parserOptions: {
-        project: [
-          'packages/*/tsconfig.json',
-          'docs/tsconfig.json',
-          'tsconfig.eslint.json'
-        ]
+        projectService: true
       },
       rules: {
         '@typescript-eslint/no-unnecessary-type-assertion': 'error',
@@ -123,7 +142,7 @@ module.exports = {
       plugins: ['typescript-sort-keys'],
       settings: {
         tailwindcss: {
-          config: 'packages/nextra-theme-docs/tailwind.config.js',
+          config: 'packages/nextra-theme-docs/tailwind.config.ts',
           callees: ['cn'],
           whitelist: [
             'nextra-breadcrumb',
@@ -150,8 +169,8 @@ module.exports = {
       files: 'packages/nextra-theme-blog/**',
       settings: {
         tailwindcss: {
-          config: 'packages/nextra-theme-blog/tailwind.config.js',
-          whitelist: ['subheading-', 'post-item', 'post-item-more']
+          config: 'packages/nextra-theme-blog/tailwind.config.ts',
+          whitelist: ['subheading-']
         }
       }
     },
@@ -161,10 +180,14 @@ module.exports = {
       files: 'packages/nextra/**',
       settings: {
         tailwindcss: {
-          config: 'packages/nextra-theme-docs/tailwind.config.js',
+          config: 'packages/nextra-theme-docs/tailwind.config.ts',
           callees: ['cn'],
-          whitelist: ['nextra-code-block', 'nextra-filetree']
+          whitelist: ['nextra-code', 'nextra-filetree']
         }
+      },
+      rules: {
+        ...TAILWIND_CONFIG.rules,
+        'import/extensions': ['error', 'ignorePackages']
       }
     },
     // ⚙️ Docs
@@ -173,9 +196,20 @@ module.exports = {
       files: 'docs/**',
       settings: {
         tailwindcss: {
-          config: 'docs/tailwind.config.js',
+          config: 'docs/tailwind.config.ts',
           callees: ['cn'],
-          whitelist: ['dash-ring', 'theme-1', 'theme-2', 'theme-3', 'theme-4']
+          whitelist: [
+            'dash-ring',
+            'theme-1',
+            'theme-2',
+            'theme-3',
+            'theme-4',
+            'subtitle',
+            'headline',
+            'content-container',
+            'feat-darkmode',
+            'features-container'
+          ]
         },
         next: { rootDir: 'docs' }
       }
@@ -186,7 +220,11 @@ module.exports = {
       files: 'examples/swr-site/**',
       settings: {
         tailwindcss: {
-          config: 'examples/swr-site/tailwind.config.js'
+          config: 'examples/swr-site/tailwind.config.ts',
+          cssFiles: [
+            'examples/swr-site/styles.css',
+            'packages/nextra-theme-docs/dist/style.css'
+          ]
         },
         next: { rootDir: 'examples/swr-site' }
       }
@@ -208,8 +246,7 @@ module.exports = {
     {
       files: [
         'prettier.config.js',
-        'postcss.config.js',
-        'tailwind.config.js',
+        'postcss.config.{js,cjs}',
         'next.config.js',
         '.eslintrc.cjs'
       ],

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+---
+
+**Describe the bug** A clear and concise description of what the bug is.
+
+**To Reproduce** Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior** A clear and concise description of what you expected to
+happen.
+
+**Screenshots** If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+**Additional context** Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+**Is your feature request related to a problem? Please describe.** A clear and
+concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like** A clear and concise description of what you
+want to happen.
+
+**Describe alternatives you've considered** A clear and concise description of
+any alternative solutions or features you've considered.
+
+**Additional context** Add any other context or screenshots about the feature
+request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,27 @@
+<!--
+Thank you for contributing to this project! You must fill out the information below before we can review this pull request. By explaining why you're making a change (or linking to an issue) and what changes you've made, we can triage your pull request to the best possible team for review.
+-->
+
+### Why:
+
+Closes:
+
+<!-- If there's an existing issue for your change, please link to it above.
+If there's _not_ an existing issue, please open one first to make it more likely that this update will be accepted: https://github.com/shuding/nextra/issues/new/choose. -->
+
+### What's being changed (if available, include any code snippets, screenshots, or gifs):
+
+<!-- Let us know what you are changing. Share anything that could provide the most context. -->
+
+### Check off the following:
+
+- [ ] I have reviewed my changes in staging, available via the **View
+      deployment** link in this PR's timeline (this link will be available after
+      opening the PR).
+
+  - For content changes, you will also see an automatically generated comment
+    with links directly to pages you've modified. The comment won't appear if
+    your PR only edits files in the `data` directory.
+
+- [ ] For content changes, I have completed the
+      [self-review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist).

.github/workflows/lint.yml

@@ -7,25 +7,22 @@ on:
 jobs:
   lint:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [18]
 
     steps:
       - name: Cancel Previous Runs
         uses: styfle/[email protected]
         with:
           access_token: ${{ github.token }}
 
-      - name: Checkout Master
+      - name: Checkout Main
         uses: actions/checkout@v4
 
       - uses: pnpm/action-setup@v4
 
-      - name: Use Node.js ${{ matrix.node-version }}
+      - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version-file: .node-version
           cache: pnpm
 
       - name: Install Dependencies

.github/workflows/nextjs-bundle-analysis.yml

@@ -24,14 +24,15 @@ jobs:
         with:
           access_token: ${{ github.token }}
 
-      - uses: actions/checkout@v4
+      - name: Checkout Main
+        uses: actions/checkout@v4
 
       - uses: pnpm/action-setup@v4
 
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version-file: .node-version
           cache: pnpm
 
       - name: Install Dependencies
@@ -66,7 +67,7 @@ jobs:
           path: ${{ matrix.package }}/.next/analyze/__bundle_analysis.json
 
       - name: Download Base Branch Bundle Stats
-        uses: dawidd6/action-download-artifact@v3
+        uses: dawidd6/action-download-artifact@v6
         if: success() && github.event.number
         with:
           name: bundle-${{ matrix.package == 'docs' && 'docs' || 'swr-site' }}

.github/workflows/release.yml

@@ -11,15 +11,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout Main
+        uses: actions/checkout@v4
 
       - uses: pnpm/action-setup@v4
 
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
-          cache: 'pnpm'
+          node-version-file: .node-version
+          cache: pnpm
 
       - name: Install Dependencies
         run: pnpm i

.github/workflows/test.yml

@@ -7,10 +7,9 @@ on:
 jobs:
   test:
     name: Test (${{matrix.os}})
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node-version: [18]
         os: [ubuntu-latest, windows-latest]
 
     steps:
@@ -19,15 +18,15 @@ jobs:
         with:
           access_token: ${{ github.token }}
 
-      - name: Checkout Master
+      - name: Checkout Main
         uses: actions/checkout@v4
 
       - uses: pnpm/action-setup@v4
 
-      - name: Use Node.js ${{ matrix.node-version }}
+      - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version-file: .node-version
           cache: pnpm
 
       - name: Install Dependencies

.gitignore

@@ -5,17 +5,12 @@ node_modules/
 dist/
 .turbo/
 out/
-# Theme styles
-packages/nextra-theme-*/style.css
 
-# Stork related
-*/**/public/*.st
-*/**/public/*.toml
-
-.vercel
+.vercel/
 .idea/
 .eslintcache
 .env
 
 tsup.config.bundled*
 tsconfig.tsbuildinfo
+pagefind/

.node-version

@@ -0,0 +1 @@
+20

.prettierignore

@@ -1,10 +1,12 @@
 pnpm-lock.yaml
 .changeset/*.md
+generated-page-map.js
 
-# process.env assignement should be first
-packages/nextra/__test__/locale-with-base-path.test.ts
-
-# bellow files are broken since prettier doesn't support MDX2
-examples/swr-site/pages/remote/graphql-eslint/\[\[...slug\]\].mdx
-examples/swr-site/pages/blog.en-US.mdx
 docs/pages/docs/guide/advanced/latex.mdx
+
+examples/swr-site/nextra-remote-filepaths/*.json
+examples/swr-site/pages/en/remote/graphql-eslint/_meta.ts
+examples/swr-site/pages/en/remote/graphql-yoga/_meta.ts
+
+docs/pages/docs/guide/built-ins/cards.mdx
+docs/pages/docs/guide/advanced/playground.mdx