Merge branch 'main' into create-route-announcer

.eslintignore

@@ -1,4 +1,5 @@
 __fixtures__
+__mocks__
 dist
 node_modules
 .yarn
@@ -11,9 +12,8 @@ examples/
 packages/lqip-loader/lib/
 packages/docusaurus/lib/
 packages/docusaurus-*/lib/*
-packages/docusaurus-*/lib-next/
+packages/eslint-plugin/lib/
 packages/stylelint-copyright/lib/
-copyUntypedFiles.mjs
 
 packages/create-docusaurus/lib/*
 packages/create-docusaurus/templates/facebook

.eslintrc.js

@@ -32,6 +32,7 @@ module.exports = {
     'plugin:@typescript-eslint/recommended',
     'plugin:regexp/recommended',
     'prettier',
+    'plugin:@docusaurus/all',
   ],
   settings: {
     'import/resolver': {
@@ -41,7 +42,14 @@ module.exports = {
     },
   },
   reportUnusedDisableDirectives: true,
-  plugins: ['react-hooks', 'header', 'jest', '@typescript-eslint', 'regexp'],
+  plugins: [
+    'react-hooks',
+    'header',
+    'jest',
+    '@typescript-eslint',
+    'regexp',
+    '@docusaurus',
+  ],
   rules: {
     'array-callback-return': WARNING,
     camelcase: WARNING,
@@ -75,7 +83,7 @@ module.exports = {
     'no-restricted-exports': OFF,
     'no-restricted-properties': [
       ERROR,
-      ...[
+      .../** @type {[string, string][]} */ ([
         // TODO: TS doesn't make Boolean a narrowing function yet,
         // so filter(Boolean) is problematic type-wise
         // ['compact', 'Array#filter(Boolean)'],
@@ -106,7 +114,7 @@ module.exports = {
         ['take', 'Array#slice(0, n)'],
         ['takeRight', 'Array#slice(-n)'],
         ['tail', 'Array#slice(1)'],
-      ].map(([property, alternative]) => ({
+      ]).map(([property, alternative]) => ({
         object: '_',
         property,
         message: `Use ${alternative} instead.`,
@@ -212,7 +220,35 @@ module.exports = {
         ],
       },
     ],
-    'import/order': OFF,
+    'import/order': [
+      WARNING,
+      {
+        groups: [
+          'builtin',
+          'external',
+          'internal',
+          ['parent', 'sibling', 'index'],
+          'type',
+        ],
+        pathGroups: [
+          {pattern: '@jest/globals', group: 'builtin', position: 'before'},
+          {pattern: 'react', group: 'builtin', position: 'before'},
+          {pattern: 'fs-extra', group: 'builtin'},
+          {pattern: 'lodash', group: 'external', position: 'before'},
+          {pattern: 'clsx', group: 'external', position: 'before'},
+          // 'Bit weird to not use the `import/internal-regex` option, but this
+          // way, we can make `import type { Props } from "@theme/*"` appear
+          // before `import styles from "styles.module.css"`, which is what we
+          // always did. This should be removable once we stop using ambient
+          // module declarations for theme aliases.
+          {pattern: '@theme/**', group: 'internal'},
+          {pattern: '@site/**', group: 'internal'},
+          {pattern: '@theme-init/**', group: 'internal'},
+          {pattern: '@theme-original/**', group: 'internal'},
+        ],
+        pathGroupsExcludedImportTypes: [],
+      },
+    ],
     'import/prefer-default-export': OFF,
 
     'jest/consistent-test-it': WARNING,
@@ -305,6 +341,24 @@ module.exports = {
     // locals must be justified with a disable comment.
     '@typescript-eslint/no-unused-vars': [ERROR, {ignoreRestSiblings: true}],
     '@typescript-eslint/prefer-optional-chain': ERROR,
+    '@docusaurus/no-untranslated-text': [
+      WARNING,
+      {
+        ignoredStrings: [
+          '·',
+          '-',
+          '—',
+          '×',
+          '​', // zwj: ​
+          '@',
+          'WebContainers',
+          'Twitter',
+          'GitHub',
+          'Dev.to',
+          '1.x',
+        ],
+      },
+    ],
   },
   overrides: [
     {
@@ -327,6 +381,7 @@ module.exports = {
         'header/header': OFF,
         'global-require': OFF,
         '@typescript-eslint/no-var-requires': OFF,
+        '@docusaurus/no-untranslated-text': OFF,
       },
     },
     {
@@ -350,6 +405,16 @@ module.exports = {
         '@typescript-eslint/explicit-module-boundary-types': OFF,
       },
     },
+    {
+      files: [
+        '**/__tests__/**',
+        'packages/docusaurus-plugin-debug/**',
+        'website/_dogfooding/**',
+      ],
+      rules: {
+        '@docusaurus/no-untranslated-text': OFF,
+      },
+    },
     {
       // Internal files where extraneous deps don't matter much at long as
       // they run

.gitattributes

@@ -31,8 +31,14 @@
 # Make GitHub not index certain files in the languages overview
 # See https://github.com/github/linguist/blob/master/docs/overrides.md
 # generated files' diff will be minimized
-**/__fixtures__/**  linguist-generated
-.husky/**           linguist-vendored
-jest/**             linguist-vendored
-admin/**            linguist-documentation
-website/**          linguist-documentation
+**/__fixtures__/**                        linguist-generated
+**/__mocks__/**                           linguist-generated
+examples/**                               linguist-generated
+.husky/**                                 linguist-vendored
+jest/**                                   linguist-vendored
+admin/**                                  linguist-documentation
+website/**                                linguist-documentation
+packages/create-docusaurus/templates/**   linguist-vendored
+.eslintrc.*                               linguist-vendored
+jest.config.*                             linguist-vendored
+.stylelintrc.*                            linguist-vendored

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,28 +1,44 @@
 <!--
 Thank you for sending the PR! We appreciate you spending the time to work on these changes.
-
-Help us understand your motivation by explaining why you decided to make this change.
-
 You can learn more about contributing to Docusaurus here: https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md
+Happy contributing!
+-->
 
-If this PR adds or changes functionality, please take some time to update the docs.
+## Pre-flight checklist
 
-Happy contributing!
+- [ ] I have read the [Contributing Guidelines on pull requests](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#pull-requests).
+- [ ] **If this is a code change**: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
+- [ ] **If this is a new API or substantial change**: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.
 
+<!--
+Please also remember to sign the CLA, although you can also sign it after submitting the PR. The CLA is required for us to merge your PR.
+If this PR adds or changes functionality, please take some time to update the docs. You can also write docs after the API design is finalized and the code changes have been approved.
 -->
 
 ## Motivation
 
-<!-- Write your motivation here. -->
-
-### Have you read the [Contributing Guidelines on pull requests](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#pull-requests)?
-
-<!-- Write your answer here. -->
+<!-- Help us understand your motivation by explaining why you decided to make this change. Does this fix a bug? Does it close an issue? -->
 
 ## Test Plan
 
 <!-- Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos! -->
 
-## Related PRs
+### Test links
+
+<!--
+🙏 Please add an exhaustive list of links relevant to this pull request.
+⏱ This saves maintainers a lot of time during reviews.
+
+- If you changed anything that's displayed on UI, please add a dogfooding page in website/_dogfooding to help us preview the effect. Those tests are deployed at https://docusaurus.io/tests
+- If you changed documentation, please link to the new and updated documentation pages.
+
+After submission, our Netlify bot will post a deploy preview link in comment, in the format of https://deploy-preview-<PR-NUMBER>--docusaurus-2.netlify.app/. Once available, please edit this section with links to the relevant deploy preview pages.
+
+Please don't be afraid to change the main site's configuration as well! You can make use of your new feature on our site so we can preview its effects. We can decide if it should be kept in production before merging it.
+-->
+
+Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/
+
+## Related issues/PRs
 
-<!-- If you haven't already, link to issues/PRs that are related to this change. This helps us develop the context and keep a rich repo history. -->
+<!-- If you haven't already, link to issues/PRs that are related to this change. This helps us develop the context and keep a rich repo history. If this PR is a continuation of a past PR's work, link to that PR. If the PR addresses part of the problem in a meta-issue, mention that issue. -->

.github/dependabot.yml

@@ -5,8 +5,5 @@ updates:
     schedule:
       interval: weekly
     open-pull-requests-limit: 99
-  - package-ecosystem: npm
-    directory: '/'
-    schedule:
-      interval: monthly
-    open-pull-requests-limit: 99
+    labels:
+      - 'pr: dependencies'

.github/workflows/build-blog-only.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - main
     paths:
-      - packages/docusaurus/**
+      - packages/**
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
@@ -23,7 +23,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3
       - name: Set up Node
-        uses: actions/setup-node@56337c425554a6be30cdef71bf441f15be286854 # v3
+        uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048 # v3
         with:
           node-version: '16'
           cache: yarn

.github/workflows/build-perf.yml

@@ -9,8 +9,10 @@ on:
   pull_request:
     branches:
       - main
-    paths-ignore:
-      - website/docs/**
+    paths:
+      - packages/**
+      - website/**
+      - '!website/docs/**'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
@@ -33,7 +35,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3
       - name: Set up Node
-        uses: actions/setup-node@56337c425554a6be30cdef71bf441f15be286854 # v3
+        uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048 # v3
         with:
           node-version: '16'
           cache: yarn
@@ -53,7 +55,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3
-      - uses: actions/setup-node@56337c425554a6be30cdef71bf441f15be286854 # v3
+      - uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048 # v3
         with:
           cache: yarn
       - name: Installation

.github/workflows/canary-release.yml

@@ -20,7 +20,7 @@ jobs:
         with:
           fetch-depth: 0 # Needed to get the commit number with "git rev-list --count HEAD"
       - name: Set up Node
-        uses: actions/setup-node@56337c425554a6be30cdef71bf441f15be286854 # v3
+        uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048 # v3
         with:
           node-version: '16'
           cache: yarn

.github/workflows/codeql-analysis.yml

@@ -34,9 +34,9 @@ jobs:
         uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@1ed1437484560351c5be56cf73a48a279d116b78 # v2
+        uses: github/codeql-action/init@a3a6c128d771b6b9bdebb1c9d0583ebd2728a108 # v2
         with:
           languages: ${{ matrix.language }}
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@1ed1437484560351c5be56cf73a48a279d116b78 # v2
+        uses: github/codeql-action/analyze@a3a6c128d771b6b9bdebb1c9d0583ebd2728a108 # v2

.github/workflows/dependency-review.yml

@@ -15,4 +15,4 @@ jobs:
       - name: Checkout
         uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b #v3
       - name: Dependency Review
-        uses: actions/dependency-review-action@3f943b86c9a289f4e632c632695e2e0898d9d67d # v1
+        uses: actions/dependency-review-action@a9c83d3af6b9031e20feba03b904645bb23d1dab # v1

.github/workflows/lighthouse-report.yml

@@ -28,35 +28,23 @@ jobs:
         with:
           urls: |
             https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/
+            https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/docs/installation
           configPath: ./.github/workflows/lighthouserc.json
           uploadArtifacts: true
           temporaryPublicStorage: true
         env:
           PR_NUMBER: ${{ github.event.pull_request.number}}
       - name: Format lighthouse score
         id: format_lighthouse_score
-        uses: actions/github-script@9ac08808f993958e9de277fe43a64532a609130e # v6
+        uses: actions/github-script@7a5c598405937d486b0331594b5da2b14db670da # v6
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
-            const result = ${{ steps.lighthouse_audit.outputs.manifest }}[0].summary
+            const results = ${{ steps.lighthouse_audit.outputs.manifest }}
             const links = ${{ steps.lighthouse_audit.outputs.links }}
-            const formatResult = (res) => Math.round((res * 100))
-            Object.keys(result).forEach(key => result[key] = formatResult(result[key]))
-            const score = res => res >= 90 ? '🟢' : res >= 50 ? '🟠' : '🔴'
-            const comment = [
-                `⚡️ [Lighthouse report](${Object.values(links)[0]}) for the changes in this PR:`,
-                '| Category | Score |',
-                '| --- | --- |',
-                `| ${score(result.performance)} Performance | ${result.performance} |`,
-                `| ${score(result.accessibility)} Accessibility | ${result.accessibility} |`,
-                `| ${score(result['best-practices'])} Best practices | ${result['best-practices']} |`,
-                `| ${score(result.seo)} SEO | ${result.seo} |`,
-                `| ${score(result.pwa)} PWA | ${result.pwa} |`,
-                ' ',
-                `*Lighthouse ran on [${Object.keys(links)[0]}](${Object.keys(links)[0]})*`
-            ].join('\n')
-             core.setOutput("comment", comment);
+            const createLighthouseReport = (await import(`${process.env.GITHUB_WORKSPACE}/admin/scripts/formatLighthouseReport.js`)).default;
+            const comment = createLighthouseReport({ results, links });
+            core.setOutput("comment", comment);
 
       - name: Add Lighthouse stats as comment
         id: comment_to_pr

.github/workflows/lighthouserc.json

@@ -1,10 +1,5 @@
 {
   "ci": {
-    "assert": {
-      "assertions": {
-        "categories:accessibility": ["error", {"minScore": 1}]
-      }
-    },
     "collect": {
       "settings": {
         "skipAudits": [

.github/workflows/lint.yml

@@ -21,13 +21,13 @@ jobs:
       - name: Checkout
         uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3
       - name: Set up Node
-        uses: actions/setup-node@56337c425554a6be30cdef71bf441f15be286854 # v3
+        uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048 # v3
         with:
           node-version: '16'
           cache: yarn
       - name: Installation
         run: yarn
-        # run: yarn install --immutable # Fails if yarn.lock is modified  (unfortunately only works for Yarn 2, and --frozen-lockfile is not the same!)
+        # run: yarn install --immutable # Fails if yarn.lock is modified (unfortunately only works for Yarn 2, and --frozen-lockfile is not the same!)
       - name: Check immutable yarn.lock
         run: git diff --exit-code
       - name: Lint

.github/workflows/showcase-test.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3
       - name: Set up Node
-        uses: actions/setup-node@56337c425554a6be30cdef71bf441f15be286854 # v3
+        uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048 # v3
         with:
           node-version: '16'
           cache: yarn