@docusaurus/plugin-content-blog 2.0.0-beta.1ab8aa0af → 2.0.0-beta.2

package/lib/blogFrontMatter.js

@@ -26,18 +26,18 @@ const BlogFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
     date: utils_validation_1.JoiFrontMatter.date().raw(),
     author: utils_validation_1.JoiFrontMatter.string(),
     author_title: utils_validation_1.JoiFrontMatter.string(),
-    author_url: utils_validation_1.JoiFrontMatter.string().uri(),
-    author_image_url: utils_validation_1.JoiFrontMatter.string().uri(),
+    author_url: utils_validation_1.URISchema,
+    author_image_url: utils_validation_1.URISchema,
     slug: utils_validation_1.JoiFrontMatter.string(),
-    image: utils_validation_1.JoiFrontMatter.string().uri({ relativeOnly: true }),
+    image: utils_validation_1.URISchema,
     keywords: utils_validation_1.JoiFrontMatter.array().items(utils_validation_1.JoiFrontMatter.string().required()),
     hide_table_of_contents: utils_validation_1.JoiFrontMatter.boolean(),
     // TODO re-enable warnings later, our v1 blog posts use those older frontmatter fields
-    authorURL: utils_validation_1.JoiFrontMatter.string().uri(),
+    authorURL: utils_validation_1.URISchema,
     // .warning('deprecate.error', { alternative: '"author_url"'}),
     authorTitle: utils_validation_1.JoiFrontMatter.string(),
     // .warning('deprecate.error', { alternative: '"author_title"'}),
-    authorImageURL: utils_validation_1.JoiFrontMatter.string().uri(),
+    authorImageURL: utils_validation_1.URISchema,
     // .warning('deprecate.error', { alternative: '"author_image_url"'}),
 })
     .unknown()

package/lib/blogUtils.js

