Merge branch 'main' into jc/give-plugins-their-options-back

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

@@ -9,6 +9,7 @@ on:
 
 jobs:
   build:
+    name: Build Blog-only
     timeout-minutes: 30
     runs-on: ubuntu-latest
     steps:

.github/workflows/build-size-report.yml → .github/workflows/build-perf.yml

@@ -1,4 +1,4 @@
-name: Build Size Report
+name: Build Performance
 
 on:
   # Note! you can't safely use "pull_request_target" here
@@ -9,9 +9,12 @@ on:
   pull_request:
     branches:
       - main
+    paths-ignore:
+      - website/docs/**
 
 jobs:
-  build:
+  build-size:
+    name: Build Size Report
     timeout-minutes: 30
     runs-on: ubuntu-latest
     steps:
@@ -27,3 +30,25 @@ jobs:
           strip-hash: '\.([^;]\w{7})\.'
           minimum-change-threshold: 30
           compression: none
+  build-time:
+    name: Build Time Perf
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          cache: yarn
+      - name: Installation
+        run: yarn
+
+      # Ensure build with a cold cache does not increase too much
+      - name: Build (cold cache)
+        run: yarn workspace website build --locale en
+        timeout-minutes: 8
+
+      # Ensure build with a warm cache does not increase too much
+      - name: Build (warm cache)
+        run: yarn workspace website build --locale en
+        timeout-minutes: 2
+    # TODO post a Github comment with build with perf warnings?

.github/workflows/canary-release.yml

@@ -9,6 +9,7 @@ on:
 
 jobs:
   publish-canary:
+    name: Publish Canary
     runs-on: ubuntu-latest
     strategy:
       matrix:

.github/workflows/lighthouse-report.yml

@@ -6,7 +6,8 @@ on:
       - main
 
 jobs:
-  build:
+  lighthouse-report:
+    name: Lighthouse Report
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

.github/workflows/lint.yml

@@ -7,6 +7,7 @@ on:
 
 jobs:
   lint:
+    name: Lint
     timeout-minutes: 30
     runs-on: ubuntu-latest
     steps:

.github/workflows/tests-e2e.yml

@@ -1,15 +1,20 @@
-name: Tests E2E
+name: E2E Tests
 
 on:
   push:
     branches:
       - main
+    paths-ignore:
+      - website/**
   pull_request:
     branches:
       - main
+    paths-ignore:
+      - website/**
 
 jobs:
   yarn-v1:
+    name: E2E — Yarn v1
     timeout-minutes: 30
     runs-on: ubuntu-latest
     strategy:
@@ -42,6 +47,7 @@ jobs:
           CI: true
 
   yarn-berry:
+    name: E2E — Yarn Berry
     timeout-minutes: 30
     runs-on: ubuntu-latest
     strategy:

.github/workflows/tests.yml

@@ -4,9 +4,12 @@ on:
   pull_request:
     branches:
       - main
+    paths-ignore:
+      - website/**
 
 jobs:
   test:
+    name: Tests
     timeout-minutes: 30
     runs-on: ubuntu-latest
     strategy:
@@ -25,3 +28,26 @@ jobs:
         run: yarn test
       - name: TypeCheck website
         run: yarn workspace website tsc
+  windows-test:
+    name: Windows Tests
+    timeout-minutes: 30
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        node: ['14', '16', '17']
+    steps:
+      - name: Support longpaths
+        run: git config --system core.longpaths true
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Installation
+        run: yarn || yarn || yarn # 3 attempts to avoid timeout errors...
+      - name: Docusaurus Jest Tests
+        run: yarn test
+      - name: Docusaurus Build
+        run: yarn build:website --locale en
+        env:
+          CI: true

examples/classic-typescript/docs/tutorial-basics/create-a-document.md

@@ -26,7 +26,7 @@ A new document is now available at `http://localhost:3000/docs/hello`.
 
 Docusaurus automatically **creates a sidebar** from the `docs` folder.
 
-Add metadatas to customize the sidebar label and position:
+Add metadata to customize the sidebar label and position:
 
 ```md title="docs/hello.md" {1-4}
 ---

examples/classic/docs/tutorial-basics/create-a-document.md

@@ -26,7 +26,7 @@ A new document is now available at `http://localhost:3000/docs/hello`.
 
 Docusaurus automatically **creates a sidebar** from the `docs` folder.
 
-Add metadatas to customize the sidebar label and position:
+Add metadata to customize the sidebar label and position:
 
 ```md title="docs/hello.md" {1-4}
 ---

examples/facebook/docs/tutorial-basics/create-a-document.md

@@ -26,7 +26,7 @@ A new document is now available at `http://localhost:3000/docs/hello`.
 
 Docusaurus automatically **creates a sidebar** from the `docs` folder.
 
-Add metadatas to customize the sidebar label and position:
+Add metadata to customize the sidebar label and position:
 
 ```md title="docs/hello.md" {1-4}
 ---

packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-document.md

@@ -26,7 +26,7 @@ A new document is now available at `http://localhost:3000/docs/hello`.
 
 Docusaurus automatically **creates a sidebar** from the `docs` folder.
 
-Add metadatas to customize the sidebar label and position:
+Add metadata to customize the sidebar label and position:
 
 ```md title="docs/hello.md" {1-4}
 ---

packages/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/writeRedirectFiles.test.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`toRedirectFilesMetadata should create appropriate metadatas for empty baseUrl: fileContent baseUrl=empty 1`] = `
+exports[`toRedirectFilesMetadata should create appropriate metadata for empty baseUrl: fileContent baseUrl=empty 1`] = `
 Array [
   "<!DOCTYPE html>
 <html>
@@ -16,7 +16,7 @@ Array [
 ]
 `;
 
-exports[`toRedirectFilesMetadata should create appropriate metadatas for root baseUrl: fileContent baseUrl=/ 1`] = `
+exports[`toRedirectFilesMetadata should create appropriate metadata for root baseUrl: fileContent baseUrl=/ 1`] = `
 Array [
   "<!DOCTYPE html>
 <html>
@@ -32,7 +32,7 @@ Array [
 ]
 `;
 
-exports[`toRedirectFilesMetadata should create appropriate metadatas trailingSlash=false: fileContent 1`] = `
+exports[`toRedirectFilesMetadata should create appropriate metadata trailingSlash=false: fileContent 1`] = `
 Array [
   "<!DOCTYPE html>
 <html>
@@ -70,7 +70,7 @@ Array [
 ]
 `;
 
-exports[`toRedirectFilesMetadata should create appropriate metadatas trailingSlash=true: fileContent 1`] = `
+exports[`toRedirectFilesMetadata should create appropriate metadata trailingSlash=true: fileContent 1`] = `
 Array [
   "<!DOCTYPE html>
 <html>
@@ -108,7 +108,7 @@ Array [
 ]
 `;
 
-exports[`toRedirectFilesMetadata should create appropriate metadatas trailingSlash=undefined: fileContent 1`] = `
+exports[`toRedirectFilesMetadata should create appropriate metadata trailingSlash=undefined: fileContent 1`] = `
 Array [
   "<!DOCTYPE html>
 <html>

packages/docusaurus-plugin-client-redirects/src/__tests__/writeRedirectFiles.test.ts

@@ -42,7 +42,7 @@ describe('createToUrl', () => {
 });
 
 describe('toRedirectFilesMetadata', () => {
-  test('should create appropriate metadatas trailingSlash=undefined', async () => {
+  test('should create appropriate metadata trailingSlash=undefined', async () => {
     const pluginContext = {
       outDir: '/tmp/someFixedOutDir',
       baseUrl: 'https://docusaurus.io',
@@ -69,7 +69,7 @@ describe('toRedirectFilesMetadata', () => {
     );
   });
 
-  test('should create appropriate metadatas trailingSlash=true', async () => {
+  test('should create appropriate metadata trailingSlash=true', async () => {
     const pluginContext = {
       outDir: '/tmp/someFixedOutDir',
       baseUrl: 'https://docusaurus.io',
@@ -96,7 +96,7 @@ describe('toRedirectFilesMetadata', () => {
     );
   });
 
-  test('should create appropriate metadatas trailingSlash=false', async () => {
+  test('should create appropriate metadata trailingSlash=false', async () => {
     const pluginContext = {
       outDir: '/tmp/someFixedOutDir',
       baseUrl: 'https://docusaurus.io',
@@ -124,7 +124,7 @@ describe('toRedirectFilesMetadata', () => {
     );
   });
 
-  test('should create appropriate metadatas for root baseUrl', async () => {
+  test('should create appropriate metadata for root baseUrl', async () => {
     const pluginContext = {
       outDir: '/tmp/someFixedOutDir',
       baseUrl: '/',
@@ -139,7 +139,7 @@ describe('toRedirectFilesMetadata', () => {
     );
   });
 
-  test('should create appropriate metadatas for empty baseUrl', async () => {
+  test('should create appropriate metadata for empty baseUrl', async () => {
     const pluginContext = {
       outDir: '/tmp/someFixedOutDir',
       baseUrl: '',

packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts

@@ -394,4 +394,15 @@ describe('loadBlog', () => {
       truncated: false,
     });
   });
+
+  test('test ascending sort direction of blog post', async () => {
+    const siteDir = path.join(__dirname, '__fixtures__', 'website');
+    const normalOrder = await getBlogPosts(siteDir);
+    const reversedOrder = await getBlogPosts(siteDir, {
+      sortPosts: 'ascending',
+    });
+    expect(normalOrder.reverse().map((x) => x.metadata.date)).toEqual(
+      reversedOrder.map((x) => x.metadata.date),
+    );
+  });
 });

packages/docusaurus-plugin-content-blog/src/blogUtils.ts

@@ -294,6 +294,9 @@ export async function generateBlogPosts(
     (a, b) => b.metadata.date.getTime() - a.metadata.date.getTime(),
   );
 
+  if (options.sortPosts === 'ascending') {
+    return blogPosts.reverse();
+  }
   return blogPosts;
 }
 

packages/docusaurus-plugin-content-blog/src/pluginOptionSchema.ts

@@ -42,6 +42,7 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   editLocalizedFiles: false,
   authorsMapPath: 'authors.yml',
   readingTime: ({content, defaultReadingTime}) => defaultReadingTime({content}),
+  sortPosts: 'descending',
 };
 
 export const PluginOptionSchema = Joi.object<PluginOptions>({
@@ -115,4 +116,7 @@ export const PluginOptionSchema = Joi.object<PluginOptions>({
   }).default(DEFAULT_OPTIONS.feedOptions),
   authorsMapPath: Joi.string().default(DEFAULT_OPTIONS.authorsMapPath),
   readingTime: Joi.function().default(() => DEFAULT_OPTIONS.readingTime),
+  sortPosts: Joi.string()
+    .valid('descending', 'ascending')
+    .default(DEFAULT_OPTIONS.sortPosts),
 });

packages/docusaurus-plugin-content-blog/src/types.ts

@@ -96,6 +96,7 @@ export type PluginOptions = RemarkAndRehypePluginOptions & {
   admonitions: Record<string, unknown>;
   authorsMapPath: string;
   readingTime: ReadingTimeFunctionOption;
+  sortPosts: 'ascending' | 'descending';
 };
 
 // Options, as provided in the user config (before normalization)

packages/docusaurus-plugin-content-docs/package.json

@@ -34,7 +34,6 @@
     "chalk": "^4.1.2",
     "combine-promises": "^1.1.0",
     "escape-string-regexp": "^4.0.0",
-    "execa": "^5.0.0",
     "fs-extra": "^10.0.0",
     "globby": "^11.0.2",
     "import-fresh": "^3.2.2",