@docusaurus/plugin-content-blog 0.0.0-4288 → 0.0.0-4297

package/lib/authors.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBlogPostAuthors = exports.getAuthorsMap = exports.getAuthorsMapFilePath = exports.readAuthorsMapFile = exports.validateAuthorsMapFile = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
@@ -37,7 +37,7 @@ async function readAuthorsMapFile(filePath) {
         }
         catch (e) {
             // TODO replace later by error cause: see https://v8.dev/features/error-cause
-            console.error(chalk_1.default.red('The author list file looks invalid!'));
+            logger_1.default.error('The author list file looks invalid!');
             throw e;
         }
     }
@@ -63,7 +63,7 @@ async function getAuthorsMap(params) {
     }
     catch (e) {
         // TODO replace later by error cause, see https://v8.dev/features/error-cause
-        console.error(chalk_1.default.red(`Couldn't read blog authors map at path ${filePath}`));
+        logger_1.default.error `Couldn't read blog authors map at path=${filePath}`;
         throw e;
     }
 }

package/lib/blogUtils.js

@@ -9,13 +9,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getContentPathList = exports.linkify = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.getSourceToPermalink = exports.truncate = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const reading_time_1 = (0, tslib_1.__importDefault)(require("reading-time"));
 const lodash_1 = 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"));
 function truncate(fileString, truncateMarker) {
     return fileString.split(truncateMarker, 1).shift();
 }
@@ -88,7 +88,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
         return undefined;
     }
     if (frontMatter.id) {
-        console.warn(chalk_1.default.yellow(`"id" header option is deprecated in ${blogSourceRelative} file. Please use "slug" option instead.`));
+        logger_1.default.warn `name=${'id'} header option is deprecated in path=${blogSourceRelative} file. Please use name=${'slug'} option instead.`;
     }
     const parsedBlogFileName = parseBlogFileName(blogSourceRelative);
     async function getDate() {
@@ -179,7 +179,7 @@ async function generateBlogPosts(contentPaths, context, options) {
             return await processBlogSourceFile(blogSourceFile, contentPaths, context, options, authorsMap);
         }
         catch (e) {
-            console.error(chalk_1.default.red(`Processing of blog source file failed for path "${blogSourceFile}"`));
+            logger_1.default.error `Processing of blog source file failed for path path=${blogSourceFile}.`;
             throw e;
         }
     }))).filter(Boolean);

package/lib/feed.js

@@ -51,23 +51,40 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, }) {
     }
     blogPosts.forEach((post) => {
         const { id, metadata: { title: metadataTitle, permalink, date, description, authors }, } = post;
-        feed.addItem({
+        const feedItem = {
             title: metadataTitle,
             id,
             link: (0, utils_1.normalizeUrl)([siteUrl, permalink]),
             date,
             description,
             content: mdxToFeedContent(post.content),
-            author: authors.map(toFeedAuthor),
-        });
+        };
+        // json1() method takes the first item of authors array
+        // it causes an error when authors array is empty
+        const feedItemAuthors = authors.map(toFeedAuthor);
+        if (feedItemAuthors.length > 0) {
+            feedItem.author = feedItemAuthors;
+        }
+        feed.addItem(feedItem);
     });
     return feed;
 }
 exports.generateBlogFeed = generateBlogFeed;
