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

package/lib/authors.js

@@ -14,6 +14,7 @@ const AuthorsMapSchema = utils_validation_1.Joi.object().pattern(utils_validatio
     url: utils_validation_1.URISchema,
     imageURL: utils_validation_1.URISchema,
     title: utils_validation_1.Joi.string(),
+    email: utils_validation_1.Joi.string(),
 })
     .rename('image_url', 'imageURL')
     .or('name', 'imageURL')
@@ -34,11 +35,10 @@ exports.getAuthorsMap = getAuthorsMap;
 // Legacy v1/early-v2 front matter fields
 // We may want to deprecate those in favor of using only frontMatter.authors
 function getFrontMatterAuthorLegacy(frontMatter) {
-    var _a, _b, _c;
     const name = frontMatter.author;
-    const title = (_a = frontMatter.author_title) !== null && _a !== void 0 ? _a : frontMatter.authorTitle;
-    const url = (_b = frontMatter.author_url) !== null && _b !== void 0 ? _b : frontMatter.authorURL;
-    const imageURL = (_c = frontMatter.author_image_url) !== null && _c !== void 0 ? _c : frontMatter.authorImageURL;
+    const title = frontMatter.author_title ?? frontMatter.authorTitle;
+    const url = frontMatter.author_url ?? frontMatter.authorURL;
+    const imageURL = frontMatter.author_image_url ?? frontMatter.authorImageURL;
     if (name || title || url || imageURL) {
         return {
             name,

package/lib/blogUtils.js

@@ -8,14 +8,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.linkify = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.paginateBlogPosts = exports.getSourceToPermalink = exports.truncate = void 0;
 const tslib_1 = require("tslib");
-const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const reading_time_1 = (0, tslib_1.__importDefault)(require("reading-time"));
-const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
+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 utils_1 = require("@docusaurus/utils");
 const blogFrontMatter_1 = require("./blogFrontMatter");
 const authors_1 = require("./authors");
-const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 function truncate(fileString, truncateMarker) {
     return fileString.split(truncateMarker, 1).shift();
 }
@@ -115,7 +115,6 @@ async function parseBlogPostMarkdownFile(blogSourceAbsolute) {
 }
 const defaultReadingTime = ({ content, options }) => (0, reading_time_1.default)(content, options).minutes;
 async function processBlogSourceFile(blogSourceRelative, contentPaths, context, options, authorsMap) {
-    var _a, _b, _c, _d;
     const { siteConfig: { baseUrl }, siteDir, i18n, } = context;
     const { routeBasePath, tagsBasePath: tagsRouteBasePath, truncateMarker, showReadingTime, editUrl, } = options;
     // Lookup in localized folder in priority
@@ -157,8 +156,8 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
     }
     const date = await getDate();
     const formattedDate = formatBlogPostDate(i18n.currentLocale, date);
-    const title = (_b = (_a = frontMatter.title) !== null && _a !== void 0 ? _a : contentTitle) !== null && _b !== void 0 ? _b : parsedBlogFileName.text;
-    const description = (_d = (_c = frontMatter.description) !== null && _c !== void 0 ? _c : excerpt) !== null && _d !== void 0 ? _d : '';
+    const title = frontMatter.title ?? contentTitle ?? parsedBlogFileName.text;
+    const description = frontMatter.description ?? excerpt ?? '';
     const slug = frontMatter.slug || parsedBlogFileName.slug;
     const permalink = (0, utils_1.normalizeUrl)([baseUrl, routeBasePath, slug]);
     function getBlogEditUrl() {
@@ -208,7 +207,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
                     defaultReadingTime,
                 })
                 : undefined,
-            truncated: (truncateMarker === null || truncateMarker === void 0 ? void 0 : truncateMarker.test(content)) || false,
+            truncated: truncateMarker?.test(content) || false,
             authors,
             frontMatter,
         },

package/lib/feed.js

@@ -10,9 +10,9 @@ exports.createBlogFeedFiles = void 0;
 const tslib_1 = require("tslib");
 const feed_1 = require("feed");
 const utils_1 = require("@docusaurus/utils");
-const cheerio_1 = (0, tslib_1.__importDefault)(require("cheerio"));
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
+const cheerio_1 = tslib_1.__importDefault(require("cheerio"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const utils_common_1 = require("@docusaurus/utils-common");
 async function generateBlogFeed({ blogPosts, options, siteConfig, outDir, }) {
     if (!blogPosts.length) {
@@ -33,9 +33,7 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, outDir, }) {
         copyright: feedOptions.copyright,
     });
     function toFeedAuthor(author) {
-        // TODO ask author emails?
-        // RSS feed requires email to render authors
-        return { name: author.name, link: author.url };
+        return { name: author.name, link: author.url, email: author.email };
     }
     await (0, utils_1.mapAsyncSequential)(blogPosts, async (post) => {
         const { id, metadata: { title: metadataTitle, permalink, date, description, authors, tags, }, } = post;

package/lib/index.js

@@ -8,15 +8,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
 const tslib_1 = require("tslib");
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const remark_admonitions_1 = (0, tslib_1.__importDefault)(require("remark-admonitions"));
+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 translations_1 = require("./translations");
 const pluginOptionSchema_1 = require("./pluginOptionSchema");
 const blogUtils_1 = require("./blogUtils");
 const feed_1 = require("./feed");
 async function pluginContentBlog(context, options) {
-    var _a;
     if (options.admonitions) {
         options.remarkPlugins = options.remarkPlugins.concat([
             [remark_admonitions_1.default, options.admonitions],
@@ -33,7 +32,7 @@ async function pluginContentBlog(context, options) {
             pluginId: options.id,
         }),
     };
-    const pluginId = (_a = options.id) !== null && _a !== void 0 ? _a : utils_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/${(0, utils_1.posixPath)(path_1.default.relative(pluginDataDirRoot, source))}`;
@@ -334,15 +333,14 @@ async function pluginContentBlog(context, options) {
             });
         },
         injectHtmlTags({ content }) {
-            var _a, _b;
             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 feedTitle = (_b = options.feedOptions.title) !== null && _b !== void 0 ? _b : context.siteConfig.title;
+            const feedTitle = options.feedOptions.title ?? context.siteConfig.title;
             const feedsConfig = {
                 rss: {
                     type: 'application/rss+xml',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "2.0.0-beta.16",
+  "version": "2.0.0-beta.17",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,12 +18,12 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.16",
-    "@docusaurus/logger": "2.0.0-beta.16",
-    "@docusaurus/mdx-loader": "2.0.0-beta.16",
-    "@docusaurus/utils": "2.0.0-beta.16",
-    "@docusaurus/utils-common": "2.0.0-beta.16",
-    "@docusaurus/utils-validation": "2.0.0-beta.16",
+    "@docusaurus/core": "2.0.0-beta.17",
+    "@docusaurus/logger": "2.0.0-beta.17",
+    "@docusaurus/mdx-loader": "2.0.0-beta.17",
+    "@docusaurus/utils": "2.0.0-beta.17",
+    "@docusaurus/utils-common": "2.0.0-beta.17",
+    "@docusaurus/utils-validation": "2.0.0-beta.17",
     "cheerio": "^1.0.0-rc.10",
     "feed": "^4.2.2",
     "fs-extra": "^10.0.1",
@@ -35,7 +35,7 @@
     "webpack": "^5.69.1"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.16",
+    "@docusaurus/types": "2.0.0-beta.17",
     "escape-string-regexp": "^4.0.0"
   },
   "peerDependencies": {
@@ -45,5 +45,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "eb43c4d4f95a4fb97dc9bb9dc615413e0dc2e1e7"
+  "gitHead": "0032c0b0480083227af2e1b4da2d3ee6ce992403"
 }

package/src/authors.ts

@@ -24,6 +24,7 @@ const AuthorsMapSchema = Joi.object<AuthorsMap>().pattern(
     url: URISchema,
     imageURL: URISchema,
     title: Joi.string(),
+    email: Joi.string(),
   })
     .rename('image_url', 'imageURL')
     .or('name', 'imageURL')

package/src/feed.ts

@@ -57,9 +57,7 @@ async function generateBlogFeed({
   });
 
   function toFeedAuthor(author: Author): FeedAuthor {
-    // TODO ask author emails?
-    // RSS feed requires email to render authors
-    return {name: author.name, link: author.url};
+    return {name: author.name, link: author.url, email: author.email};
   }
 
   await mapAsyncSequential(blogPosts, async (post) => {

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

@@ -21,6 +21,7 @@ declare module '@docusaurus/plugin-content-blog' {
     imageURL?: string;
     url?: string;
     title?: string;
+    email?: string;
   }
 
   export type BlogPostFrontMatter = {