3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-29 14:38:50 +02:00
Code Issues Projects Releases Packages Wiki Activity

add tests

Browse source
This commit is contained in:
ozakione 2024-04-03 14:59:26 +02:00
parent 8ab6ddac54
commit 45af11fd13
5 changed files with 113 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

55
packages/docusaurus-plugin-content-showcase/src/index.ts
View file

@ -8,7 +8,6 @@
import fs from 'fs-extra';
import path from 'path';
import {
aliasedSitePathToRelativePath,
getFolderContainingFile,
getPluginI18nPath,
Globby,
@ -42,31 +41,6 @@ function createTagSchema(tags: string[]): Joi.Schema {
);
}
async function getTagsList(filePath: string | TagOption[]): Promise<string[]> {
if (typeof filePath === 'object') {
return Object.keys(filePath);
}
const rawYaml = await fs.readFile(
// todo should we use aliasedPath ?
// because it breaks tests showcase/index.test.ts#L27-L28
aliasedSitePathToRelativePath(filePath),
'utf-8',
);
const unsafeYaml = Yaml.load(rawYaml);
const safeYaml = tagSchema.validate(unsafeYaml);
if (safeYaml.error) {
throw new Error(
`There was an error extracting tags: ${safeYaml.error.message}`,
{cause: safeYaml.error},
);
}
const tagLabels = Object.keys(safeYaml.value);
return tagLabels;
}
export default function pluginContentShowcase(
context: LoadContext,
options: PluginOptions,
@ -82,6 +56,34 @@ export default function pluginContentShowcase(
}),
};
async function getTagsList(
configTags: string | TagOption[],
): Promise<string[]> {
if (typeof configTags === 'object') {
return Object.keys(configTags);
}
const tagsPath = path.resolve(contentPaths.contentPath, configTags);
try {
const rawYaml = await fs.readFile(tagsPath, 'utf-8');
const unsafeYaml = Yaml.load(rawYaml);
const safeYaml = tagSchema.validate(unsafeYaml);
if (safeYaml.error) {
throw new Error(
`There was an error extracting tags: ${safeYaml.error.message}`,
{cause: safeYaml.error},
);
}
const tagLabels = Object.keys(safeYaml.value);
return tagLabels;
} catch (error) {
throw new Error(`Failed to read tags file for showcase`, {cause: error});
}
}
return {
name: 'docusaurus-plugin-content-showcase',
@ -97,7 +99,6 @@ export default function pluginContentShowcase(
if (!(await fs.pathExists(contentPaths.contentPath))) {
return null;
}
console.log('contentPaths:', contentPaths);
const {include} = options;