3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-10 15:47:23 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor: fix a few places of path handling (#7023)

Browse source
This commit is contained in:
Joshua Chen 2022-03-26 22:49:50 +08:00 • committed by GitHub
parent e6838dd7a6
commit 4957ec947b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 9 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

6
packages/docusaurus-plugin-content-blog/src/feed.ts
View file

@ -9,7 +9,6 @@ import {Feed, type Author as FeedAuthor, type Item as FeedItem} from 'feed';
import type {BlogPost} from './types';
import {
normalizeUrl,
posixPath,
mapAsyncSequential,
readOutputHTMLFile,
} from '@docusaurus/utils';
@ -128,10 +127,7 @@ async function createBlogFeedFile({
}
})();
try {
await fs.outputFile(
posixPath(path.join(generatePath, feedPath)),
feedContent,
);
await fs.outputFile(path.join(generatePath, feedPath), feedContent);
} catch (err) {
throw new Error(`Generating ${feedType} feed failed: ${err}.`);
}

2
packages/docusaurus-plugin-content-docs/src/__tests__/cli.test.ts
View file

@ -181,7 +181,7 @@ describe('docsVersion', () => {
DEFAULT_OPTIONS,
),
).rejects.toThrowErrorMatchingInlineSnapshot(
`"[docs]: there is no docs to version!"`,
`"[docs]: no docs found in <PROJECT_ROOT>/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/empty-site/docs."`,
);
});

4
packages/docusaurus-plugin-content-docs/src/cli.ts
View file

@ -117,7 +117,7 @@ export async function cliDocsVersionCommand(
const {path: docsPath, sidebarPath} = options;
// Copy docs files.
const docsDir = path.join(siteDir, docsPath);
const docsDir = path.resolve(siteDir, docsPath);
if (
(await fs.pathExists(docsDir)) &&
@ -127,7 +127,7 @@ export async function cliDocsVersionCommand(
const newVersionDir = path.join(versionedDir, `version-${version}`);
await fs.copy(docsDir, newVersionDir);
} else {
throw new Error(`${pluginIdLogPrefix}: there is no docs to version!`);
throw new Error(`${pluginIdLogPrefix}: no docs found in ${docsDir}.`);
}
await createVersionedSidebarFile({

4
packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts
View file

@ -14,7 +14,7 @@ import type {
SidebarItemCategoryLinkConfig,
} from './types';
import _ from 'lodash';
import {addTrailingSlash, posixPath} from '@docusaurus/utils';
import {addTrailingSlash} from '@docusaurus/utils';
import logger from '@docusaurus/logger';
import path from 'path';
import {createDocsByIdIndex, toCategoryIndexMatcherParam} from '../docs';
@ -157,7 +157,7 @@ Available doc IDs:
folderName: string,
): WithPosition<NormalizedSidebarItemCategory> {
const categoryMetadata =
categoriesMetadata[posixPath(path.join(autogenDir, fullPath))];
categoriesMetadata[path.posix.join(autogenDir, fullPath)];
const allItems = Object.entries(dir).map(([key, content]) =>
dirToItem(content, key, `${fullPath}/${key}`),
);

2
packages/docusaurus-utils/src/dataFileUtils.ts
View file

@ -37,7 +37,7 @@ export async function getDataFilePath({
filePath,
);
if (contentPath) {
return path.join(contentPath, filePath);
return path.resolve(contentPath, filePath);
}
return undefined;
}

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

@ -18,9 +18,7 @@ export default async function serve(
siteDir: string,
cliOptions: ServeCLIOptions,
): Promise<void> {
let dir = path.isAbsolute(cliOptions.dir)
? cliOptions.dir
: path.join(siteDir, cliOptions.dir);
let dir = path.resolve(siteDir, cliOptions.dir);
if (cliOptions.build) {
dir = await build(

2
packages/docusaurus/src/server/translations/translations.ts
View file

@ -145,7 +145,7 @@ Maybe you should remove them? ${unknownKeys}`;
// should we make this configurable?
function getTranslationsDirPath(context: TranslationContext): string {
return path.resolve(path.join(context.siteDir, I18N_DIR_NAME));
return path.join(context.siteDir, I18N_DIR_NAME);
}
export function getTranslationsLocaleDirPath(
context: TranslationContext,