3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-06 10:20:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(v2): Fix writeHeadingIds on Windows due to non-posix paths (#4444)

Browse source
This commit is contained in:
Sébastien Lorber 2021-03-16 20:22:35 +01:00 • committed by GitHub
parent 66e621dca9
commit d5cad5bf1f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

4
packages/docusaurus/src/commands/writeHeadingIds.ts
View file

@ -5,7 +5,6 @@
* LICENSE file in the root directory of this source tree. * LICENSE file in the root directory of this source tree.
*/ */
import globby from 'globby';
import fs from 'fs-extra'; import fs from 'fs-extra';
import GithubSlugger from 'github-slugger'; import GithubSlugger from 'github-slugger';
import chalk from 'chalk'; import chalk from 'chalk';
@ -14,6 +13,7 @@ import initPlugins from '../server/plugins/init';
import {flatten} from 'lodash'; import {flatten} from 'lodash';
import {parseMarkdownHeadingId} from '@docusaurus/utils'; import {parseMarkdownHeadingId} from '@docusaurus/utils';
import {safeGlobby} from '../server/utils';
export function unwrapMarkdownLinks(line: string): string { export function unwrapMarkdownLinks(line: string): string {
return line.replace(/\[([^\]]+)\]\([^)]+\)/g, (match, p1) => p1); return line.replace(/\[([^\]]+)\]\([^)]+\)/g, (match, p1) => p1);
@ -107,7 +107,7 @@ async function getPathsToWatch(siteDir: string): Promise<string[]> {
} }
export default async function writeHeadingIds(siteDir: string): Promise<void> { export default async function writeHeadingIds(siteDir: string): Promise<void> {
const markdownFiles = await globby(await getPathsToWatch(siteDir), { const markdownFiles = await safeGlobby(await getPathsToWatch(siteDir), {
expandDirectories: ['**/*.{md,mdx}'], expandDirectories: ['**/*.{md,mdx}'],
}); });

11
packages/docusaurus/src/server/translations/translationsExtractor.ts
View file

@ -11,11 +11,10 @@ import chalk from 'chalk';
import {parse, types as t, NodePath, TransformOptions} from '@babel/core'; import {parse, types as t, NodePath, TransformOptions} from '@babel/core';
import {flatten} from 'lodash'; import {flatten} from 'lodash';
import {TranslationFileContent, TranslationMessage} from '@docusaurus/types'; import {TranslationFileContent, TranslationMessage} from '@docusaurus/types';
import globby from 'globby';
import nodePath from 'path'; import nodePath from 'path';
import {InitPlugin} from '../plugins/init'; import {InitPlugin} from '../plugins/init';
import {posixPath} from '@docusaurus/utils';
import {SRC_DIR_NAME} from '../../constants'; import {SRC_DIR_NAME} from '../../constants';
import {safeGlobby} from '../utils';
// We only support extracting source code translations from these kind of files // We only support extracting source code translations from these kind of files
const TranslatableSourceCodeExtension = new Set([ const TranslatableSourceCodeExtension = new Set([
@ -54,13 +53,7 @@ function getPluginSourceCodeFilePaths(plugin: InitPlugin): string[] {
export async function globSourceCodeFilePaths( export async function globSourceCodeFilePaths(
dirPaths: string[], dirPaths: string[],
): Promise<string[]> { ): Promise<string[]> {
// Required for Windows support, as paths using \ should not be used by globby const filePaths = await safeGlobby(dirPaths);
// (also using the windows hard drive prefix like c: is not a good idea)
const globPaths = dirPaths.map((dirPath) =>
posixPath(nodePath.relative(process.cwd(), dirPath)),
);
const filePaths = await globby(globPaths);
return filePaths.filter(isTranslatableSourceCodePath); return filePaths.filter(isTranslatableSourceCodePath);
} }

18
packages/docusaurus/src/server/utils.ts
View file

@ -6,6 +6,9 @@
*/ */
import {flatMap} from 'lodash'; import {flatMap} from 'lodash';
import {RouteConfig} from '@docusaurus/types'; import {RouteConfig} from '@docusaurus/types';
import globby from 'globby';
import nodePath from 'path';
import {posixPath} from '@docusaurus/utils';
// Recursively get the final routes (routes with no subroutes) // Recursively get the final routes (routes with no subroutes)
export function getAllFinalRoutes(routeConfig: RouteConfig[]): RouteConfig[] { export function getAllFinalRoutes(routeConfig: RouteConfig[]): RouteConfig[] {
@ -14,3 +17,18 @@ export function getAllFinalRoutes(routeConfig: RouteConfig[]): RouteConfig[] {
} }
return flatMap(routeConfig, getFinalRoutes); return flatMap(routeConfig, getFinalRoutes);
} }
// Globby that fix Windows path patterns
// See https://github.com/facebook/docusaurus/pull/4222#issuecomment-795517329
export async function safeGlobby(
patterns: string[],
options?: globby.GlobbyOptions,
) {
// 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)
const globPaths = patterns.map((dirPath) =>
posixPath(nodePath.relative(process.cwd(), dirPath)),
);
return globby(globPaths, options);
}