chore: switch to tinyglobby

packages/docusaurus-babel/src/__tests__/babelTranslationsExtractor.test.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {describe, expect, it, vi} from 'vitest';
+import {describe, expect, it} from 'vitest';
 import fs from 'fs-extra';
 import {mkdtempDisposable, realpath} from 'node:fs/promises';
 import {tmpdir} from 'node:os';
@@ -53,16 +53,10 @@ const default => {
 `,
     });
 
-    using error = vi.spyOn(console, 'error');
-
     await expect(
       extractSourceCodeFileTranslations(sourceCodeFile.path, TestBabelOptions),
-    ).rejects.toThrow();
-
-    expect(error).toHaveBeenCalledWith(
-      expect.stringMatching(
-        /Error while attempting to extract Docusaurus translations from source code file at/,
-      ),
+    ).rejects.toThrow(
+      /Error while attempting to extract Docusaurus translations from source code file at/,
     );
   });
 

packages/docusaurus-babel/src/babelTranslationsExtractor.ts

@@ -6,7 +6,6 @@
  */
 
 import fs from 'fs-extra';
-import logger from '@docusaurus/logger';
 import traverse, {type Node} from '@babel/traverse';
 import generate from '@babel/generator';
 import {
@@ -15,6 +14,7 @@ import {
   type NodePath,
   type TransformOptions,
 } from '@babel/core';
+import {logger} from '@docusaurus/logger';
 import type {TranslationFileContent} from '@docusaurus/types';
 
 export type SourceCodeFileTranslations = {
@@ -56,8 +56,10 @@ export async function extractSourceCodeFileTranslations(
     );
     return translations;
   } catch (err) {
-    logger.error`Error while attempting to extract Docusaurus translations from source code file at path=${sourceCodeFilePath}.`;
-    throw err;
+    throw new Error(
+      logger.interpolate`Error while attempting to extract Docusaurus translations from source code file at path=${sourceCodeFilePath}.`,
+      {cause: err},
+    );
   }
 }
 

packages/docusaurus-theme-translations/src/__tests__/utils.test.ts

@@ -14,12 +14,11 @@ describe('extractThemeCodeMessages', () => {
     await expect(() =>
       extractThemeCodeMessages([path.join(__dirname, '__fixtures__/theme')]),
     ).rejects.toThrowErrorMatchingInlineSnapshot(`
-      [Error: 
-      Please make sure all theme translations are static!
+      [Error: Please make sure all theme translations are static!
       Some warnings were found!
 
       Translate content could not be extracted. It has to be a static string and use optional but static props, like <Translate id="my-id" description="my-description">text</Translate>.
-      File: packages/docusaurus-theme-translations/src/__tests__/__fixtures__/theme/index.js at line 5
+      File: <PROJECT_ROOT>/packages/docusaurus-theme-translations/src/__tests__/__fixtures__/theme/index.js at line 5
       Full code: <Translate>{index}</Translate>
       ]
     `);

packages/docusaurus-theme-translations/src/utils.ts

@@ -72,8 +72,7 @@ export async function extractThemeCodeMessages(
 
   filesExtractedTranslations.forEach((fileExtractedTranslations) => {
     if (fileExtractedTranslations.warnings.length > 0) {
-      throw new Error(`
-Please make sure all theme translations are static!
+      throw new Error(`Please make sure all theme translations are static!
 Some warnings were found!
 
 ${fileExtractedTranslations.warnings.join('\n\n')}

packages/docusaurus-utils/package.json

@@ -25,7 +25,6 @@
     "file-loader": "^6.2.0",
     "fs-extra": "^11.2.0",
     "github-slugger": "^2.0.0",
-    "globby": "^11.1.0",
     "gray-matter": "^4.0.3",
     "jiti": "^2.7.0",
     "js-yaml": "^4.1.0",
@@ -34,6 +33,7 @@
     "p-queue": "^6.6.2",
     "prompts": "^2.4.2",
     "resolve-pathname": "^3.0.0",
+    "tinyglobby": "^0.2.15",
     "tslib": "^2.6.0",
     "url-loader": "^4.1.1",
     "utility-types": "^3.10.0",

packages/docusaurus-utils/src/globUtils.ts

@@ -10,11 +10,15 @@
 import path from 'path';
 import Micromatch from 'micromatch'; // Note: Micromatch is used by Globby
 import {addSuffix} from '@docusaurus/utils-common';
-import Globby from 'globby';
+import * as Tinyglobby from 'tinyglobby';
 import {posixPath} from './pathUtils';
 
+type GlobOptions = Tinyglobby.GlobOptions;
+
+// TODO Docusaurus v4 refactor, hide lib behind home-made abstraction
+// See https://github.com/facebook/docusaurus/pull/11042
 /** A re-export of the globby instance. */
-export {Globby};
+export const Globby = Tinyglobby.glob;
 
 /**
  * The default glob patterns we ignore when sourcing content.
@@ -93,7 +97,7 @@ export function createAbsoluteFilePathMatcher(
 // See https://github.com/facebook/docusaurus/pull/4222#issuecomment-795517329
 export async function safeGlobby(
   patterns: string[],
-  options?: Globby.GlobbyOptions,
+  options?: GlobOptions,
 ): Promise<string[]> {
   // Required for Windows support, as paths using \ should not be used by globby
   // (also using the windows hard drive prefix like c: is not a good idea)
@@ -132,6 +136,8 @@ export const isTranslatableSourceFile: (filePath: string) => boolean = (() => {
 export async function globTranslatableSourceFiles(
   patterns: string[],
 ): Promise<string[]> {
-  const filePaths = await safeGlobby(patterns);
+  const filePaths = await safeGlobby(patterns, {
+    absolute: true,
+  });
   return filePaths.filter(isTranslatableSourceFile);
 }

packages/docusaurus/src/commands/swizzle/actions.ts

@@ -62,6 +62,12 @@ export async function eject({
   const globPatternPosix = posixPath(globPattern);
 
   const filesToCopy = await Globby(globPatternPosix, {
+    // Workaround for Tinyglobby bug?
+    // We glob absolute from the theme root path, not from cwd
+    // See https://github.com/SuperchupuDev/tinyglobby/issues/186
+    cwd: themePath,
+    absolute: true,
+
     ignore: _.compact([
       '**/*.{story,stories,test,tests}.{js,jsx,ts,tsx}',
       // When ejecting JS components, we want to avoid emitting TS files

packages/docusaurus/src/commands/writeHeadingIds.ts

@@ -89,9 +89,11 @@ export async function writeHeadingIds(
 
   const patterns = files.length ? files : await getPathsToWatch(siteDir);
 
-  const markdownFiles = await safeGlobby(patterns, {
-    expandDirectories: ['**/*.{md,mdx}'],
-  });
+  const markdownFiles = (
+    await safeGlobby(patterns, {
+      expandDirectories: true,
+    })
+  ).filter((file) => file.endsWith('.md') || file.endsWith('.mdx'));
 
   if (markdownFiles.length === 0) {
     logger.warn`No markdown files found in siteDir path=${siteDir} for patterns: ${patterns}`;

test/snapshotPathNormalizer.ts

@@ -15,6 +15,7 @@ import fs from 'fs';
 import _ from 'lodash';
 import stripAnsi from 'strip-ansi';
 import {version} from '../packages/docusaurus/package.json';
+import {posixPath} from '../packages/docusaurus-utils/src';
 
 /*
 This weird thing is to normalize paths on our Windows GitHub Actions runners
@@ -41,8 +42,6 @@ function readPathsForNormalization() {
   const cwd = process.cwd();
   const cwdEscaped = escapePath(cwd);
 
-  console.log({cwd, cwdEscaped});
-
   const tempDir = os.tmpdir();
   const homeDir = os.homedir();
 
@@ -92,6 +91,7 @@ function normalizeString(value: string): string {
     (val) => (val.includes('keepAnsi') ? val : stripAnsi(val)),
     // Replace process.cwd with <PROJECT_ROOT>
     (val) => val.split(cwd).join('<PROJECT_ROOT>'),
+    (val) => val.split(posixPath(cwd)).join('<PROJECT_ROOT>'),
     // In case the CWD is escaped
     (val) => val.split(cwdEscaped).join('<PROJECT_ROOT>'),
 

website/_dogfooding/testSwizzleThemeClassic.mjs

@@ -80,6 +80,7 @@ async function getAllComponentNames() {
 }
 
 const componentNames = await getAllComponentNames();
+console.log('componentNames', componentNames);
 
 const componentsNotFound = Object.keys(swizzleConfig.components).filter(
   (componentName) => !componentNames.includes(componentName),