fix(docs): suppress error on multiple occurrences

facebook · Mar 23, 2022 · 4664856 · 4664856
1 parent 4103fef
commit 4664856
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 12 deletions.
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/temp/.gitignore b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/temp/.gitignore
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/lastUpdate.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/lastUpdate.test.ts
@@ -69,7 +69,12 @@ describe('getFileLastUpdate', () => {
     const consoleMock = jest
       .spyOn(console, 'warn')
       .mockImplementation(() => {});
-    const tempFilePath = path.join(__dirname, '__fixtures__', '.temp');
+    const tempFilePath = path.join(
+      __dirname,
+      '__fixtures__',
+      'temp',
+      'file.md',
+    );
     await fs.writeFile(tempFilePath, 'Lorem ipsum :)');
     await expect(getFileLastUpdate(tempFilePath)).resolves.toBeNull();
     expect(consoleMock).toHaveBeenCalledTimes(1);
@@ -79,6 +84,34 @@ describe('getFileLastUpdate', () => {
     await fs.unlink(tempFilePath);
   });
 
+  it('multiple files not tracked by git', async () => {
+    const consoleMock = jest
+      .spyOn(console, 'warn')
+      .mockImplementation(() => {});
+    const tempFilePath1 = path.join(
+      __dirname,
+      '__fixtures__',
+      'temp',
+      'file1.md',
+    );
+    const tempFilePath2 = path.join(
+      __dirname,
+      '__fixtures__',
+      'temp',
+      'file2.md',
+    );
+    await fs.writeFile(tempFilePath1, 'Lorem ipsum :)');
+    await fs.writeFile(tempFilePath2, 'Lorem ipsum :)');
+    await expect(getFileLastUpdate(tempFilePath1)).resolves.toBeNull();
+    await expect(getFileLastUpdate(tempFilePath2)).resolves.toBeNull();
+    expect(consoleMock).toHaveBeenCalledTimes(1);
+    expect(consoleMock).toHaveBeenLastCalledWith(
+      expect.stringMatching(/not tracked by git./),
+    );
+    await fs.unlink(tempFilePath1);
+    await fs.unlink(tempFilePath2);
+  });
+
   it('git does not exist', async () => {
     const mock = jest.spyOn(shell, 'which').mockImplementationOnce(() => null);
     const consoleMock = jest

diff --git a/packages/docusaurus-plugin-content-docs/src/lastUpdate.ts b/packages/docusaurus-plugin-content-docs/src/lastUpdate.ts
@@ -31,17 +31,18 @@ export async function getFileLastUpdate(
     });
     return {timestamp: result.timestamp, author: result.author};
   } catch (err) {
-    if (err instanceof GitNotFoundError && !showedGitRequirementError) {
-      logger.warn('Sorry, the docs plugin last update options require Git.');
-      showedGitRequirementError = true;
-    } else if (
-      err instanceof FileNotTrackedError &&
-      !showedFileNotTrackedError
-    ) {
-      logger.warn(
-        'Cannot infer the update date for some files, as they are not tracked by git.',
-      );
-      showedFileNotTrackedError = true;
+    if (err instanceof GitNotFoundError) {
+      if (!showedGitRequirementError) {
+        logger.warn('Sorry, the docs plugin last update options require Git.');
+        showedGitRequirementError = true;
+      }
+    } else if (err instanceof FileNotTrackedError) {
+      if (!showedFileNotTrackedError) {
+        logger.warn(
+          'Cannot infer the update date for some files, as they are not tracked by git.',
+        );
+        showedFileNotTrackedError = true;
+      }
     } else {
       logger.warn(err);
     }