mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-03 04:07:32 +02:00
2f53b1a895
* refactor(v2): merge linkify function used in blog and docs * refactor(v2): rename docsDirPath and docsDirPathLocalized ad update types * refactor(v2): rename blogPostsBySource and update types * improve replaceMarkdownLinks api Co-authored-by: slorber <lorber.sebastien@gmail.com>
93 lines
3 KiB
TypeScript
93 lines
3 KiB
TypeScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
import fs from 'fs-extra';
|
|
import path from 'path';
|
|
import {linkify, LinkifyParams, getSourceToPermalink} from '../blogUtils';
|
|
import {BlogBrokenMarkdownLink, BlogContentPaths, BlogPost} from '../types';
|
|
|
|
const siteDir = path.join(__dirname, '__fixtures__', 'website');
|
|
const contentPaths: BlogContentPaths = {
|
|
contentPath: path.join(siteDir, 'blog-with-ref'),
|
|
contentPathLocalized: path.join(siteDir, 'blog-with-ref-localized'),
|
|
};
|
|
const pluginDir = 'blog-with-ref';
|
|
const blogPosts: BlogPost[] = [
|
|
{
|
|
id: 'Happy 1st Birthday Slash!',
|
|
metadata: {
|
|
permalink: '/blog/2018/12/14/Happy-First-Birthday-Slash',
|
|
source: path.posix.join(
|
|
'@site',
|
|
pluginDir,
|
|
'2018-12-14-Happy-First-Birthday-Slash.md',
|
|
),
|
|
title: 'Happy 1st Birthday Slash!',
|
|
description: `pattern name`,
|
|
date: new Date('2018-12-14'),
|
|
tags: [],
|
|
prevItem: {
|
|
permalink: '/blog/2019/01/01/date-matter',
|
|
title: 'date-matter',
|
|
},
|
|
truncated: false,
|
|
},
|
|
},
|
|
];
|
|
|
|
const transform = (filePath: string, options?: Partial<LinkifyParams>) => {
|
|
const fileContent = fs.readFileSync(filePath, 'utf-8');
|
|
const transformedContent = linkify({
|
|
filePath,
|
|
fileString: fileContent,
|
|
siteDir,
|
|
contentPaths,
|
|
sourceToPermalink: getSourceToPermalink(blogPosts),
|
|
onBrokenMarkdownLink: (brokenMarkdownLink) => {
|
|
throw new Error(
|
|
`Broken markdown link found: ${JSON.stringify(brokenMarkdownLink)}`,
|
|
);
|
|
},
|
|
...options,
|
|
});
|
|
return [fileContent, transformedContent];
|
|
};
|
|
|
|
test('transform to correct link', () => {
|
|
const post = path.join(contentPaths.contentPath, 'post.md');
|
|
const [content, transformedContent] = transform(post);
|
|
expect(transformedContent).toMatchSnapshot();
|
|
expect(transformedContent).toContain(
|
|
'](/blog/2018/12/14/Happy-First-Birthday-Slash',
|
|
);
|
|
expect(transformedContent).not.toContain(
|
|
'](2018-12-14-Happy-First-Birthday-Slash.md)',
|
|
);
|
|
expect(content).not.toEqual(transformedContent);
|
|
});
|
|
|
|
test('report broken markdown links', () => {
|
|
const filePath = 'post-with-broken-links.md';
|
|
const folderPath = contentPaths.contentPath;
|
|
const postWithBrokenLinks = path.join(folderPath, filePath);
|
|
const onBrokenMarkdownLink = jest.fn();
|
|
const [, transformedContent] = transform(postWithBrokenLinks, {
|
|
onBrokenMarkdownLink,
|
|
});
|
|
expect(transformedContent).toMatchSnapshot();
|
|
expect(onBrokenMarkdownLink).toHaveBeenCalledTimes(2);
|
|
expect(onBrokenMarkdownLink).toHaveBeenNthCalledWith(1, {
|
|
filePath: path.resolve(folderPath, filePath),
|
|
contentPaths,
|
|
link: 'postNotExist1.md',
|
|
} as BlogBrokenMarkdownLink);
|
|
expect(onBrokenMarkdownLink).toHaveBeenNthCalledWith(2, {
|
|
filePath: path.resolve(folderPath, filePath),
|
|
contentPaths,
|
|
link: './postNotExist2.mdx',
|
|
} as BlogBrokenMarkdownLink);
|
|
});
|