chore: enable eslint-plugin-jest (#6375)

.eslintrc.js

@@ -29,6 +29,7 @@ module.exports = {
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:react-hooks/recommended',
+    'plugin:jest/recommended',
     'airbnb',
     'prettier',
   ],
@@ -40,7 +41,7 @@ module.exports = {
     },
   },
   reportUnusedDisableDirectives: true,
-  plugins: ['react-hooks', 'header'],
+  plugins: ['react-hooks', 'header', 'jest'],
   rules: {
     'react-hooks/rules-of-hooks': ERROR,
     'react-hooks/exhaustive-deps': ERROR,
@@ -171,6 +172,9 @@ module.exports = {
         ],
       },
     ],
+    'jest/prefer-expect-resolves': WARNING,
+    'jest/expect-expect': OFF,
+    'jest/valid-title': OFF,
   },
   overrides: [
     {

__tests__/validate-package-json.test.ts

@@ -38,15 +38,15 @@ describe('packages', () => {
   test('should contain repository and directory for every package', async () => {
     const packageJsonFiles = await getPackagesJsonFiles();
 
-    packageJsonFiles.forEach((packageJsonFile) => {
+    packageJsonFiles
-      if (packageJsonFile.content.private !== true) {
+      .filter((packageJsonFile) => !packageJsonFile.content.private)
+      .forEach((packageJsonFile) => {
         expect(packageJsonFile.content.repository).toEqual({
           type: 'git',
           url: 'https://github.com/facebook/docusaurus.git',
           directory: packageJsonFile.file.replace(/\/package\.json$/, ''),
         });
-      }
+      });
-    });
   });
 
   /*
@@ -58,17 +58,19 @@ describe('packages', () => {
   test('should have publishConfig.access: "public" when name starts with @', async () => {
     const packageJsonFiles = await getPackagesJsonFiles();
 
-    packageJsonFiles.forEach((packageJsonFile) => {
+    packageJsonFiles
-      if (packageJsonFile.content.name.startsWith('@')) {
+      .filter((packageJsonFile) => packageJsonFile.content.name.startsWith('@'))
-        // Unfortunately jest custom message do not exist in loops, so using an exception instead to show failing package file
+      .forEach((packageJsonFile) => {
-        // (see https://github.com/facebook/jest/issues/3293)
+        if (packageJsonFile) {
-        // expect(packageJsonFile.content.publishConfig?.access).toEqual('public');
+          // Unfortunately jest custom message do not exist in loops, so using an exception instead to show failing package file
-        if (packageJsonFile.content.publishConfig?.access !== 'public') {
+          // (see https://github.com/facebook/jest/issues/3293)
-          throw new Error(
+          // expect(packageJsonFile.content.publishConfig?.access).toEqual('public');
-            `Package ${packageJsonFile.file} does not have publishConfig.access: 'public'`,
+          if (packageJsonFile.content.publishConfig?.access !== 'public') {
-          );
+            throw new Error(
+              `Package ${packageJsonFile.file} does not have publishConfig.access: 'public'`,
+            );
+          }
         }
-      }
+      });
-    });
   });
 });

package.json

@@ -90,6 +90,7 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-jest": "^25.7.0",
     "eslint-plugin-jsx-a11y": "^6.5.1",
     "eslint-plugin-react": "^7.27.0",
     "eslint-plugin-react-hooks": "^4.3.0",

packages/docusaurus-mdx-loader/src/remark/toc/__tests__/search.test.ts

@@ -32,7 +32,7 @@ test('should process all heading levels', async () => {
 
   `;
 
-  expect(await getHeadings(md)).toEqual([
+  await expect(getHeadings(md)).resolves.toEqual([
     {
       children: [
         {
@@ -126,7 +126,7 @@ some text
 
   `;
 
-  expect(await getHeadings(md)).toEqual([
+  await expect(getHeadings(md)).resolves.toEqual([
     {
       children: [
         {

packages/docusaurus-migrate/src/__tests__/migration.test.ts

@@ -10,7 +10,7 @@ import path from 'path';
 import fs from 'fs-extra';
 
 describe('migration test', () => {
-  test('simple website', () => {
+  test('simple website', async () => {
     const siteDir = path.join(
       __dirname,
       '__fixtures__',
@@ -18,10 +18,12 @@ describe('migration test', () => {
       'website',
     );
     const newDir = path.join(__dirname, '__fixtures__', 'migrated_simple_site');
-    migrateDocusaurusProject(siteDir, newDir);
+    await expect(
+      migrateDocusaurusProject(siteDir, newDir),
+    ).resolves.toBeUndefined();
     fs.removeSync(newDir);
   });
-  test('complex website', () => {
+  test('complex website', async () => {
     const siteDir = path.join(
       __dirname,
       '__fixtures__',
@@ -33,11 +35,13 @@ describe('migration test', () => {
       '__fixtures__',
       'migrated_complex_site',
     );
-    migrateDocusaurusProject(siteDir, newDir);
+    await expect(
+      migrateDocusaurusProject(siteDir, newDir),
+    ).resolves.toBeUndefined();
     fs.removeSync(newDir);
   });
 
-  test('missing versions', () => {
+  test('missing versions', async () => {
     const siteDir = path.join(
       __dirname,
       '__fixtures__',
@@ -49,7 +53,9 @@ describe('migration test', () => {
       '__fixtures__',
       'migrated_missing_version_site',
     );
-    migrateDocusaurusProject(siteDir, newDir);
+    await expect(
+      migrateDocusaurusProject(siteDir, newDir),
+    ).resolves.toBeUndefined();
     fs.removeSync(newDir);
   });
 });

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

@@ -39,7 +39,7 @@ describe('collectRedirects', () => {
     );
   });
 
-  test('should collect redirects to html/exe extension', () => {
+  test('should collect redirects from html/exe extension', () => {
     expect(
       collectRedirects(
         createTestPluginContext(

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

@@ -9,22 +9,24 @@ import {validateRedirect} from '../redirectValidation';
 
 describe('validateRedirect', () => {
   test('validate good redirects without throwing', () => {
-    validateRedirect({
+    expect(() => {
-      from: '/fromSomePath',
+      validateRedirect({
-      to: '/toSomePath',
+        from: '/fromSomePath',
-    });
+        to: '/toSomePath',
-    validateRedirect({
+      });
-      from: '/from/Some/Path',
+      validateRedirect({
-      to: '/toSomePath',
+        from: '/from/Some/Path',
-    });
+        to: '/toSomePath',
-    validateRedirect({
+      });
-      from: '/fromSomePath',
+      validateRedirect({
-      to: '/toSomePath',
+        from: '/fromSomePath',
-    });
+        to: '/toSomePath',
-    validateRedirect({
+      });
-      from: '/fromSomePath',
+      validateRedirect({
-      to: '/to/Some/Path',
+        from: '/fromSomePath',
-    });
+        to: '/to/Some/Path',
+      });
+    }).not.toThrow();
   });
 
   test('throw for bad redirects', () => {

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

@@ -288,30 +288,30 @@ describe('getAuthorsMap', () => {
   };
 
   test('getAuthorsMap can read yml file', async () => {
-    expect(
+    await expect(
-      await getAuthorsMap({
+      getAuthorsMap({
         contentPaths,
         authorsMapPath: 'authors.yml',
       }),
-    ).toBeDefined();
+    ).resolves.toBeDefined();
   });
 
   test('getAuthorsMap can read json file', async () => {
-    expect(
+    await expect(
-      await getAuthorsMap({
+      getAuthorsMap({
         contentPaths,
         authorsMapPath: 'authors.json',
       }),
-    ).toBeDefined();
+    ).resolves.toBeDefined();
   });
 
   test('getAuthorsMap can return undefined if yaml file not found', async () => {
-    expect(
+    await expect(
-      await getAuthorsMap({
+      getAuthorsMap({
         contentPaths,
         authorsMapPath: 'authors_does_not_exist.yml',
       }),
-    ).toBeUndefined();
+    ).resolves.toBeUndefined();
   });
 });
 

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

@@ -44,6 +44,7 @@ function testField(params: {
       params.invalidFrontMatters?.forEach(([frontMatter, message]) => {
         try {
           validateBlogPostFrontMatter(frontMatter);
+          // eslint-disable-next-line jest/no-jasmine-globals
           fail(
             new Error(
               `Blog frontmatter is expected to be rejected, but was accepted successfully:\n ${JSON.stringify(
@@ -54,6 +55,7 @@ function testField(params: {
             ),
           );
         } catch (e) {
+          // eslint-disable-next-line jest/no-conditional-expect
           expect(e.message).toMatch(new RegExp(escapeStringRegexp(message)));
         }
       });

packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts

@@ -41,6 +41,7 @@ function testField(params: {
     params.invalidFrontMatters?.forEach(([frontMatter, message]) => {
       try {
         validateDocFrontMatter(frontMatter);
+        // eslint-disable-next-line jest/no-jasmine-globals
         fail(
           new Error(
             `Doc frontmatter is expected to be rejected, but was accepted successfully:\n ${JSON.stringify(
@@ -51,6 +52,7 @@ function testField(params: {
           ),
         );
       } catch (e) {
+        // eslint-disable-next-line jest/no-conditional-expect
         expect(e.message).toMatch(new RegExp(escapeStringRegexp(message)));
       }
     });

packages/docusaurus-plugin-content-docs/src/__tests__/lastUpdate.test.ts

@@ -52,20 +52,20 @@ describe('lastUpdate', () => {
       '__fixtures__',
       nonExistingFileName,
     );
-    expect(await getFileLastUpdate(nonExistingFilePath)).toBeNull();
+    await expect(getFileLastUpdate(nonExistingFilePath)).resolves.toBeNull();
     expect(consoleMock).toHaveBeenCalledTimes(1);
     expect(consoleMock).toHaveBeenLastCalledWith(
       expect.stringMatching(/with exit code 128/),
     );
-    expect(await getFileLastUpdate(null)).toBeNull();
+    await expect(getFileLastUpdate(null)).resolves.toBeNull();
-    expect(await getFileLastUpdate(undefined)).toBeNull();
+    await expect(getFileLastUpdate(undefined)).resolves.toBeNull();
     consoleMock.mockRestore();
   });
 
   test('temporary created file that has no git timestamp', async () => {
     const tempFilePath = path.join(__dirname, '__fixtures__', '.temp');
     fs.writeFileSync(tempFilePath, 'Lorem ipsum :)');
-    expect(await getFileLastUpdate(tempFilePath)).toBeNull();
+    await expect(getFileLastUpdate(tempFilePath)).resolves.toBeNull();
     fs.unlinkSync(tempFilePath);
   });
 

packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/utils.test.ts

@@ -124,7 +124,7 @@ describe('createSidebarsUtils', () => {
     getFirstLink,
   } = createSidebarsUtils(sidebars);
 
-  test('getSidebarNameByDocId', async () => {
+  test('getFirstDocIdOfFirstSidebar', async () => {
     expect(getFirstDocIdOfFirstSidebar()).toEqual('doc1');
   });
 

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

@@ -9,7 +9,7 @@ import path from 'path';
 import {loadContext} from '@docusaurus/core/lib/server';
 
 import pluginContentPages from '../index';
-import normalizePluginOptions from './pluginOptionSchema.test';
+import {PluginOptionSchema} from '../pluginOptionSchema';
 
 describe('docusaurus-plugin-content-pages', () => {
   test('simple pages', async () => {
@@ -18,9 +18,9 @@ describe('docusaurus-plugin-content-pages', () => {
     const pluginPath = 'src/pages';
     const plugin = await pluginContentPages(
       context,
-      normalizePluginOptions({
+      PluginOptionSchema.validate({
         path: pluginPath,
-      }),
+      }).value,
     );
     const pagesMetadata = await plugin.loadContent?.();
 
@@ -85,9 +85,9 @@ describe('docusaurus-plugin-content-pages', () => {
           currentLocale: 'fr',
         },
       },
-      normalizePluginOptions({
+      PluginOptionSchema.validate({
         path: pluginPath,
-      }),
+      }).value,
     );
     const pagesMetadata = await plugin.loadContent?.();
 

packages/docusaurus-plugin-content-pages/src/__tests__/pluginOptionSchema.test.ts

@@ -8,7 +8,7 @@
 import {PluginOptionSchema, DEFAULT_OPTIONS} from '../pluginOptionSchema';
 import type {PluginOptions} from '@docusaurus/plugin-content-pages';
 
-export default function normalizePluginOptions(
+function normalizePluginOptions(
   options: Partial<PluginOptions>,
 ): PluginOptions {
   const {value, error} = PluginOptionSchema.validate(options, {

packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.ts

@@ -243,7 +243,7 @@ describe('themeConfig', () => {
     ).toThrowErrorMatchingInlineSnapshot(`"Nested dropdowns are not allowed"`);
   });
 
-  test('should reject nested dropdowns', () => {
+  test('should reject nested dropdowns 2', () => {
     const config = {
       navbar: {
         items: [
@@ -442,7 +442,7 @@ describe('themeConfig', () => {
     );
   });
 
-  test('should allow width and height specification for logo ', () => {
+  test('should allow width and height specification for logo', () => {
     const altTagConfig = {
       navbar: {
         logo: {

packages/docusaurus-theme-classic/src/theme/Heading/index.tsx

@@ -46,7 +46,7 @@ function AnchorHeading({as: As, id, ...props}: Props) {
   );
 }
 
-export default function Heading({as, ...props}: Props) {
+export default function Heading({as, ...props}: Props): JSX.Element {
   if (as === 'h1') {
     return (
       <h1

packages/docusaurus-theme-search-algolia/src/client/useAlgoliaContextualFacetFilters.ts

@@ -8,7 +8,7 @@
 import {useContextualSearchFilters} from '@docusaurus/theme-common';
 
 // Translate search-engine agnostic search filters to Algolia search filters
-export function useAlgoliaContextualFacetFilters() {
+export function useAlgoliaContextualFacetFilters(): [string, string[]] {
   const {locale, tags} = useContextualSearchFilters();
 
   // seems safe to convert locale->language, see AlgoliaSearchMetadata comment

packages/docusaurus-utils-common/src/__tests__/applyTrailingSlash.test.ts

@@ -62,7 +62,7 @@ describe('applyTrailingSlash', () => {
     ).toEqual('/baseUrl/?query#anchor');
   });
 
-  test('should not apply to #anchor links ', () => {
+  test('should not apply to #anchor links', () => {
     expect(applyTrailingSlash('#', params(true))).toEqual('#');
     expect(applyTrailingSlash('#', params(false))).toEqual('#');
     expect(applyTrailingSlash('#', params(undefined))).toEqual('#');

packages/docusaurus-utils/src/__tests__/dataFileUtils.test.ts

@@ -23,102 +23,104 @@ describe('getDataFilePath', () => {
   const contentPathNestedYml = path.join(fixturesDir, 'contentPathNestedYml');
 
   test('getDataFilePath returns localized Yml path in priority', async () => {
-    expect(
+    await expect(
-      await getDataFilePath({
+      getDataFilePath({
         filePath: 'authors.yml',
         contentPaths: {
           contentPathLocalized: contentPathYml1,
           contentPath: contentPathYml2,
         },
       }),
-    ).toEqual(path.join(contentPathYml1, 'authors.yml'));
+    ).resolves.toEqual(path.join(contentPathYml1, 'authors.yml'));
-    expect(
+    await expect(
-      await getDataFilePath({
+      getDataFilePath({
         filePath: 'authors.yml',
         contentPaths: {
           contentPathLocalized: contentPathYml2,
           contentPath: contentPathYml1,
         },
       }),
-    ).toEqual(path.join(contentPathYml2, 'authors.yml'));
+    ).resolves.toEqual(path.join(contentPathYml2, 'authors.yml'));
   });
 
   test('getDataFilePath returns localized Json path in priority', async () => {
-    expect(
+    await expect(
-      await getDataFilePath({
+      getDataFilePath({
         filePath: 'authors.json',
         contentPaths: {
           contentPathLocalized: contentPathJson1,
           contentPath: contentPathJson2,
         },
       }),
-    ).toEqual(path.join(contentPathJson1, 'authors.json'));
+    ).resolves.toEqual(path.join(contentPathJson1, 'authors.json'));
-    expect(
+    await expect(
-      await getDataFilePath({
+      getDataFilePath({
         filePath: 'authors.json',
         contentPaths: {
           contentPathLocalized: contentPathJson2,
           contentPath: contentPathJson1,
         },
       }),
-    ).toEqual(path.join(contentPathJson2, 'authors.json'));
+    ).resolves.toEqual(path.join(contentPathJson2, 'authors.json'));
   });
 
   test('getDataFilePath returns unlocalized Yml path as fallback', async () => {
-    expect(
+    await expect(
-      await getDataFilePath({
+      getDataFilePath({
         filePath: 'authors.yml',
         contentPaths: {
           contentPathLocalized: contentPathEmpty,
           contentPath: contentPathYml2,
         },
       }),
-    ).toEqual(path.join(contentPathYml2, 'authors.yml'));
+    ).resolves.toEqual(path.join(contentPathYml2, 'authors.yml'));
   });
 
   test('getDataFilePath returns unlocalized Json path as fallback', async () => {
-    expect(
+    await expect(
-      await getDataFilePath({
+      getDataFilePath({
         filePath: 'authors.json',
         contentPaths: {
           contentPathLocalized: contentPathEmpty,
           contentPath: contentPathJson1,
         },
       }),
-    ).toEqual(path.join(contentPathJson1, 'authors.json'));
+    ).resolves.toEqual(path.join(contentPathJson1, 'authors.json'));
   });
 
   test('getDataFilePath can return undefined (file not found)', async () => {
-    expect(
+    await expect(
-      await getDataFilePath({
+      getDataFilePath({
         filePath: 'authors.json',
         contentPaths: {
           contentPathLocalized: contentPathEmpty,
           contentPath: contentPathYml1,
         },
       }),
-    ).toBeUndefined();
+    ).resolves.toBeUndefined();
-    expect(
+    await expect(
-      await getDataFilePath({
+      getDataFilePath({
         filePath: 'authors.yml',
         contentPaths: {
           contentPathLocalized: contentPathEmpty,
           contentPath: contentPathJson1,
         },
       }),
-    ).toBeUndefined();
+    ).resolves.toBeUndefined();
   });
 
   test('getDataFilePath can return nested path', async () => {
-    expect(
+    await expect(
-      await getDataFilePath({
+      getDataFilePath({
         filePath: 'sub/folder/authors.yml',
         contentPaths: {
           contentPathLocalized: contentPathEmpty,
           contentPath: contentPathNestedYml,
         },
       }),
-    ).toEqual(path.join(contentPathNestedYml, 'sub/folder/authors.yml'));
+    ).resolves.toEqual(
+      path.join(contentPathNestedYml, 'sub/folder/authors.yml'),
+    );
   });
 });
 

packages/docusaurus-utils/src/__tests__/index.test.ts

@@ -321,11 +321,11 @@ describe('mapAsyncSequential', () => {
     const timeTotal = timeAfter - timeBefore;
 
     const totalTimeouts = sum(Object.values(itemToTimeout));
-    expect(timeTotal > totalTimeouts);
+    expect(timeTotal).toBeGreaterThanOrEqual(totalTimeouts);
 
-    expect(itemMapStartsAt['1'] > 0);
+    expect(itemMapStartsAt['1']).toBeGreaterThanOrEqual(0);
-    expect(itemMapStartsAt['2'] > itemMapEndsAt['1']);
+    expect(itemMapStartsAt['2']).toBeGreaterThanOrEqual(itemMapEndsAt['1']);
-    expect(itemMapStartsAt['3'] > itemMapEndsAt['2']);
+    expect(itemMapStartsAt['3']).toBeGreaterThanOrEqual(itemMapEndsAt['2']);
   });
 });
 
@@ -353,8 +353,8 @@ describe('findAsyncSequential', () => {
     expect(findFn).toHaveBeenNthCalledWith(2, '2');
 
     const timeTotal = timeAfter - timeBefore;
-    expect(timeTotal > 100);
+    expect(timeTotal).toBeGreaterThanOrEqual(100);
-    expect(timeTotal < 150);
+    expect(timeTotal).toBeLessThan(150);
   });
 });
 

packages/docusaurus-utils/src/__tests__/markdownParser.test.ts

@@ -802,7 +802,7 @@ describe('parseMarkdownString', () => {
     `);
   });
 
-  test('should delete only first heading', () => {
+  test('should delete only first heading 2', () => {
     expect(
       parseMarkdownString(dedent`
         # test

packages/docusaurus-utils/src/__tests__/tags.test.ts

@@ -46,7 +46,7 @@ describe('normalizeFrontMatterTag', () => {
     expect(normalizeFrontMatterTag(tagsPath, input)).toEqual(expectedOutput);
   });
 
-  test('should normalize complex string tag', () => {
+  test('should normalize complex string tag with object tag', () => {
     const tagsPath = '/all/tags';
     const input: Input = {
       label: 'tag complex Label',

packages/docusaurus/src/client/exports/__tests__/Interpolate.test.tsx

@@ -22,7 +22,7 @@ describe('Interpolate', () => {
     );
   });
 
-  test('placeholders with string values', () => {
+  test('placeholders with string values 2', () => {
     const text = '{number} {string} {object} {array}';
     const values = {
       number: 42,

packages/docusaurus/src/client/exports/__tests__/isInternalUrl.test.ts

@@ -43,8 +43,4 @@ describe('isInternalUrl', () => {
   test('should be false for undefined links', () => {
     expect(isInternalUrl(undefined)).toBeFalsy();
   });
-
-  test('should be true for root relative links', () => {
-    expect(isInternalUrl('//reactjs.org')).toBeFalsy();
-  });
 });

packages/docusaurus/src/commands/__tests__/deploy.test.ts

@@ -25,7 +25,7 @@ describe('remoteBranchUrl', () => {
     );
     expect(url).toEqual('https://user:pass@github.com/facebook/docusaurus.git');
   });
-  test('should build a normal http url', () => {
+  test('should build a normal http url with port', () => {
     const url = buildHttpsUrl(
       'user:pass',
       'github.com',

packages/docusaurus/src/commands/__tests__/writeHeadingIds.test.ts

@@ -38,12 +38,6 @@ describe('transformMarkdownHeadingLine', () => {
     );
   });
 
-  test('works for simple level-2 heading', () => {
-    expect(transformMarkdownHeadingLine('## ABC', createSlugger())).toEqual(
-      '## ABC {#abc}',
-    );
-  });
-
   test('unwraps markdown links', () => {
     const input = `## hello [facebook](https://facebook.com) [crowdin](https://crowdin.com/translate/docusaurus-v2/126/en-fr?filter=basic&value=0)`;
     expect(transformMarkdownHeadingLine(input, createSlugger())).toEqual(

packages/docusaurus/src/server/__tests__/routes.test.ts

@@ -75,7 +75,7 @@ describe('loadRoutes', () => {
       component: 'hello/world.js',
     } as RouteConfig;
 
-    expect(loadRoutes([routeConfigWithoutPath], '/')).rejects
+    await expect(loadRoutes([routeConfigWithoutPath], '/')).rejects
       .toMatchInlineSnapshot(`
       [Error: Invalid route config: path must be a string and component is required.
       {"component":"hello/world.js"}]
@@ -85,7 +85,7 @@ describe('loadRoutes', () => {
       path: '/hello/world',
     } as RouteConfig;
 
-    expect(loadRoutes([routeConfigWithoutComponent], '/')).rejects
+    await expect(loadRoutes([routeConfigWithoutComponent], '/')).rejects
       .toMatchInlineSnapshot(`
       [Error: Invalid route config: path must be a string and component is required.
       {"path":"/hello/world"}]

packages/docusaurus/src/server/plugins/__tests__/__snapshots__/pluginIds.test.ts.snap

@@ -5,16 +5,16 @@ exports[`ensureUniquePluginInstanceIds reject multi instance plugins with same i
 To use the same plugin multiple times on a Docusaurus site, you need to assign a unique ID to each plugin instance."
 `;
 
+exports[`ensureUniquePluginInstanceIds reject multi instance plugins with some without id 1`] = `
+"Plugin \\"plugin-docs\\" is used 2 times with ID \\"default\\".
+To use the same plugin multiple times on a Docusaurus site, you need to assign a unique ID to each plugin instance.
+
+The plugin ID is \\"default\\" by default. It's possible that the preset you are using already includes a plugin instance, in which case you either want to disable the plugin in the preset (to use a single instance), or assign another ID to your extra plugin instance (to use multiple instances)."
+`;
+
 exports[`ensureUniquePluginInstanceIds reject multi instance plugins without id 1`] = `
 "Plugin \\"plugin-docs\\" is used 2 times with ID \\"default\\".
 To use the same plugin multiple times on a Docusaurus site, you need to assign a unique ID to each plugin instance.
 
 The plugin ID is \\"default\\" by default. It's possible that the preset you are using already includes a plugin instance, in which case you either want to disable the plugin in the preset (to use a single instance), or assign another ID to your extra plugin instance (to use multiple instances)."
 `;
-
-exports[`ensureUniquePluginInstanceIds reject multi instance plugins without id 2`] = `
-"Plugin \\"plugin-docs\\" is used 2 times with ID \\"default\\".
-To use the same plugin multiple times on a Docusaurus site, you need to assign a unique ID to each plugin instance.
-
-The plugin ID is \\"default\\" by default. It's possible that the preset you are using already includes a plugin instance, in which case you either want to disable the plugin in the preset (to use a single instance), or assign another ID to your extra plugin instance (to use multiple instances)."
-`;

packages/docusaurus/src/server/plugins/__tests__/pluginIds.test.ts

@@ -59,7 +59,7 @@ describe('ensureUniquePluginInstanceIds', () => {
     ).toThrowErrorMatchingSnapshot();
   });
 
-  test('reject multi instance plugins without id', async () => {
+  test('reject multi instance plugins with some without id', async () => {
     expect(() =>
       ensureUniquePluginInstanceIds([
         createTestPlugin('plugin-docs'),

packages/docusaurus/src/server/translations/__tests__/translations.test.ts

@@ -112,7 +112,7 @@ describe('writeTranslationFileContent', () => {
       },
     });
 
-    expect(await readFile()).toEqual({
+    await expect(readFile()).resolves.toEqual({
       key1: {message: 'key1 message'},
       key2: {message: 'key2 message'},
       key3: {message: 'key3 message'},
@@ -134,7 +134,7 @@ describe('writeTranslationFileContent', () => {
       },
     });
 
-    expect(await readFile()).toEqual({
+    await expect(readFile()).resolves.toEqual({
       key1: {message: 'PREFIX key1 message'},
       key2: {message: 'PREFIX key2 message'},
       key3: {message: 'PREFIX key3 message'},
@@ -158,7 +158,7 @@ describe('writeTranslationFileContent', () => {
       },
     });
 
-    expect(await readFile()).toEqual({
+    await expect(readFile()).resolves.toEqual({
       key1: {message: 'key1 message'},
       key2: {message: 'key2 message'},
       key3: {message: 'key3 message'},
@@ -182,7 +182,7 @@ describe('writeTranslationFileContent', () => {
       },
     });
 
-    expect(await readFile()).toEqual({
+    await expect(readFile()).resolves.toEqual({
       key1: {message: 'key1 message'},
       key2: {message: 'PREFIX key2 message new'},
     });
@@ -204,7 +204,7 @@ describe('writeTranslationFileContent', () => {
       },
     });
 
-    expect(await readFile()).toEqual({
+    await expect(readFile()).resolves.toEqual({
       key1: {message: 'key1 message new'},
       key2: {message: 'key2 message new'},
     });
@@ -227,7 +227,7 @@ describe('writeTranslationFileContent', () => {
       },
     });
 
-    expect(await readFile()).toEqual({
+    await expect(readFile()).resolves.toEqual({
       key1: {message: 'PREFIX key1 message new'},
       key2: {message: 'PREFIX key2 message new'},
     });
@@ -249,14 +249,14 @@ describe('writeTranslationFileContent', () => {
       },
     });
 
-    expect(await readFile()).toEqual({
+    await expect(readFile()).resolves.toEqual({
       key1: {message: 'key1 message', description: undefined},
       key2: {message: 'key2 message', description: 'key2 desc new'},
       key3: {message: 'key3 message', description: 'key3 desc new'},
     });
   });
 
-  test('should always override message description', async () => {
+  test('should throw for invalid content', async () => {
     const {filePath} = await createTmpTranslationFile(
       // @ts-expect-error: bad content on purpose
       {bad: 'content'},
@@ -305,7 +305,7 @@ describe('writePluginTranslations', () => {
       },
     });
 
-    expect(await readTranslationFileContent(filePath)).toEqual({
+    await expect(readTranslationFileContent(filePath)).resolves.toEqual({
       key1: {message: 'key1 message'},
       key2: {message: 'key2 message'},
       key3: {message: 'key3 message'},
@@ -345,14 +345,16 @@ describe('writePluginTranslations', () => {
       });
     }
 
-    expect(await readTranslationFileContent(filePath)).toEqual(undefined);
+    await expect(readTranslationFileContent(filePath)).resolves.toEqual(
+      undefined,
+    );
 
     await doWritePluginTranslations({
       key1: {message: 'key1 message', description: 'key1 desc'},
       key2: {message: 'key2 message', description: 'key2 desc'},
       key3: {message: 'key3 message', description: 'key3 desc'},
     });
-    expect(await readTranslationFileContent(filePath)).toEqual({
+    await expect(readTranslationFileContent(filePath)).resolves.toEqual({
       key1: {message: 'key1 message', description: 'key1 desc'},
       key2: {message: 'key2 message', description: 'key2 desc'},
       key3: {message: 'key3 message', description: 'key3 desc'},
@@ -365,7 +367,7 @@ describe('writePluginTranslations', () => {
       },
       {messagePrefix: 'PREFIX '},
     );
-    expect(await readTranslationFileContent(filePath)).toEqual({
+    await expect(readTranslationFileContent(filePath)).resolves.toEqual({
       key1: {message: 'key1 message', description: 'key1 desc'},
       key2: {message: 'key2 message', description: 'key2 desc'},
       key3: {message: 'key3 message', description: undefined},
@@ -381,7 +383,7 @@ describe('writePluginTranslations', () => {
       },
       {messagePrefix: 'PREFIX ', override: true},
     );
-    expect(await readTranslationFileContent(filePath)).toEqual({
+    await expect(readTranslationFileContent(filePath)).resolves.toEqual({
       key1: {message: 'PREFIX key1 message 3', description: 'key1 desc'},
       key2: {message: 'PREFIX key2 message 3', description: 'key2 desc'},
       key3: {message: 'PREFIX key3 message 3', description: 'key3 desc'},
@@ -417,7 +419,7 @@ describe('localizePluginTranslationFile', () => {
     expect(localizedTranslationFile).toEqual(translationFile);
   });
 
-  test('not localize if localized file does not exist', async () => {
+  test('not localize if localized file does not exist 2', async () => {
     const siteDir = await createTmpSiteDir();
 
     await writeTranslationFileContent({

packages/stylelint-copyright/__tests__/index.test.js

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/* eslint-disable jest/no-conditional-expect */
 
 const stylelint = require('stylelint');
 const path = require('path');
@@ -24,28 +25,21 @@ function testStylelintRule(config, tests) {
     if (tests.accept && tests.accept.length) {
       describe('accept cases', () => {
         tests.accept.forEach((testCase) => {
-          const spec = testCase.only ? it.only : it;
+          test(checkTestCaseContent(testCase), async () => {
-
-          spec(checkTestCaseContent(testCase), () => {
             const options = {
               code: testCase.code,
               config,
               syntax: tests.syntax,
             };
 
-            return stylelint.lint(options).then((output) => {
+            const output = await stylelint.lint(options);
-              expect(output.results[0].warnings).toEqual([]);
+            expect(output.results[0].warnings).toEqual([]);
-
+            if (!tests.fix) {
-              if (!tests.fix) {
+              return;
-                return null;
+            }
-              }
+            const fixedOutput = await stylelint.lint({...options, fix: true});
-
+            const fixedCode = getOutputCss(fixedOutput);
-              // Check the fix.
+            expect(fixedCode).toBe(testCase.fixed);
-              return stylelint
-                .lint({...options, fix: true})
-                .then((fixedOutput) => getOutputCss(fixedOutput))
-                .then((fixedCode) => expect(fixedCode).toBe(testCase.fixed));
-            });
           });
         });
       });
@@ -54,51 +48,38 @@ function testStylelintRule(config, tests) {
     if (tests.reject && tests.reject.length) {
       describe('reject cases', () => {
         tests.reject.forEach((testCase) => {
-          const skip = testCase.skip ? it.skip : it;
+          test(checkTestCaseContent(testCase), async () => {
-          const spec = testCase.only ? it.only : skip;
-
-          spec(checkTestCaseContent(testCase), () => {
             const options = {
               code: testCase.code,
               config,
               syntax: tests.syntax,
             };
 
-            return stylelint.lint(options).then((output) => {
+            const output = await stylelint.lint(options);
-              const {warnings} = output.results[0];
+            const {warnings} = output.results[0];
-              const warning = warnings[0];
+            const warning = warnings[0];
-
+            expect(warnings.length).toBeGreaterThanOrEqual(1);
-              expect(warnings.length).toBeGreaterThanOrEqual(1);
+            expect(testCase).toHaveMessage();
-              expect(testCase).toHaveMessage();
+            if (testCase.message != null) {
-
+              expect(warning.text).toBe(testCase.message);
-              if (testCase.message != null) {
+            }
-                expect(warning.text).toBe(testCase.message);
+            if (testCase.line != null) {
-              }
+              expect(warning.line).toBe(testCase.line);
-
+            }
-              if (testCase.line != null) {
+            if (testCase.column != null) {
-                expect(warning.line).toBe(testCase.line);
+              expect(warning.column).toBe(testCase.column);
-              }
+            }
-
+            if (!tests.fix) {
-              if (testCase.column != null) {
+              return;
-                expect(warning.column).toBe(testCase.column);
+            }
-              }
+            if (!testCase.fixed) {
-
+              throw new Error(
-              if (!tests.fix) {
+                'If using { fix: true } in test tests, all reject cases must have { fixed: .. }',
-                return null;
+              );
-              }
+            }
-
+            const fixedOutput = await stylelint.lint({...options, fix: true});
-              if (!testCase.fixed) {
+            const fixedCode = getOutputCss(fixedOutput);
-                throw new Error(
+            expect(fixedCode).toBe(testCase.fixed);
-                  'If using { fix: true } in test tests, all reject cases must have { fixed: .. }',
-                );
-              }
-
-              // Check the fix.
-              return stylelint
-                .lint({...options, fix: true})
-                .then((fixedOutput) => getOutputCss(fixedOutput))
-                .then((fixedCode) => expect(fixedCode).toBe(testCase.fixed));
-            });
           });
         });
       });

yarn.lock

@@ -4165,7 +4165,7 @@
     semver "^7.3.5"
     tsutils "^3.21.0"
 
-"@typescript-eslint/experimental-utils@5.9.1":
+"@typescript-eslint/experimental-utils@5.9.1", "@typescript-eslint/experimental-utils@^5.0.0":
   version "5.9.1"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/experimental-utils/-/experimental-utils-5.9.1.tgz#8c407c4dd5ffe522329df6e4c9c2b52206d5f7f1"
   integrity sha512-cb1Njyss0mLL9kLXgS/eEY53SZQ9sT519wpX3i+U457l2UXRDuo87hgKfgRazmu9/tQb0x2sr3Y0yrU+Zz0y+w==
@@ -8086,6 +8086,13 @@ eslint-plugin-import@^2.25.3:
     resolve "^1.20.0"
     tsconfig-paths "^3.12.0"
 
+eslint-plugin-jest@^25.7.0:
+  version "25.7.0"
+  resolved "https://registry.yarnpkg.com/eslint-plugin-jest/-/eslint-plugin-jest-25.7.0.tgz#ff4ac97520b53a96187bad9c9814e7d00de09a6a"
+  integrity sha512-PWLUEXeeF7C9QGKqvdSbzLOiLTx+bno7/HC9eefePfEb257QFHg7ye3dh80AZVkaa/RQsBB1Q/ORQvg2X7F0NQ==
+  dependencies:
+    "@typescript-eslint/experimental-utils" "^5.0.0"
+
 eslint-plugin-jsx-a11y@^6.5.1:
   version "6.5.1"
   resolved "https://registry.yarnpkg.com/eslint-plugin-jsx-a11y/-/eslint-plugin-jsx-a11y-6.5.1.tgz#cdbf2df901040ca140b6ec14715c988889c2a6d8"