@docusaurus/plugin-content-blog 2.0.0-beta.20 → 2.0.0-beta.21

package/lib/authors.js

@@ -29,7 +29,11 @@ const AuthorsMapSchema = utils_validation_1.Joi.object()
     'object.base': "The authors map file should contain an object where each entry contains an author key and the corresponding author's data.",
 });
 function validateAuthorsMap(content) {
-    return utils_validation_1.Joi.attempt(content, AuthorsMapSchema);
+    const { error, value } = AuthorsMapSchema.validate(content);
+    if (error) {
+        throw error;
+    }
+    return value;
 }
 exports.validateAuthorsMap = validateAuthorsMap;
 async function getAuthorsMap(params) {

package/lib/blogUtils.d.ts

@@ -4,9 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { BlogContentPaths, BlogMarkdownLoaderOptions } from './types';
 import type { LoadContext } from '@docusaurus/types';
 import type { PluginOptions, BlogPost, BlogTags, BlogPaginated } from '@docusaurus/plugin-content-blog';
+import type { BlogContentPaths, BlogMarkdownLoaderOptions } from './types';
 export declare function truncate(fileString: string, truncateMarker: RegExp): string;
 export declare function getSourceToPermalink(blogPosts: BlogPost[]): {
     [aliasedPath: string]: string;

package/lib/blogUtils.js

@@ -10,12 +10,12 @@ exports.linkify = exports.generateBlogPosts = exports.parseBlogFileName = export
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
-const reading_time_1 = tslib_1.__importDefault(require("reading-time"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const reading_time_1 = tslib_1.__importDefault(require("reading-time"));
 const utils_1 = require("@docusaurus/utils");
 const frontMatter_1 = require("./frontMatter");
 const authors_1 = require("./authors");
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 function truncate(fileString, truncateMarker) {
     return fileString.split(truncateMarker, 1).shift();
 }
@@ -161,7 +161,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
     const formattedDate = formatBlogPostDate(i18n.currentLocale, date, i18n.localeConfigs[i18n.currentLocale].calendar);
     const title = frontMatter.title ?? contentTitle ?? parsedBlogFileName.text;
     const description = frontMatter.description ?? excerpt ?? '';
-    const slug = frontMatter.slug || parsedBlogFileName.slug;
+    const slug = frontMatter.slug ?? parsedBlogFileName.slug;
     const permalink = (0, utils_1.normalizeUrl)([baseUrl, routeBasePath, slug]);
     function getBlogEditUrl() {
         const blogPathRelative = path_1.default.relative(blogDirPath, path_1.default.resolve(blogSourceAbsolute));
@@ -210,7 +210,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
                     defaultReadingTime,
                 })
                 : undefined,
-            truncated: truncateMarker?.test(content) || false,
+            truncated: truncateMarker.test(content),
             authors,
             frontMatter,
         },

package/lib/feed.js

@@ -8,12 +8,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createBlogFeedFiles = void 0;
 const tslib_1 = require("tslib");
-const feed_1 = require("feed");
-const utils_1 = require("@docusaurus/utils");
-const cheerio_1 = require("cheerio");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const feed_1 = require("feed");
+const utils_1 = require("@docusaurus/utils");
 const utils_common_1 = require("@docusaurus/utils-common");
+const cheerio_1 = require("cheerio");
 async function generateBlogFeed({ blogPosts, options, siteConfig, outDir, locale, }) {
     if (!blogPosts.length) {
         return null;
@@ -76,7 +77,8 @@ async function createBlogFeedFile({ feed, feedType, generatePath, }) {
         await fs_extra_1.default.outputFile(path_1.default.join(generatePath, feedPath), feedContent);
     }
     catch (err) {
-        throw new Error(`Generating ${feedType} feed failed: ${err}.`);
+        logger_1.default.error(`Generating ${feedType} feed failed.`);
+        throw err;
     }
 }
 async function createBlogFeedFiles({ blogPosts, options, siteConfig, outDir, locale, }) {

package/lib/index.js

@@ -9,11 +9,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
+const utils_1 = require("@docusaurus/utils");
 const remark_admonitions_1 = tslib_1.__importDefault(require("remark-admonitions"));
+const blogUtils_1 = require("./blogUtils");
 const footnoteIDFixer_1 = tslib_1.__importDefault(require("./remark/footnoteIDFixer"));
-const utils_1 = require("@docusaurus/utils");
 const translations_1 = require("./translations");
-const blogUtils_1 = require("./blogUtils");
 const feed_1 = require("./feed");
 async function pluginContentBlog(context, options) {
     if (options.admonitions) {
@@ -105,9 +105,6 @@ async function pluginContentBlog(context, options) {
             };
         },
         async contentLoaded({ content: blogContents, actions }) {
-            if (!blogContents) {
-                return;
-            }
             const { blogListComponent, blogPostComponent, blogTagsListComponent, blogTagsPostsComponent, blogArchiveComponent, routeBasePath, archiveBasePath, } = options;
             const { addRoute, createData } = actions;
             const { blogSidebarTitle, blogPosts, blogListPaginated, blogTags, blogTagsListPath, } = blogContents;
@@ -334,10 +331,7 @@ async function pluginContentBlog(context, options) {
             });
         },
         injectHtmlTags({ content }) {
-            if (!content.blogPosts.length) {
-                return {};
-            }
-            if (!options.feedOptions?.type) {
+            if (!content.blogPosts.length || !options.feedOptions.type) {
                 return {};
             }
             const feedTypes = options.feedOptions.type;

package/lib/markdownLoader.js

@@ -25,6 +25,6 @@ function markdownLoader(source) {
     if (truncated) {
         finalContent = (0, blogUtils_1.truncate)(finalContent, markdownLoaderOptions.truncateMarker);
     }
-    return callback?.(null, finalContent);
+    return callback(null, finalContent);
 }
 exports.default = markdownLoader;

package/lib/options.d.ts

@@ -7,4 +7,4 @@
 import type { PluginOptions, Options } from '@docusaurus/plugin-content-blog';
 import type { OptionValidationContext } from '@docusaurus/types';
 export declare const DEFAULT_OPTIONS: PluginOptions;
-export declare function validateOptions({ validate, options, }: OptionValidationContext<Options, PluginOptions>): PluginOptions;
+export declare function validateOptions({ validate, options, }: OptionValidationContext<Options | undefined, PluginOptions>): PluginOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "2.0.0-beta.20",
+  "version": "2.0.0-beta.21",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,13 +18,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.20",
-    "@docusaurus/logger": "2.0.0-beta.20",
-    "@docusaurus/mdx-loader": "2.0.0-beta.20",
-    "@docusaurus/utils": "2.0.0-beta.20",
-    "@docusaurus/utils-common": "2.0.0-beta.20",
-    "@docusaurus/utils-validation": "2.0.0-beta.20",
-    "cheerio": "^1.0.0-rc.10",
+    "@docusaurus/core": "2.0.0-beta.21",
+    "@docusaurus/logger": "2.0.0-beta.21",
+    "@docusaurus/mdx-loader": "2.0.0-beta.21",
+    "@docusaurus/utils": "2.0.0-beta.21",
+    "@docusaurus/utils-common": "2.0.0-beta.21",
+    "@docusaurus/utils-validation": "2.0.0-beta.21",
+    "cheerio": "^1.0.0-rc.11",
     "feed": "^4.2.2",
     "fs-extra": "^10.1.0",
     "lodash": "^4.17.21",
@@ -33,10 +33,10 @@
     "tslib": "^2.4.0",
     "unist-util-visit": "^2.0.3",
     "utility-types": "^3.10.0",
-    "webpack": "^5.72.0"
+    "webpack": "^5.72.1"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.20",
+    "@docusaurus/types": "2.0.0-beta.21",
     "escape-string-regexp": "^4.0.0"
   },
   "peerDependencies": {
@@ -44,7 +44,7 @@
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16.14"
   },
-  "gitHead": "ed5cdba401a5948e187e927039b142a0decc702d"
+  "gitHead": "69ac49fc6909517f13615ee40290c4bd00c39df4"
 }

package/src/authors.ts

@@ -5,9 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {BlogContentPaths} from './types';
 import {getDataFileData} from '@docusaurus/utils';
 import {Joi, URISchema} from '@docusaurus/utils-validation';
+import type {BlogContentPaths} from './types';
 import type {
   Author,
   BlogPostFrontMatter,
@@ -44,7 +44,11 @@ const AuthorsMapSchema = Joi.object<AuthorsMap>()
   });
 
 export function validateAuthorsMap(content: unknown): AuthorsMap {
-  return Joi.attempt(content, AuthorsMapSchema);
+  const {error, value} = AuthorsMapSchema.validate(content);
+  if (error) {
+    throw error;
+  }
+  return value;
 }
 
 export async function getAuthorsMap(params: {

package/src/blogUtils.ts

@@ -7,9 +7,9 @@
 
 import fs from 'fs-extra';
 import path from 'path';
-import readingTime from 'reading-time';
 import _ from 'lodash';
-import type {BlogContentPaths, BlogMarkdownLoaderOptions} from './types';
+import logger from '@docusaurus/logger';
+import readingTime from 'reading-time';
 import {
   parseMarkdownString,
   normalizeUrl,
@@ -24,10 +24,9 @@ import {
   getFileCommitDate,
   getContentPathList,
 } from '@docusaurus/utils';
-import type {LoadContext} from '@docusaurus/types';
 import {validateBlogPostFrontMatter} from './frontMatter';
 import {type AuthorsMap, getAuthorsMap, getBlogPostAuthors} from './authors';
-import logger from '@docusaurus/logger';
+import type {LoadContext} from '@docusaurus/types';
 import type {
   PluginOptions,
   ReadingTimeFunction,
@@ -35,6 +34,7 @@ import type {
   BlogTags,
   BlogPaginated,
 } from '@docusaurus/plugin-content-blog';
+import type {BlogContentPaths, BlogMarkdownLoaderOptions} from './types';
 
 export function truncate(fileString: string, truncateMarker: RegExp): string {
   return fileString.split(truncateMarker, 1).shift()!;
@@ -264,7 +264,7 @@ async function processBlogSourceFile(
   const title = frontMatter.title ?? contentTitle ?? parsedBlogFileName.text;
   const description = frontMatter.description ?? excerpt ?? '';
 
-  const slug = frontMatter.slug || parsedBlogFileName.slug;
+  const slug = frontMatter.slug ?? parsedBlogFileName.slug;
 
   const permalink = normalizeUrl([baseUrl, routeBasePath, slug]);
 
@@ -323,7 +323,7 @@ async function processBlogSourceFile(
             defaultReadingTime,
           })
         : undefined,
-      truncated: truncateMarker?.test(content) || false,
+      truncated: truncateMarker.test(content),
       authors,
       frontMatter,
     },

package/src/feed.ts

@@ -5,19 +5,20 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import path from 'path';
+import fs from 'fs-extra';
+import logger from '@docusaurus/logger';
 import {Feed, type Author as FeedAuthor, type Item as FeedItem} from 'feed';
 import {normalizeUrl, readOutputHTMLFile} from '@docusaurus/utils';
+import {blogPostContainerID} from '@docusaurus/utils-common';
 import {load as cheerioLoad} from 'cheerio';
 import type {DocusaurusConfig} from '@docusaurus/types';
-import path from 'path';
-import fs from 'fs-extra';
 import type {
   FeedType,
   PluginOptions,
   Author,
   BlogPost,
 } from '@docusaurus/plugin-content-blog';
-import {blogPostContainerID} from '@docusaurus/utils-common';
 
 async function generateBlogFeed({
   blogPosts,
@@ -127,7 +128,8 @@ async function createBlogFeedFile({
   try {
     await fs.outputFile(path.join(generatePath, feedPath), feedContent);
   } catch (err) {
-    throw new Error(`Generating ${feedType} feed failed: ${err}.`);
+    logger.error(`Generating ${feedType} feed failed.`);
+    throw err;
   }
 }
 

package/src/index.ts

@@ -6,8 +6,6 @@
  */
 
 import path from 'path';
-import admonitions from 'remark-admonitions';
-import footnoteIDFixer from './remark/footnoteIDFixer';
 import {
   normalizeUrl,
   docuHash,
@@ -23,17 +21,19 @@ import {
   type TagsListItem,
   type TagModule,
 } from '@docusaurus/utils';
-import {translateContent, getTranslationFiles} from './translations';
-
-import type {BlogContentPaths, BlogMarkdownLoaderOptions} from './types';
-import type {LoadContext, Plugin, HtmlTags} from '@docusaurus/types';
+import admonitions from 'remark-admonitions';
 import {
   generateBlogPosts,
   getSourceToPermalink,
   getBlogTags,
   paginateBlogPosts,
 } from './blogUtils';
+import footnoteIDFixer from './remark/footnoteIDFixer';
+import {translateContent, getTranslationFiles} from './translations';
 import {createBlogFeedFiles} from './feed';
+
+import type {BlogContentPaths, BlogMarkdownLoaderOptions} from './types';
+import type {LoadContext, Plugin, HtmlTags} from '@docusaurus/types';
 import type {
   PluginOptions,
   BlogPostFrontMatter,
@@ -176,10 +176,6 @@ export default async function pluginContentBlog(
     },
 
     async contentLoaded({content: blogContents, actions}) {
-      if (!blogContents) {
-        return;
-      }
-
       const {
         blogListComponent,
         blogPostComponent,
@@ -500,11 +496,7 @@ export default async function pluginContentBlog(
     },
 
     injectHtmlTags({content}) {
-      if (!content.blogPosts.length) {
-        return {};
-      }
-
-      if (!options.feedOptions?.type) {
+      if (!content.blogPosts.length || !options.feedOptions.type) {
         return {};
       }
 

package/src/markdownLoader.ts

@@ -34,5 +34,5 @@ export default function markdownLoader(
     finalContent = truncate(finalContent, markdownLoaderOptions.truncateMarker);
   }
 
-  return callback?.(null, finalContent);
+  return callback(null, finalContent);
 }

package/src/options.ts

@@ -13,7 +13,11 @@ import {
   URISchema,
 } from '@docusaurus/utils-validation';
 import {GlobExcludeDefault} from '@docusaurus/utils';
-import type {PluginOptions, Options} from '@docusaurus/plugin-content-blog';
+import type {
+  PluginOptions,
+  Options,
+  FeedType,
+} from '@docusaurus/plugin-content-blog';
 import type {OptionValidationContext} from '@docusaurus/types';
 
 export const DEFAULT_OPTIONS: PluginOptions = {
@@ -101,7 +105,7 @@ const PluginOptionSchema = Joi.object<PluginOptions>({
         Joi.alternatives().conditional(
           Joi.string().equal('all', 'rss', 'atom', 'json'),
           {
-            then: Joi.custom((val) =>
+            then: Joi.custom((val: FeedType | 'all') =>
               val === 'all' ? ['rss', 'atom', 'json'] : [val],
             ),
           },
@@ -131,10 +135,7 @@ const PluginOptionSchema = Joi.object<PluginOptions>({
 export function validateOptions({
   validate,
   options,
-}: OptionValidationContext<Options, PluginOptions>): PluginOptions {
-  const validatedOptions = validate(
-    PluginOptionSchema,
-    options,
-  ) as PluginOptions;
+}: OptionValidationContext<Options | undefined, PluginOptions>): PluginOptions {
+  const validatedOptions = validate(PluginOptionSchema, options);
   return validatedOptions;
 }

package/src/plugin-content-blog.d.ts

@@ -538,11 +538,11 @@ declare module '@theme/BlogTagsListPage' {
 }
 
 declare module '@theme/BlogTagsPostsPage' {
+  import type {Content} from '@theme/BlogPostPage';
   import type {
     BlogSidebar,
     BlogPaginatedMetadata,
   } from '@docusaurus/plugin-content-blog';
-  import type {Content} from '@theme/BlogPostPage';
   import type {TagModule} from '@docusaurus/utils';
 
   export interface Props {