@docusaurus/plugin-content-blog 2.0.0-beta.15a2b59f9 → 2.0.0-beta.17

package/lib/index.js

@@ -8,60 +8,60 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
 const tslib_1 = require("tslib");
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const remark_admonitions_1 = tslib_1.__importDefault(require("remark-admonitions"));
 const utils_1 = require("@docusaurus/utils");
-const constants_1 = require("@docusaurus/core/lib/constants");
-const lodash_1 = require("lodash");
+const translations_1 = require("./translations");
 const pluginOptionSchema_1 = require("./pluginOptionSchema");
 const blogUtils_1 = require("./blogUtils");
-function pluginContentBlog(context, options) {
-    var _a;
+const feed_1 = require("./feed");
+async function pluginContentBlog(context, options) {
     if (options.admonitions) {
         options.remarkPlugins = options.remarkPlugins.concat([
             [remark_admonitions_1.default, options.admonitions],
         ]);
     }
-    const { siteDir, siteConfig: { onBrokenMarkdownLinks }, generatedFilesDir, i18n: { currentLocale }, } = context;
+    const { siteDir, siteConfig, generatedFilesDir, i18n: { currentLocale }, } = context;
+    const { onBrokenMarkdownLinks, baseUrl } = siteConfig;
     const contentPaths = {
         contentPath: path_1.default.resolve(siteDir, options.path),
-        contentPathLocalized: utils_1.getPluginI18nPath({
+        contentPathLocalized: (0, utils_1.getPluginI18nPath)({
             siteDir,
             locale: currentLocale,
             pluginName: 'docusaurus-plugin-content-blog',
             pluginId: options.id,
         }),
     };
-    const pluginId = (_a = options.id) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_PLUGIN_ID;
+    const pluginId = options.id ?? utils_1.DEFAULT_PLUGIN_ID;
     const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-content-blog');
     const dataDir = path_1.default.join(pluginDataDirRoot, pluginId);
-    const aliasedSource = (source) => `~blog/${utils_1.posixPath(path_1.default.relative(pluginDataDirRoot, source))}`;
+    const aliasedSource = (source) => `~blog/${(0, utils_1.posixPath)(path_1.default.relative(pluginDataDirRoot, source))}`;
+    const authorsMapFilePath = await (0, utils_1.getDataFilePath)({
+        filePath: options.authorsMapPath,
+        contentPaths,
+    });
     return {
         name: 'docusaurus-plugin-content-blog',
         getPathsToWatch() {
-            const { include = [] } = options;
-            return lodash_1.flatten(blogUtils_1.getContentPathList(contentPaths).map((contentPath) => {
-                return include.map((pattern) => `${contentPath}/${pattern}`);
-            }));
+            const { include } = options;
+            const contentMarkdownGlobs = (0, utils_1.getContentPathList)(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
+            return [authorsMapFilePath, ...contentMarkdownGlobs].filter(Boolean);
         },
-        getClientModules() {
-            const modules = [];
-            if (options.admonitions) {
-                modules.push(require.resolve('remark-admonitions/styles/infima.css'));
-            }
-            return modules;
+        async getTranslationFiles() {
+            return (0, translations_1.getTranslationFiles)(options);
         },
         // Fetches blog contents and returns metadata for the necessary routes.
         async loadContent() {
-            const { postsPerPage, routeBasePath } = options;
-            const blogPosts = await blogUtils_1.generateBlogPosts(contentPaths, context, options);
+            const { postsPerPage: postsPerPageOption, routeBasePath, tagsBasePath, blogDescription, blogTitle, blogSidebarTitle, } = options;
+            const blogPosts = await (0, blogUtils_1.generateBlogPosts)(contentPaths, context, options);
             if (!blogPosts.length) {
                 return {
+                    blogSidebarTitle,
                     blogPosts: [],
                     blogListPaginated: [],
                     blogTags: {},
                     blogTagsListPath: null,
+                    blogTagsPaginated: [],
                 };
             }
             // Colocate next and prev metadata.
@@ -81,72 +81,24 @@ function pluginContentBlog(context, options) {
                     };
                 }
             });
-            // Blog pagination routes.
-            // Example: `/blog`, `/blog/page/1`, `/blog/page/2`
-            const totalCount = blogPosts.length;
-            const numberOfPages = Math.ceil(totalCount / postsPerPage);
-            const { siteConfig: { baseUrl = '' }, } = context;
-            const basePageUrl = utils_1.normalizeUrl([baseUrl, routeBasePath]);
-            const blogListPaginated = [];
-            function blogPaginationPermalink(page) {
-                return page > 0
-                    ? utils_1.normalizeUrl([basePageUrl, `page/${page + 1}`])
-                    : basePageUrl;
-            }
-            for (let page = 0; page < numberOfPages; page += 1) {
-                blogListPaginated.push({
-                    metadata: {
-                        permalink: blogPaginationPermalink(page),
-                        page: page + 1,
-                        postsPerPage,
-                        totalPages: numberOfPages,
-                        totalCount,
-                        previousPage: page !== 0 ? blogPaginationPermalink(page - 1) : null,
-                        nextPage: page < numberOfPages - 1
-                            ? blogPaginationPermalink(page + 1)
-                            : null,
-                        blogDescription: options.blogDescription,
-                        blogTitle: options.blogTitle,
-                    },
-                    items: blogPosts
-                        .slice(page * postsPerPage, (page + 1) * postsPerPage)
-                        .map((item) => item.id),
-                });
-            }
-            const blogTags = {};
-            const tagsPath = utils_1.normalizeUrl([basePageUrl, 'tags']);
-            blogPosts.forEach((blogPost) => {
-                const { tags } = blogPost.metadata;
-                if (!tags || tags.length === 0) {
-                    // TODO: Extract tags out into a separate plugin.
-                    // eslint-disable-next-line no-param-reassign
-                    blogPost.metadata.tags = [];
-                    return;
-                }
-                // eslint-disable-next-line no-param-reassign
-                blogPost.metadata.tags = tags.map((tag) => {
-                    if (typeof tag === 'string') {
-                        const normalizedTag = lodash_1.kebabCase(tag);
-                        const permalink = utils_1.normalizeUrl([tagsPath, normalizedTag]);
-                        if (!blogTags[normalizedTag]) {
-                            blogTags[normalizedTag] = {
-                                // Will only use the name of the first occurrence of the tag.
-                                name: tag.toLowerCase(),
-                                items: [],
-                                permalink,
-                            };
-                        }
-                        blogTags[normalizedTag].items.push(blogPost.id);
-                        return {
-                            label: tag,
-                            permalink,
-                        };
-                    }
-                    return tag;
-                });
+            const baseBlogUrl = (0, utils_1.normalizeUrl)([baseUrl, routeBasePath]);
+            const blogListPaginated = (0, blogUtils_1.paginateBlogPosts)({
+                blogPosts,
+                blogTitle,
+                blogDescription,
+                postsPerPageOption,
+                basePageUrl: baseBlogUrl,
             });
+            const blogTags = (0, blogUtils_1.getBlogTags)({
+                blogPosts,
+                postsPerPageOption,
+                blogDescription,
+                blogTitle,
+            });
+            const tagsPath = (0, utils_1.normalizeUrl)([baseBlogUrl, tagsBasePath]);
             const blogTagsListPath = Object.keys(blogTags).length > 0 ? tagsPath : null;
             return {
+                blogSidebarTitle,
                 blogPosts,
                 blogListPaginated,
                 blogTags,
@@ -157,19 +109,36 @@ function pluginContentBlog(context, options) {
             if (!blogContents) {
                 return;
             }
-            const { blogListComponent, blogPostComponent, blogTagsListComponent, blogTagsPostsComponent, } = options;
+            const { blogListComponent, blogPostComponent, blogTagsListComponent, blogTagsPostsComponent, blogArchiveComponent, routeBasePath, archiveBasePath, } = options;
             const { addRoute, createData } = actions;
-            const { blogPosts, blogListPaginated, blogTags, blogTagsListPath, } = blogContents;
+            const { blogSidebarTitle, blogPosts, blogListPaginated, blogTags, blogTagsListPath, } = blogContents;
             const blogItemsToMetadata = {};
             const sidebarBlogPosts = options.blogSidebarCount === 'ALL'
                 ? blogPosts
-                : lodash_1.take(blogPosts, options.blogSidebarCount);
+                : blogPosts.slice(0, options.blogSidebarCount);
+            if (archiveBasePath) {
+                const archiveUrl = (0, utils_1.normalizeUrl)([
+                    baseUrl,
+                    routeBasePath,
+                    archiveBasePath,
+                ]);
+                // creates a blog archive route
+                const archiveProp = await createData(`${(0, utils_1.docuHash)(archiveUrl)}.json`, JSON.stringify({ blogPosts }, null, 2));
+                addRoute({
+                    path: archiveUrl,
+                    component: blogArchiveComponent,
+                    exact: true,
+                    modules: {
+                        archive: aliasedSource(archiveProp),
+                    },
+                });
+            }
             // This prop is useful to provide the blog list sidebar
             const sidebarProp = await createData(
             // Note that this created data path must be in sync with
             // metadataPath provided to mdx-loader.
             `blog-post-list-prop-${pluginId}.json`, JSON.stringify({
-                title: options.blogSidebarTitle,
+                title: blogSidebarTitle,
                 items: sidebarBlogPosts.map((blogPost) => ({
                     title: blogPost.metadata.title,
                     permalink: blogPost.metadata.permalink,
@@ -181,7 +150,7 @@ function pluginContentBlog(context, options) {
                 await createData(
                 // Note that this created data path must be in sync with
                 // metadataPath provided to mdx-loader.
-                `${utils_1.docuHash(metadata.source)}.json`, JSON.stringify(metadata, null, 2));
+                `${(0, utils_1.docuHash)(metadata.source)}.json`, JSON.stringify(metadata, null, 2));
                 addRoute({
                     path: metadata.permalink,
                     component: blogPostComponent,
@@ -197,25 +166,25 @@ function pluginContentBlog(context, options) {
             await Promise.all(blogListPaginated.map(async (listPage) => {
                 const { metadata, items } = listPage;
                 const { permalink } = metadata;
-                const pageMetadataPath = await createData(`${utils_1.docuHash(permalink)}.json`, JSON.stringify(metadata, null, 2));
+                const pageMetadataPath = await createData(`${(0, utils_1.docuHash)(permalink)}.json`, JSON.stringify(metadata, null, 2));
                 addRoute({
                     path: permalink,
                     component: blogListComponent,
                     exact: true,
                     modules: {
                         sidebar: aliasedSource(sidebarProp),
-                        items: items.map((postID) => {
-                            // To tell routes.js this is an import and not a nested object to recurse.
-                            return {
-                                content: {
-                                    __import: true,
-                                    path: blogItemsToMetadata[postID].source,
-                                    query: {
-                                        truncated: true,
-                                    },
+                        items: items.map((postID) => 
+                        // To tell routes.js this is an import and not a nested object
+                        // to recurse.
+                        ({
+                            content: {
+                                __import: true,
+                                path: blogItemsToMetadata[postID].source,
+                                query: {
+                                    truncated: true,
                                 },
-                            };
-                        }),
+                            },
+                        })),
                         metadata: aliasedSource(pageMetadataPath),
                     },
                 });
@@ -224,42 +193,49 @@ function pluginContentBlog(context, options) {
             if (blogTagsListPath === null) {
                 return;
             }
-            const tagsModule = {};
-            await Promise.all(Object.keys(blogTags).map(async (tag) => {
-                const { name, items, permalink } = blogTags[tag];
-                tagsModule[tag] = {
+            const tagsModule = Object.fromEntries(Object.entries(blogTags).map(([tagKey, tag]) => {
+                const tagModule = {
                     allTagsPath: blogTagsListPath,
-                    slug: tag,
-                    name,
-                    count: items.length,
-                    permalink,
+                    slug: tagKey,
+                    name: tag.name,
+                    count: tag.items.length,
+                    permalink: tag.permalink,
                 };
-                const tagsMetadataPath = await createData(`${utils_1.docuHash(permalink)}.json`, JSON.stringify(tagsModule[tag], null, 2));
-                addRoute({
-                    path: permalink,
-                    component: blogTagsPostsComponent,
-                    exact: true,
-                    modules: {
-                        sidebar: aliasedSource(sidebarProp),
-                        items: items.map((postID) => {
-                            const metadata = blogItemsToMetadata[postID];
-                            return {
-                                content: {
-                                    __import: true,
-                                    path: metadata.source,
-                                    query: {
-                                        truncated: true,
-                                    },
-                                },
-                            };
-                        }),
-                        metadata: aliasedSource(tagsMetadataPath),
-                    },
-                });
+                return [tag.name, tagModule];
             }));
+            async function createTagRoutes(tag) {
+                await Promise.all(tag.pages.map(async (blogPaginated) => {
+                    const { metadata, items } = blogPaginated;
+                    const tagsMetadataPath = await createData(`${(0, utils_1.docuHash)(metadata.permalink)}.json`, JSON.stringify(tagsModule[tag.name], null, 2));
+                    const listMetadataPath = await createData(`${(0, utils_1.docuHash)(metadata.permalink)}-list.json`, JSON.stringify(metadata, null, 2));
+                    addRoute({
+                        path: metadata.permalink,
+                        component: blogTagsPostsComponent,
+                        exact: true,
+                        modules: {
+                            sidebar: aliasedSource(sidebarProp),
+                            items: items.map((postID) => {
+                                const blogPostMetadata = blogItemsToMetadata[postID];
+                                return {
+                                    content: {
+                                        __import: true,
+                                        path: blogPostMetadata.source,
+                                        query: {
+                                            truncated: true,
+                                        },
+                                    },
+                                };
+                            }),
+                            metadata: aliasedSource(tagsMetadataPath),
+                            listMetadata: aliasedSource(listMetadataPath),
+                        },
+                    });
+                }));
+            }
+            await Promise.all(Object.values(blogTags).map(createTagRoutes));
             // Only create /tags page if there are tags.
             if (Object.keys(blogTags).length > 0) {
-                const tagsListPath = await createData(`${utils_1.docuHash(`${blogTagsListPath}-tags`)}.json`, JSON.stringify(tagsModule, null, 2));
+                const tagsListPath = await createData(`${(0, utils_1.docuHash)(`${blogTagsListPath}-tags`)}.json`, JSON.stringify(tagsModule, null, 2));
                 addRoute({
                     path: blogTagsListPath,
                     component: blogTagsListComponent,
@@ -271,20 +247,24 @@ function pluginContentBlog(context, options) {
                 });
             }
         },
+        translateContent({ content, translationFiles }) {
+            return (0, translations_1.translateContent)(content, translationFiles);
+        },
         configureWebpack(_config, isServer, { getJSLoader }, content) {
             const { rehypePlugins, remarkPlugins, truncateMarker, beforeDefaultRemarkPlugins, beforeDefaultRehypePlugins, } = options;
             const markdownLoaderOptions = {
                 siteDir,
                 contentPaths,
                 truncateMarker,
-                sourceToPermalink: blogUtils_1.getSourceToPermalink(content.blogPosts),
+                sourceToPermalink: (0, blogUtils_1.getSourceToPermalink)(content.blogPosts),
                 onBrokenMarkdownLink: (brokenMarkdownLink) => {
                     if (onBrokenMarkdownLinks === 'ignore') {
                         return;
                     }
-                    utils_1.reportMessage(`Blog markdown link couldn't be resolved: (${brokenMarkdownLink.link}) in ${brokenMarkdownLink.filePath}`, onBrokenMarkdownLinks);
+                    (0, utils_1.reportMessage)(`Blog markdown link couldn't be resolved: (${brokenMarkdownLink.link}) in ${brokenMarkdownLink.filePath}`, onBrokenMarkdownLinks);
                 },
             };
+            const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
             return {
                 resolve: {
                     alias: {
@@ -294,8 +274,8 @@ function pluginContentBlog(context, options) {
                 module: {
                     rules: [
                         {
-                            test: /(\.mdx?)$/,
-                            include: blogUtils_1.getContentPathList(contentPaths)
+                            test: /\.mdx?$/i,
+                            include: contentDirs
                                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                                 .map(utils_1.addTrailingPathSeparator),
                             use: [
@@ -307,16 +287,24 @@ function pluginContentBlog(context, options) {
                                         rehypePlugins,
                                         beforeDefaultRemarkPlugins,
                                         beforeDefaultRehypePlugins,
-                                        staticDir: path_1.default.join(siteDir, constants_1.STATIC_DIR_NAME),
-                                        // Note that metadataPath must be the same/in-sync as
-                                        // the path from createData for each MDX.
+                                        staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
+                                        siteDir,
+                                        isMDXPartial: (0, utils_1.createAbsoluteFilePathMatcher)(options.exclude, contentDirs),
                                         metadataPath: (mdxPath) => {
-                                            const aliasedPath = utils_1.aliasedSitePath(mdxPath, siteDir);
-                                            return path_1.default.join(dataDir, `${utils_1.docuHash(aliasedPath)}.json`);
+                                            // Note that metadataPath must be the same/in-sync as
+                                            // the path from createData for each MDX.
+                                            const aliasedPath = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
+                                            return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedPath)}.json`);
                                         },
                                         // For blog posts a title in markdown is always removed
                                         // Blog posts title are rendered separately
                                         removeContentTitle: true,
+                                        // Assets allow to convert some relative images paths to
+                                        // require() calls
+                                        createAssets: ({ frontMatter, metadata, }) => ({
+                                            image: frontMatter.image,
+                                            authorsImageUrls: metadata.authors.map((author) => author.imageURL),
+                                        }),
                                     },
                                 },
                                 {
@@ -329,47 +317,45 @@ function pluginContentBlog(context, options) {
                 },
             };
         },
-        async postBuild({ outDir }) {
-            var _a;
-            if (!((_a = options.feedOptions) === null || _a === void 0 ? void 0 : _a.type)) {
+        async postBuild({ outDir, content }) {
+            if (!options.feedOptions.type) {
                 return;
             }
-            const feed = await blogUtils_1.generateBlogFeed(contentPaths, context, options);
-            if (!feed) {
+            const { blogPosts } = content;
+            if (!blogPosts.length) {
                 return;
             }
-            const feedTypes = options.feedOptions.type;
-            await Promise.all(feedTypes.map(async (feedType) => {
-                const feedPath = path_1.default.join(outDir, options.routeBasePath, `${feedType}.xml`);
-                const feedContent = feedType === 'rss' ? feed.rss2() : feed.atom1();
-                try {
-                    await fs_extra_1.default.outputFile(feedPath, feedContent);
-                }
-                catch (err) {
-                    throw new Error(`Generating ${feedType} feed failed: ${err}.`);
-                }
-            }));
+            await (0, feed_1.createBlogFeedFiles)({
+                blogPosts,
+                options,
+                outDir,
+                siteConfig,
+            });
         },
         injectHtmlTags({ content }) {
-            var _a;
             if (!content.blogPosts.length) {
                 return {};
             }
-            if (!((_a = options.feedOptions) === null || _a === void 0 ? void 0 : _a.type)) {
+            if (!options.feedOptions?.type) {
                 return {};
             }
             const feedTypes = options.feedOptions.type;
-            const { siteConfig: { title }, baseUrl, } = context;
+            const feedTitle = options.feedOptions.title ?? context.siteConfig.title;
             const feedsConfig = {
                 rss: {
                     type: 'application/rss+xml',
                     path: 'rss.xml',
-                    title: `${title} Blog RSS Feed`,
+                    title: `${feedTitle} RSS Feed`,
                 },
                 atom: {
                     type: 'application/atom+xml',
                     path: 'atom.xml',
-                    title: `${title} Blog Atom Feed`,
+                    title: `${feedTitle} Atom Feed`,
+                },
+                json: {
+                    type: 'application/json',
+                    path: 'feed.json',
+                    title: `${feedTitle} JSON Feed`,
                 },
             };
             const headTags = [];
@@ -384,7 +370,7 @@ function pluginContentBlog(context, options) {
                     attributes: {
                         rel: 'alternate',
                         type,
-                        href: utils_1.normalizeUrl([
+                        href: (0, utils_1.normalizeUrl)([
                             baseUrl,
                             options.routeBasePath,
                             feedConfigPath,

package/lib/markdownLoader.d.ts

@@ -4,9 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference types="node" />
-interface Loader extends Function {
-    (this: any, source: string): string | Buffer | void | undefined;
-}
-declare const markdownLoader: Loader;
-export default markdownLoader;
+import type { BlogMarkdownLoaderOptions } from './types';
+import type { LoaderContext } from 'webpack';
+export default function markdownLoader(this: LoaderContext<BlogMarkdownLoaderOptions>, source: string): void;

package/lib/markdownLoader.js

@@ -7,25 +7,24 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const blogUtils_1 = require("./blogUtils");
-const loader_utils_1 = require("loader-utils");
-const markdownLoader = function (source) {
+function markdownLoader(source) {
     const filePath = this.resourcePath;
     const fileString = source;
     const callback = this.async();
     const markdownLoaderOptions = this.getOptions();
     // Linkify blog posts
-    let finalContent = blogUtils_1.linkify({
+    let finalContent = (0, blogUtils_1.linkify)({
         fileString,
         filePath,
         ...markdownLoaderOptions,
     });
     // Truncate content if requested (e.g: file.md?truncated=true).
     const truncated = this.resourceQuery
-        ? !!loader_utils_1.parseQuery(this.resourceQuery).truncated
+        ? !!new URLSearchParams(this.resourceQuery.slice(1)).get('truncated')
         : undefined;
     if (truncated) {
-        finalContent = blogUtils_1.truncate(finalContent, markdownLoaderOptions.truncateMarker);
+        finalContent = (0, blogUtils_1.truncate)(finalContent, markdownLoaderOptions.truncateMarker);
     }
     return callback && callback(null, finalContent);
-};
+}
 exports.default = markdownLoader;

package/lib/pluginOptionSchema.d.ts

@@ -5,29 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
-export declare const DEFAULT_OPTIONS: {
-    feedOptions: {
-        type: string[];
-    };
-    beforeDefaultRehypePlugins: never[];
-    beforeDefaultRemarkPlugins: never[];
-    admonitions: {};
-    truncateMarker: RegExp;
-    rehypePlugins: never[];
-    remarkPlugins: never[];
-    showReadingTime: boolean;
-    blogTagsPostsComponent: string;
-    blogTagsListComponent: string;
-    blogPostComponent: string;
-    blogListComponent: string;
-    blogDescription: string;
-    blogTitle: string;
-    blogSidebarCount: number;
-    blogSidebarTitle: string;
-    postsPerPage: number;
-    include: string[];
-    routeBasePath: string;
-    path: string;
-    editLocalizedFiles: boolean;
-};
-export declare const PluginOptionSchema: Joi.ObjectSchema<any>;
+import type { PluginOptions } from '@docusaurus/plugin-content-blog';
+export declare const DEFAULT_OPTIONS: PluginOptions;
+export declare const PluginOptionSchema: Joi.ObjectSchema<PluginOptions>;