-async function createBlogFeedFile({ feed, feedType, filePath, }) {
-    const feedContent = feedType === 'rss' ? feed.rss2() : feed.atom1();
+async function createBlogFeedFile({ feed, feedType, generatePath, }) {
+    const [feedContent, feedPath] = (() => {
+        switch (feedType) {
+            case 'rss':
+                return [feed.rss2(), 'rss.xml'];
+            case 'json':
+                return [feed.json1(), 'feed.json'];
+            case 'atom':
+                return [feed.atom1(), 'atom.xml'];
+            default:
+                throw new Error(`Feed type ${feedType} not supported.`);
+        }
+    })();
     try {
-        await fs_extra_1.default.outputFile(filePath, feedContent);
+        await fs_extra_1.default.outputFile(path_1.default.join(generatePath, feedPath), feedContent);
     }
     catch (err) {
         throw new Error(`Generating ${feedType} feed failed: ${err}.`);
@@ -79,12 +96,10 @@ async function createBlogFeedFiles({ blogPosts, options, siteConfig, outDir, })
     if (!feed || !feedTypes) {
         return;
     }
-    await Promise.all(feedTypes.map(async (feedType) => {
-        await createBlogFeedFile({
-            feed,
-            feedType,
-            filePath: path_1.default.join(outDir, options.routeBasePath, `${feedType}.xml`),
-        });
-    }));
+    await Promise.all(feedTypes.map((feedType) => createBlogFeedFile({
+        feed,
+        feedType,
+        generatePath: path_1.default.join(outDir, options.routeBasePath),
+    })));
 }
 exports.createBlogFeedFiles = createBlogFeedFiles;

package/lib/index.js

@@ -364,6 +364,11 @@ function pluginContentBlog(context, options) {
                     path: 'atom.xml',
                     title: `${feedTitle} Atom Feed`,
                 },
+                json: {
+                    type: 'application/json',
+                    path: 'feed.json',
+                    title: `${feedTitle} JSON Feed`,
+                },
             };
             const headTags = [];
             feedTypes.forEach((feedType) => {

package/lib/pluginOptionSchema.js

@@ -74,8 +74,8 @@ exports.PluginOptionSchema = utils_validation_1.Joi.object({
     beforeDefaultRehypePlugins: utils_validation_1.RehypePluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRehypePlugins),
     feedOptions: utils_validation_1.Joi.object({
         type: utils_validation_1.Joi.alternatives()
-            .try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()), utils_validation_1.Joi.alternatives().conditional(utils_validation_1.Joi.string().equal('all', 'rss', 'atom'), {
-            then: utils_validation_1.Joi.custom((val) => val === 'all' ? ['rss', 'atom'] : [val]),
+            .try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().equal('rss', 'atom', 'json')), utils_validation_1.Joi.alternatives().conditional(utils_validation_1.Joi.string().equal('all', 'rss', 'atom', 'json'), {
+            then: utils_validation_1.Joi.custom((val) => val === 'all' ? ['rss', 'atom', 'json'] : [val]),
         }))
             .allow(null)
             .default(exports.DEFAULT_OPTIONS.feedOptions.type),

package/lib/types.d.ts

@@ -17,7 +17,7 @@ export interface BlogContent {
     blogTags: BlogTags;
     blogTagsListPath: string | null;
 }
-export declare type FeedType = 'rss' | 'atom';
+export declare type FeedType = 'rss' | 'atom' | 'json';
 export declare type FeedOptions = {
     type?: FeedType[] | null;
     title?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-4288",
+  "version": "0.0.0-4297",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,11 +18,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4288",
-    "@docusaurus/mdx-loader": "0.0.0-4288",
-    "@docusaurus/utils": "0.0.0-4288",
-    "@docusaurus/utils-validation": "0.0.0-4288",
-    "chalk": "^4.1.2",
+    "@docusaurus/core": "0.0.0-4297",
+    "@docusaurus/logger": "0.0.0-4297",
+    "@docusaurus/mdx-loader": "0.0.0-4297",
+    "@docusaurus/utils": "0.0.0-4297",
+    "@docusaurus/utils-validation": "0.0.0-4297",
     "escape-string-regexp": "^4.0.0",
     "feed": "^4.2.2",
     "fs-extra": "^10.0.0",
@@ -37,7 +37,7 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4288"
+    "@docusaurus/types": "0.0.0-4297"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -46,5 +46,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "7c22eff7031a837b8ed4810c896508e3a1756f2e"
+  "gitHead": "84ae34c33c664bf856f3a92047919a074e087d77"
 }

package/src/authors.ts

@@ -6,7 +6,7 @@
  */
 
 import fs from 'fs-extra';
-import chalk from 'chalk';
+import logger from '@docusaurus/logger';
 import path from 'path';
 import {Author, BlogContentPaths} from './types';
 import {findFolderContainingFile} from '@docusaurus/utils';
@@ -48,7 +48,7 @@ export async function readAuthorsMapFile(
       return validateAuthorsMapFile(unsafeContent);
     } catch (e) {
       // TODO replace later by error cause: see https://v8.dev/features/error-cause
-      console.error(chalk.red('The author list file looks invalid!'));
+      logger.error('The author list file looks invalid!');
       throw e;
     }
   }
@@ -88,9 +88,7 @@ export async function getAuthorsMap(
     return await readAuthorsMapFile(filePath);
   } catch (e) {
     // TODO replace later by error cause, see https://v8.dev/features/error-cause
-    console.error(
-      chalk.red(`Couldn't read blog authors map at path ${filePath}`),
-    );
+    logger.error`Couldn't read blog authors map at path=${filePath}`;
     throw e;
   }
 }

package/src/blogUtils.ts

@@ -6,7 +6,6 @@
  */
 
 import fs from 'fs-extra';
-import chalk from 'chalk';
 import path from 'path';
 import readingTime from 'reading-time';
 import {keyBy, mapValues} from 'lodash';
@@ -33,6 +32,7 @@ import {
 import {LoadContext} from '@docusaurus/types';
 import {validateBlogPostFrontMatter} from './blogFrontMatter';
 import {AuthorsMap, getAuthorsMap, getBlogPostAuthors} from './authors';
+import logger from '@docusaurus/logger';
 
 export function truncate(fileString: string, truncateMarker: RegExp): string {
   return fileString.split(truncateMarker, 1).shift()!;
@@ -151,11 +151,7 @@ async function processBlogSourceFile(
   }
 
   if (frontMatter.id) {
-    console.warn(
-      chalk.yellow(
-        `"id" header option is deprecated in ${blogSourceRelative} file. Please use "slug" option instead.`,
-      ),
-    );
+    logger.warn`name=${'id'} header option is deprecated in path=${blogSourceRelative} file. Please use name=${'slug'} option instead.`;
   }
 
   const parsedBlogFileName = parseBlogFileName(blogSourceRelative);
@@ -276,11 +272,7 @@ export async function generateBlogPosts(
             authorsMap,
           );
         } catch (e) {
-          console.error(
-            chalk.red(
-              `Processing of blog source file failed for path "${blogSourceFile}"`,
-            ),
-          );
+          logger.error`Processing of blog source file failed for path path=${blogSourceFile}.`;
           throw e;
         }
       }),

package/src/feed.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {Feed, Author as FeedAuthor} from 'feed';
+import {Feed, Author as FeedAuthor, Item as FeedItem} from 'feed';
 import {PluginOptions, Author, BlogPost, FeedType} from './types';
 import {normalizeUrl, mdxToHtml} from '@docusaurus/utils';
 import {DocusaurusConfig} from '@docusaurus/types';
@@ -68,15 +68,24 @@ export async function generateBlogFeed({
       id,
       metadata: {title: metadataTitle, permalink, date, description, authors},
     } = post;
-    feed.addItem({
+
+    const feedItem: FeedItem = {
       title: metadataTitle,
       id,
       link: normalizeUrl([siteUrl, permalink]),
       date,
       description,
       content: mdxToFeedContent(post.content),
-      author: authors.map(toFeedAuthor),
-    });
+    };
+
+    // json1() method takes the first item of authors array
+    // it causes an error when authors array is empty
+    const feedItemAuthors = authors.map(toFeedAuthor);
+    if (feedItemAuthors.length > 0) {
+      feedItem.author = feedItemAuthors;
+    }
+
+    feed.addItem(feedItem);
   });
 
   return feed;
@@ -85,15 +94,26 @@ export async function generateBlogFeed({
 async function createBlogFeedFile({
   feed,
   feedType,
-  filePath,
+  generatePath,
 }: {
   feed: Feed;
   feedType: FeedType;
-  filePath: string;
+  generatePath: string;
 }) {
-  const feedContent = feedType === 'rss' ? feed.rss2() : feed.atom1();
+  const [feedContent, feedPath] = (() => {
+    switch (feedType) {
+      case 'rss':
+        return [feed.rss2(), 'rss.xml'];
+      case 'json':
+        return [feed.json1(), 'feed.json'];
+      case 'atom':
+        return [feed.atom1(), 'atom.xml'];
+      default:
+        throw new Error(`Feed type ${feedType} not supported.`);
+    }
+  })();
   try {
-    await fs.outputFile(filePath, feedContent);
+    await fs.outputFile(path.join(generatePath, feedPath), feedContent);
   } catch (err) {
     throw new Error(`Generating ${feedType} feed failed: ${err}.`);
   }
@@ -118,12 +138,12 @@ export async function createBlogFeedFiles({
   }
 
   await Promise.all(
-    feedTypes.map(async (feedType) => {
-      await createBlogFeedFile({
+    feedTypes.map((feedType) =>
+      createBlogFeedFile({
         feed,
         feedType,
-        filePath: path.join(outDir, options.routeBasePath, `${feedType}.xml`),
-      });
-    }),
+        generatePath: path.join(outDir, options.routeBasePath),
+      }),
+    ),
   );
 }

package/src/index.ts

@@ -550,6 +550,11 @@ export default function pluginContentBlog(
           path: 'atom.xml',
           title: `${feedTitle} Atom Feed`,
         },
+        json: {
+          type: 'application/json',
+          path: 'feed.json',
+          title: `${feedTitle} JSON Feed`,
+        },
       };
       const headTags: HtmlTags = [];
 

package/src/pluginOptionSchema.ts

@@ -90,12 +90,12 @@ export const PluginOptionSchema = Joi.object<PluginOptions>({
   feedOptions: Joi.object({
     type: Joi.alternatives()
       .try(
-        Joi.array().items(Joi.string()),
+        Joi.array().items(Joi.string().equal('rss', 'atom', 'json')),
         Joi.alternatives().conditional(
-          Joi.string().equal('all', 'rss', 'atom'),
+          Joi.string().equal('all', 'rss', 'atom', 'json'),
           {
             then: Joi.custom((val) =>
-              val === 'all' ? ['rss', 'atom'] : [val],
+              val === 'all' ? ['rss', 'atom', 'json'] : [val],
             ),
           },
         ),

package/src/types.ts

@@ -24,7 +24,7 @@ export interface BlogContent {
   blogTagsListPath: string | null;
 }
 
-export type FeedType = 'rss' | 'atom';
+export type FeedType = 'rss' | 'atom' | 'json';
 
 export type FeedOptions = {
   type?: FeedType[] | null;