@@ -34,18 +34,31 @@ function toUrl({ date, link }) {
         .substring(0, '2019-01-01'.length)
         .replace(/-/g, '/')}/${link}`;
 }
+function formatBlogPostDate(locale, date) {
+    try {
+        return new Intl.DateTimeFormat(locale, {
+            day: 'numeric',
+            month: 'long',
+            year: 'numeric',
+            timeZone: 'UTC',
+        }).format(date);
+    }
+    catch (e) {
+        throw new Error(`Can't format blog post date "${date}"`);
+    }
+}
 async function generateBlogFeed(contentPaths, context, options) {
     if (!options.feedOptions) {
-        throw new Error('Invalid options - `feedOptions` is not expected to be null.');
+        throw new Error('Invalid options: "feedOptions" is not expected to be null.');
     }
     const { siteConfig } = context;
     const blogPosts = await generateBlogPosts(contentPaths, context, options);
-    if (blogPosts == null) {
+    if (!blogPosts.length) {
         return null;
     }
     const { feedOptions, routeBasePath } = options;
-    const { url: siteUrl, title, favicon } = siteConfig;
-    const blogBaseUrl = utils_1.normalizeUrl([siteUrl, routeBasePath]);
+    const { url: siteUrl, baseUrl, title, favicon } = siteConfig;
+    const blogBaseUrl = utils_1.normalizeUrl([siteUrl, baseUrl, routeBasePath]);
     const updated = (blogPosts[0] && blogPosts[0].metadata.date) ||
         new Date('2015-10-25T16:29:00.000-07:00');
     const feed = new feed_1.Feed({
@@ -55,7 +68,7 @@ async function generateBlogFeed(contentPaths, context, options) {
         language: feedOptions.language,
         link: blogBaseUrl,
         description: feedOptions.description || `${siteConfig.title} Blog`,
-        favicon: utils_1.normalizeUrl([siteUrl, favicon]),
+        favicon: favicon ? utils_1.normalizeUrl([siteUrl, baseUrl, favicon]) : undefined,
         copyright: feedOptions.copyright,
     });
     blogPosts.forEach((post) => {
@@ -81,12 +94,12 @@ async function generateBlogPosts(contentPaths, { siteConfig, siteDir, i18n }, op
         cwd: contentPaths.contentPath,
     });
     const blogPosts = [];
-    await Promise.all(blogSourceFiles.map(async (blogSourceFile) => {
+    async function processBlogSourceFile(blogSourceFile) {
         var _a, _b, _c, _d, _e, _f;
         // Lookup in localized folder in priority
         const blogDirPath = await utils_1.getFolderContainingFile(getContentPathList(contentPaths), blogSourceFile);
         const source = path_1.default.join(blogDirPath, blogSourceFile);
-        const { frontMatter: unsafeFrontMatter, content, contentTitle, excerpt, } = await utils_1.parseMarkdownFile(source);
+        const { frontMatter: unsafeFrontMatter, content, contentTitle, excerpt, } = await utils_1.parseMarkdownFile(source, { removeContentTitle: true });
         const frontMatter = blogFrontMatter_1.validateBlogPostFrontMatter(unsafeFrontMatter);
         const aliasedSource = utils_1.aliasedSitePath(source, siteDir);
         const blogFileName = path_1.default.basename(blogSourceFile);
@@ -94,7 +107,7 @@ async function generateBlogPosts(contentPaths, { siteConfig, siteDir, i18n }, op
             return;
         }
         if (frontMatter.id) {
-            console.warn(chalk_1.default.yellow(`${blogFileName} - 'id' header option is deprecated. Please use 'slug' option instead.`));
+            console.warn(chalk_1.default.yellow(`"id" header option is deprecated in ${blogFileName} file. Please use "slug" option instead.`));
         }
         let date;
         // Extract date and title from filename.
@@ -102,7 +115,8 @@ async function generateBlogPosts(contentPaths, { siteConfig, siteDir, i18n }, op
         let linkName = blogFileName.replace(/\.mdx?$/, '');
         if (dateFilenameMatch) {
             const [, dateString, name] = dateFilenameMatch;
-            date = new Date(dateString);
+            // Always treat dates as UTC by adding the `Z`
+            date = new Date(`${dateString}Z`);
             linkName = name;
         }
         // Prefer user-defined date.
@@ -111,11 +125,7 @@ async function generateBlogPosts(contentPaths, { siteConfig, siteDir, i18n }, op
         }
         // Use file create time for blog.
         date = date !== null && date !== void 0 ? date : (await fs_extra_1.default.stat(source)).birthtime;
-        const formattedDate = new Intl.DateTimeFormat(i18n.currentLocale, {
-            day: 'numeric',
-            month: 'long',
-            year: 'numeric',
-        }).format(date);
+        const formattedDate = formatBlogPostDate(i18n.currentLocale, date);
         const title = (_b = (_a = frontMatter.title) !== null && _a !== void 0 ? _a : contentTitle) !== null && _b !== void 0 ? _b : linkName;
         const description = (_d = (_c = frontMatter.description) !== null && _c !== void 0 ? _c : excerpt) !== null && _d !== void 0 ? _d : '';
         const slug = frontMatter.slug ||
@@ -157,12 +167,19 @@ async function generateBlogPosts(contentPaths, { siteConfig, siteDir, i18n }, op
                 date,
                 formattedDate,
                 tags: (_f = frontMatter.tags) !== null && _f !== void 0 ? _f : [],
-                readingTime: showReadingTime
-                    ? reading_time_1.default(content).minutes
-                    : undefined,
+                readingTime: showReadingTime ? reading_time_1.default(content).minutes : undefined,
                 truncated: (truncateMarker === null || truncateMarker === void 0 ? void 0 : truncateMarker.test(content)) || false,
             },
         });
+    }
+    await Promise.all(blogSourceFiles.map(async (blogSourceFile) => {
+        try {
+            return await processBlogSourceFile(blogSourceFile);
+        }
+        catch (e) {
+            console.error(chalk_1.default.red(`Processing of blog source file failed for path "${blogSourceFile}"`));
+            throw e;
+        }
     }));
     blogPosts.sort((a, b) => b.metadata.date.getTime() - a.metadata.date.getTime());
     return blogPosts;

package/lib/index.d.ts

@@ -6,5 +6,5 @@
  */
 import { PluginOptions, BlogContent } from './types';
 import { LoadContext, Plugin, OptionValidationContext, ValidationResult } from '@docusaurus/types';
-export default function pluginContentBlog(context: LoadContext, options: PluginOptions): Plugin<BlogContent | null>;
+export default function pluginContentBlog(context: LoadContext, options: PluginOptions): Plugin<BlogContent>;
 export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions>;

package/lib/index.js

@@ -37,7 +37,6 @@ function pluginContentBlog(context, options) {
     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))}`;
-    let blogPosts = [];
     return {
         name: 'docusaurus-plugin-content-blog',
         getPathsToWatch() {
@@ -56,9 +55,14 @@ function pluginContentBlog(context, options) {
         // Fetches blog contents and returns metadata for the necessary routes.
         async loadContent() {
             const { postsPerPage, routeBasePath } = options;
-            blogPosts = await blogUtils_1.generateBlogPosts(contentPaths, context, options);
+            const blogPosts = await blogUtils_1.generateBlogPosts(contentPaths, context, options);
             if (!blogPosts.length) {
-                return null;
+                return {
+                    blogPosts: [],
+                    blogListPaginated: [],
+                    blogTags: {},
+                    blogTagsListPath: null,
+                };
             }
             // Colocate next and prev metadata.
             blogPosts.forEach((blogPost, index) => {
@@ -155,7 +159,7 @@ function pluginContentBlog(context, options) {
             }
             const { blogListComponent, blogPostComponent, blogTagsListComponent, blogTagsPostsComponent, } = options;
             const { addRoute, createData } = actions;
-            const { blogPosts: loadedBlogPosts, blogListPaginated, blogTags, blogTagsListPath, } = blogContents;
+            const { blogPosts, blogListPaginated, blogTags, blogTagsListPath, } = blogContents;
             const blogItemsToMetadata = {};
             const sidebarBlogPosts = options.blogSidebarCount === 'ALL'
                 ? blogPosts
@@ -172,7 +176,7 @@ function pluginContentBlog(context, options) {
                 })),
             }, null, 2));
             // Create routes for blog entries.
-            await Promise.all(loadedBlogPosts.map(async (blogPost) => {
+            await Promise.all(blogPosts.map(async (blogPost) => {
                 const { id, metadata } = blogPost;
                 await createData(
                 // Note that this created data path must be in sync with
@@ -183,7 +187,7 @@ function pluginContentBlog(context, options) {
                     component: blogPostComponent,
                     exact: true,
                     modules: {
-                        sidebar: sidebarProp,
+                        sidebar: aliasedSource(sidebarProp),
                         content: metadata.source,
                     },
                 });
@@ -199,7 +203,7 @@ function pluginContentBlog(context, options) {
                     component: blogListComponent,
                     exact: true,
                     modules: {
-                        sidebar: sidebarProp,
+                        sidebar: aliasedSource(sidebarProp),
                         items: items.map((postID) => {
                             // To tell routes.js this is an import and not a nested object to recurse.
                             return {
@@ -236,7 +240,7 @@ function pluginContentBlog(context, options) {
                     component: blogTagsPostsComponent,
                     exact: true,
                     modules: {
-                        sidebar: sidebarProp,
+                        sidebar: aliasedSource(sidebarProp),
                         items: items.map((postID) => {
                             const metadata = blogItemsToMetadata[postID];
                             return {
@@ -261,19 +265,19 @@ function pluginContentBlog(context, options) {
                     component: blogTagsListComponent,
                     exact: true,
                     modules: {
-                        sidebar: sidebarProp,
+                        sidebar: aliasedSource(sidebarProp),
                         tags: aliasedSource(tagsListPath),
                     },
                 });
             }
         },
-        configureWebpack(_config, isServer, { getJSLoader }) {
+        configureWebpack(_config, isServer, { getJSLoader }, content) {
             const { rehypePlugins, remarkPlugins, truncateMarker, beforeDefaultRemarkPlugins, beforeDefaultRehypePlugins, } = options;
             const markdownLoaderOptions = {
                 siteDir,
                 contentPaths,
                 truncateMarker,
-                sourceToPermalink: blogUtils_1.getSourceToPermalink(blogPosts),
+                sourceToPermalink: blogUtils_1.getSourceToPermalink(content.blogPosts),
                 onBrokenMarkdownLink: (brokenMarkdownLink) => {
                     if (onBrokenMarkdownLinks === 'ignore') {
                         return;
@@ -310,6 +314,9 @@ function pluginContentBlog(context, options) {
                                             const aliasedPath = utils_1.aliasedSitePath(mdxPath, siteDir);
                                             return path_1.default.join(dataDir, `${utils_1.docuHash(aliasedPath)}.json`);
                                         },
+                                        // For blog posts a title in markdown is always removed
+                                        // Blog posts title are rendered separately
+                                        removeContentTitle: true,
                                     },
                                 },
                                 {
@@ -339,12 +346,15 @@ function pluginContentBlog(context, options) {
                     await fs_extra_1.default.outputFile(feedPath, feedContent);
                 }
                 catch (err) {
-                    throw new Error(`Generating ${feedType} feed failed: ${err}`);
+                    throw new Error(`Generating ${feedType} feed failed: ${err}.`);
                 }
             }));
         },
-        injectHtmlTags() {
+        injectHtmlTags({ content }) {
             var _a;
+            if (!content.blogPosts.length) {
+                return {};
+            }
             if (!((_a = options.feedOptions) === null || _a === void 0 ? void 0 : _a.type)) {
                 return {};
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "2.0.0-beta.1ab8aa0af",
+  "version": "2.0.0-beta.2",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "index.d.ts",
@@ -18,21 +18,22 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.1ab8aa0af",
-    "@docusaurus/mdx-loader": "2.0.0-beta.1ab8aa0af",
-    "@docusaurus/types": "2.0.0-beta.1ab8aa0af",
-    "@docusaurus/utils": "2.0.0-beta.1ab8aa0af",
-    "@docusaurus/utils-validation": "2.0.0-beta.1ab8aa0af",
-    "chalk": "^4.1.0",
+    "@docusaurus/core": "2.0.0-beta.2",
+    "@docusaurus/mdx-loader": "2.0.0-beta.2",
+    "@docusaurus/types": "2.0.0-beta.2",
+    "@docusaurus/utils": "2.0.0-beta.2",
+    "@docusaurus/utils-validation": "2.0.0-beta.2",
+    "chalk": "^4.1.1",
+    "escape-string-regexp": "^4.0.0",
     "feed": "^4.2.2",
-    "fs-extra": "^9.1.0",
+    "fs-extra": "^10.0.0",
     "globby": "^11.0.2",
     "loader-utils": "^2.0.0",
     "lodash": "^4.17.20",
     "reading-time": "^1.3.0",
     "remark-admonitions": "^1.2.1",
-    "tslib": "^2.1.0",
-    "webpack": "^5.28.0"
+    "tslib": "^2.2.0",
+    "webpack": "^5.40.0"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -41,5 +42,5 @@
   "engines": {
     "node": ">=12.13.0"
   },
-  "gitHead": "63c06baac39707a1a4c3cc4c0031cb2163f256c4"
+  "gitHead": "883f07fddffaf1657407c8e202e370cc436e25f7"
 }

package/src/__tests__/__snapshots__/generateBlogFeed.test.ts.snap

@@ -1,75 +1,50 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`blogFeed atom can show feed without posts 1`] = `
-"<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
-<feed xmlns=\\"http://www.w3.org/2005/Atom\\">
-    <id>https://docusaurus.io/blog</id>
-    <title>Hello Blog</title>
-    <updated>2015-10-25T23:29:00.000Z</updated>
-    <generator>https://github.com/jpmonette/feed</generator>
-    <link rel=\\"alternate\\" href=\\"https://docusaurus.io/blog\\"/>
-    <subtitle>Hello Blog</subtitle>
-    <icon>https://docusaurus.io/image/favicon.ico</icon>
-    <rights>Copyright</rights>
-</feed>"
-`;
+exports[`blogFeed atom should not show feed without posts 1`] = `null`;
 
 exports[`blogFeed atom shows feed item for each post 1`] = `
 "<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
 <feed xmlns=\\"http://www.w3.org/2005/Atom\\">
-    <id>https://docusaurus.io/blog</id>
+    <id>https://docusaurus.io/myBaseUrl/blog</id>
     <title>Hello Blog</title>
     <updated>2020-02-27T00:00:00.000Z</updated>
     <generator>https://github.com/jpmonette/feed</generator>
-    <link rel=\\"alternate\\" href=\\"https://docusaurus.io/blog\\"/>
+    <link rel=\\"alternate\\" href=\\"https://docusaurus.io/myBaseUrl/blog\\"/>
     <subtitle>Hello Blog</subtitle>
-    <icon>https://docusaurus.io/image/favicon.ico</icon>
+    <icon>https://docusaurus.io/myBaseUrl/image/favicon.ico</icon>
     <rights>Copyright</rights>
     <entry>
         <title type=\\"html\\"><![CDATA[draft]]></title>
         <id>draft</id>
-        <link href=\\"https://docusaurus.io/blog/draft\\"/>
+        <link href=\\"https://docusaurus.io/myBaseUrl/blog/draft\\"/>
         <updated>2020-02-27T00:00:00.000Z</updated>
         <summary type=\\"html\\"><![CDATA[this post should not be published yet]]></summary>
     </entry>
     <entry>
         <title type=\\"html\\"><![CDATA[date-matter]]></title>
         <id>date-matter</id>
-        <link href=\\"https://docusaurus.io/blog/date-matter\\"/>
+        <link href=\\"https://docusaurus.io/myBaseUrl/blog/date-matter\\"/>
         <updated>2019-01-01T00:00:00.000Z</updated>
         <summary type=\\"html\\"><![CDATA[date inside front matter]]></summary>
     </entry>
     <entry>
         <title type=\\"html\\"><![CDATA[Happy 1st Birthday Slash! (translated)]]></title>
         <id>Happy 1st Birthday Slash! (translated)</id>
-        <link href=\\"https://docusaurus.io/blog/2018/12/14/Happy-First-Birthday-Slash\\"/>
+        <link href=\\"https://docusaurus.io/myBaseUrl/blog/2018/12/14/Happy-First-Birthday-Slash\\"/>
         <updated>2018-12-14T00:00:00.000Z</updated>
         <summary type=\\"html\\"><![CDATA[Happy birthday! (translated)]]></summary>
     </entry>
 </feed>"
 `;
 
-exports[`blogFeed rss can show feed without posts 1`] = `
-"<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
-<rss version=\\"2.0\\">
-    <channel>
-        <title>Hello Blog</title>
-        <link>https://docusaurus.io/blog</link>
-        <description>Hello Blog</description>
-        <lastBuildDate>Sun, 25 Oct 2015 23:29:00 GMT</lastBuildDate>
-        <docs>https://validator.w3.org/feed/docs/rss2.html</docs>
-        <generator>https://github.com/jpmonette/feed</generator>
-        <copyright>Copyright</copyright>
-    </channel>
-</rss>"
-`;
+exports[`blogFeed rss should not show feed without posts 1`] = `null`;
 
 exports[`blogFeed rss shows feed item for each post 1`] = `
 "<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
 <rss version=\\"2.0\\">
     <channel>
         <title>Hello Blog</title>
-        <link>https://docusaurus.io/blog</link>
+        <link>https://docusaurus.io/myBaseUrl/blog</link>
         <description>Hello Blog</description>
         <lastBuildDate>Thu, 27 Feb 2020 00:00:00 GMT</lastBuildDate>
         <docs>https://validator.w3.org/feed/docs/rss2.html</docs>
@@ -77,21 +52,21 @@ exports[`blogFeed rss shows feed item for each post 1`] = `
         <copyright>Copyright</copyright>
         <item>
             <title><![CDATA[draft]]></title>
-            <link>https://docusaurus.io/blog/draft</link>
+            <link>https://docusaurus.io/myBaseUrl/blog/draft</link>
             <guid>draft</guid>
             <pubDate>Thu, 27 Feb 2020 00:00:00 GMT</pubDate>
             <description><![CDATA[this post should not be published yet]]></description>
         </item>
         <item>
             <title><![CDATA[date-matter]]></title>
-            <link>https://docusaurus.io/blog/date-matter</link>
+            <link>https://docusaurus.io/myBaseUrl/blog/date-matter</link>
             <guid>date-matter</guid>
             <pubDate>Tue, 01 Jan 2019 00:00:00 GMT</pubDate>
             <description><![CDATA[date inside front matter]]></description>
         </item>
         <item>
             <title><![CDATA[Happy 1st Birthday Slash! (translated)]]></title>
-            <link>https://docusaurus.io/blog/2018/12/14/Happy-First-Birthday-Slash</link>
+            <link>https://docusaurus.io/myBaseUrl/blog/2018/12/14/Happy-First-Birthday-Slash</link>
             <guid>Happy 1st Birthday Slash! (translated)</guid>
             <pubDate>Fri, 14 Dec 2018 00:00:00 GMT</pubDate>
             <description><![CDATA[Happy birthday! (translated)]]></description>