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

feat(blog): authors page (#10216)

Browse source 
Co-authored-by: OzakIOne <OzakIOne@users.noreply.github.com>
Co-authored-by: sebastien <lorber.sebastien@gmail.com>
Co-authored-by: slorber <slorber@users.noreply.github.com>
This commit is contained in:
ozaki 2024-08-01 17:30:49 +02:00 • committed by GitHub
parent 50f9fce29b
commit f356e29938
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
56 changed files with 1670 additions and 706 deletions
Download patch file Download diff file Expand all files Collapse all files

1
packages/docusaurus-utils/src/__tests__/__fixtures__/dataFiles/actualData/bad.json generated
View file

@ -1 +0,0 @@
{"a": 2}

1
packages/docusaurus-utils/src/__tests__/__fixtures__/dataFiles/actualData/bad.yml generated
View file

@ -1 +0,0 @@
a: 2

1
packages/docusaurus-utils/src/__tests__/__fixtures__/dataFiles/actualData/valid.json generated
View file

@ -1 +0,0 @@
{"a": 1}

1
packages/docusaurus-utils/src/__tests__/__fixtures__/dataFiles/actualData/valid.yml generated
View file

@ -1 +0,0 @@
a: 1

1
packages/docusaurus-utils/src/__tests__/__fixtures__/dataFiles/dataFiles/dataFile.json generated Normal file
View file

@ -0,0 +1 @@
{"content": "json"}

1
packages/docusaurus-utils/src/__tests__/__fixtures__/dataFiles/dataFiles/dataFile.yml generated Normal file
View file

@ -0,0 +1 @@
content: original yaml

1
packages/docusaurus-utils/src/__tests__/__fixtures__/dataFiles/dataFiles/invalid.yml generated Normal file
View file

@ -0,0 +1 @@
}{{{{12434665¨£%£%%£%£}}}}

1
packages/docusaurus-utils/src/__tests__/__fixtures__/dataFiles/dataFiles/localized/dataFile.yml generated Normal file
View file

@ -0,0 +1 @@
content: localized yaml

52
packages/docusaurus-utils/src/__tests__/dataFileUtils.test.ts
View file

@ -10,7 +10,7 @@ import {
findFolderContainingFile,
getFolderContainingFile,
getDataFilePath,
getDataFileData,
readDataFile,
} from '../dataFileUtils';
describe('getDataFilePath', () => {
@ -125,46 +125,40 @@ describe('getDataFilePath', () => {
});
describe('getDataFileData', () => {
const fixturesDir = path.join(__dirname, '__fixtures__/dataFiles/actualData');
function readDataFile(filePath: string) {
return getDataFileData(
{
filePath,
contentPaths: {contentPath: fixturesDir, contentPathLocalized: ''},
fileType: 'test',
},
(content) => {
// @ts-expect-error: good enough
if (content.a !== 1) {
throw new Error('Nope');
}
return content;
},
function testFile(filePath: string) {
const contentPath = path.join(
__dirname,
'__fixtures__/dataFiles/dataFiles',
);
const contentPathLocalized = path.join(contentPath, 'localized');
return readDataFile({
filePath,
contentPaths: {contentPath, contentPathLocalized},
});
}
it('returns undefined for nonexistent file', async () => {
await expect(readDataFile('nonexistent.yml')).resolves.toBeUndefined();
});
it('read valid yml author file', async () => {
await expect(readDataFile('valid.yml')).resolves.toEqual({a: 1});
await expect(testFile('nonexistent.yml')).resolves.toBeUndefined();
});
it('read valid json author file', async () => {
await expect(readDataFile('valid.json')).resolves.toEqual({a: 1});
await expect(testFile('dataFile.json')).resolves.toEqual({
content: 'json',
});
});
it('fail to read invalid yml', async () => {
await expect(
readDataFile('bad.yml'),
).rejects.toThrowErrorMatchingInlineSnapshot(`"Nope"`);
it('read valid yml author file using localized source in priority', async () => {
await expect(testFile('dataFile.yml')).resolves.toEqual({
content: 'localized yaml',
});
});
it('fail to read invalid json', async () => {
it('throw for invalid file', async () => {
await expect(
readDataFile('bad.json'),
).rejects.toThrowErrorMatchingInlineSnapshot(`"Nope"`);
testFile('invalid.yml'),
).rejects.toThrowErrorMatchingInlineSnapshot(
`"The file at "packages/docusaurus-utils/src/__tests__/__fixtures__/dataFiles/dataFiles/invalid.yml" looks invalid (not Yaml nor JSON)."`,
);
});
});