@docusaurus/plugin-content-blog 0.0.0-4342 → 0.0.0-4351

package/lib/authors.d.ts

@@ -4,17 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Author, BlogContentPaths } from './types';
-import { BlogPostFrontMatter } from './blogFrontMatter';
+import type { Author, BlogContentPaths } from './types';
+import type { BlogPostFrontMatter } from './blogFrontMatter';
 export declare type AuthorsMap = Record<string, Author>;
-export declare function validateAuthorsMapFile(content: unknown): AuthorsMap;
-export declare function readAuthorsMapFile(filePath: string): Promise<AuthorsMap | undefined>;
-declare type AuthorsMapParams = {
+export declare function validateAuthorsMap(content: unknown): AuthorsMap;
+export declare function getAuthorsMap(params: {
     authorsMapPath: string;
     contentPaths: BlogContentPaths;
-};
-export declare function getAuthorsMapFilePath({ authorsMapPath, contentPaths, }: AuthorsMapParams): Promise<string | undefined>;
-export declare function getAuthorsMap(params: AuthorsMapParams): Promise<AuthorsMap | undefined>;
+}): Promise<AuthorsMap | undefined>;
 declare type AuthorsParam = {
     frontMatter: BlogPostFrontMatter;
     authorsMap: AuthorsMap | undefined;

package/lib/authors.js

@@ -6,15 +6,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 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 logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
+exports.getBlogPostAuthors = exports.getAuthorsMap = exports.validateAuthorsMap = void 0;
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
-const blogUtils_1 = require("./blogUtils");
-const js_yaml_1 = (0, tslib_1.__importDefault)(require("js-yaml"));
 const AuthorsMapSchema = utils_validation_1.Joi.object().pattern(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
     name: utils_validation_1.Joi.string().required(),
     url: utils_validation_1.URISchema,
@@ -24,48 +18,16 @@ const AuthorsMapSchema = utils_validation_1.Joi.object().pattern(utils_validatio
     .rename('image_url', 'imageURL')
     .unknown()
     .required());
-function validateAuthorsMapFile(content) {
+function validateAuthorsMap(content) {
     return utils_validation_1.Joi.attempt(content, AuthorsMapSchema);
 }
-exports.validateAuthorsMapFile = validateAuthorsMapFile;
-async function readAuthorsMapFile(filePath) {
-    if (await fs_extra_1.default.pathExists(filePath)) {
-        const contentString = await fs_extra_1.default.readFile(filePath, { encoding: 'utf8' });
-        try {
-            const unsafeContent = js_yaml_1.default.load(contentString);
-            return validateAuthorsMapFile(unsafeContent);
-        }
-        catch (e) {
-            // TODO replace later by error cause: see https://v8.dev/features/error-cause
-            logger_1.default.error('The author list file looks invalid!');
-            throw e;
-        }
-    }
-    return undefined;
-}
-exports.readAuthorsMapFile = readAuthorsMapFile;
-async function getAuthorsMapFilePath({ authorsMapPath, contentPaths, }) {
-    // Useful to load an eventually localize authors map
-    const contentPath = await (0, utils_1.findFolderContainingFile)((0, blogUtils_1.getContentPathList)(contentPaths), authorsMapPath);
-    if (contentPath) {
-        return path_1.default.join(contentPath, authorsMapPath);
-    }
-    return undefined;
-}
-exports.getAuthorsMapFilePath = getAuthorsMapFilePath;
+exports.validateAuthorsMap = validateAuthorsMap;
 async function getAuthorsMap(params) {
-    const filePath = await getAuthorsMapFilePath(params);
-    if (!filePath) {
-        return undefined;
-    }
-    try {
-        return await readAuthorsMapFile(filePath);
-    }
-    catch (e) {
-        // TODO replace later by error cause, see https://v8.dev/features/error-cause
-        logger_1.default.error `Couldn't read blog authors map at path=${filePath}`;
-        throw e;
-    }
+    return (0, utils_1.getDataFileData)({
+        filePath: params.authorsMapPath,
+        contentPaths: params.contentPaths,
+        fileType: 'authors map',
+    }, validateAuthorsMap);
 }
 exports.getAuthorsMap = getAuthorsMap;
 // Legacy v1/early-v2 frontmatter fields

package/lib/blogUtils.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { PluginOptions, BlogPost, BlogContentPaths, BlogMarkdownLoaderOptions, BlogTags } from './types';
-import { LoadContext } from '@docusaurus/types';
+import type { PluginOptions, BlogPost, BlogContentPaths, BlogMarkdownLoaderOptions, BlogTags } from './types';
+import type { LoadContext } from '@docusaurus/types';
 export declare function truncate(fileString: string, truncateMarker: RegExp): string;
 export declare function getSourceToPermalink(blogPosts: BlogPost[]): Record<string, string>;
 export declare function getBlogTags(blogPosts: BlogPost[]): BlogTags;
@@ -21,5 +21,4 @@ export declare type LinkifyParams = {
     fileString: string;
 } & Pick<BlogMarkdownLoaderOptions, 'sourceToPermalink' | 'siteDir' | 'contentPaths' | 'onBrokenMarkdownLink'>;
 export declare function linkify({ filePath, contentPaths, fileString, siteDir, sourceToPermalink, onBrokenMarkdownLink, }: LinkifyParams): string;
-export declare function getContentPathList(contentPaths: BlogContentPaths): string[];
 export {};

package/lib/blogUtils.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getContentPathList = exports.linkify = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.getSourceToPermalink = exports.truncate = void 0;
+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 path_1 = (0, tslib_1.__importDefault)(require("path"));
@@ -80,7 +80,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
     const { siteConfig: { baseUrl }, siteDir, i18n, } = context;
     const { routeBasePath, tagsBasePath: tagsRouteBasePath, truncateMarker, showReadingTime, editUrl, } = options;
     // Lookup in localized folder in priority
-    const blogDirPath = await (0, utils_1.getFolderContainingFile)(getContentPathList(contentPaths), blogSourceRelative);
+    const blogDirPath = await (0, utils_1.getFolderContainingFile)((0, utils_1.getContentPathList)(contentPaths), blogSourceRelative);
     const blogSourceAbsolute = path_1.default.join(blogDirPath, blogSourceRelative);
     const { frontMatter, content, contentTitle, excerpt } = await parseBlogPostMarkdownFile(blogSourceAbsolute);
     const aliasedSource = (0, utils_1.aliasedSitePath)(blogSourceAbsolute, siteDir);
@@ -203,8 +203,3 @@ function linkify({ filePath, contentPaths, fileString, siteDir, sourceToPermalin
     return newContent;
 }
 exports.linkify = linkify;
-// Order matters: we look in priority in localized folder
-function getContentPathList(contentPaths) {
-    return [contentPaths.contentPathLocalized, contentPaths.contentPath];
-}
-exports.getContentPathList = getContentPathList;

package/lib/feed.d.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Feed } from 'feed';
-import { PluginOptions, BlogPost } from './types';
-import { DocusaurusConfig } from '@docusaurus/types';
+import type { PluginOptions, BlogPost } from './types';
+import type { DocusaurusConfig } from '@docusaurus/types';
 export declare function generateBlogFeed({ blogPosts, options, siteConfig, }: {
     blogPosts: BlogPost[];
     options: PluginOptions;

package/lib/index.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { PluginOptions, BlogContent } from './types';
-import { LoadContext, Plugin, OptionValidationContext, ValidationResult } from '@docusaurus/types';
+import type { PluginOptions, BlogContent } from './types';
+import type { LoadContext, Plugin, OptionValidationContext, ValidationResult } from '@docusaurus/types';
 export default function pluginContentBlog(context: LoadContext, options: PluginOptions): Promise<Plugin<BlogContent>>;
 export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions>;

package/lib/index.js

@@ -15,7 +15,6 @@ const translations_1 = require("./translations");
 const pluginOptionSchema_1 = require("./pluginOptionSchema");
 const blogUtils_1 = require("./blogUtils");
 const feed_1 = require("./feed");
-const authors_1 = require("./authors");
 async function pluginContentBlog(context, options) {
     var _a;
     if (options.admonitions) {
@@ -38,15 +37,15 @@ async 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/${(0, utils_1.posixPath)(path_1.default.relative(pluginDataDirRoot, source))}`;
-    const authorsMapFilePath = await (0, authors_1.getAuthorsMapFilePath)({
-        authorsMapPath: options.authorsMapPath,
+    const authorsMapFilePath = await (0, utils_1.getDataFilePath)({
+        filePath: options.authorsMapPath,
         contentPaths,
     });
     return {
         name: 'docusaurus-plugin-content-blog',
         getPathsToWatch() {
             const { include } = options;
-            const contentMarkdownGlobs = (0, blogUtils_1.getContentPathList)(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
+            const contentMarkdownGlobs = (0, utils_1.getContentPathList)(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
             return [authorsMapFilePath, ...contentMarkdownGlobs].filter(Boolean);
         },
         async getTranslationFiles() {
@@ -275,7 +274,7 @@ async function pluginContentBlog(context, options) {
                     (0, utils_1.reportMessage)(`Blog markdown link couldn't be resolved: (${brokenMarkdownLink.link}) in ${brokenMarkdownLink.filePath}`, onBrokenMarkdownLinks);
                 },
             };
-            const contentDirs = (0, blogUtils_1.getContentPathList)(contentPaths);
+            const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
             return {
                 resolve: {
                     alias: {

package/lib/markdownLoader.d.ts

@@ -4,6 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { BlogMarkdownLoaderOptions } from './types';
+import type { BlogMarkdownLoaderOptions } from './types';
 import type { LoaderContext } from 'webpack';
 export default function markdownLoader(this: LoaderContext<BlogMarkdownLoaderOptions>, source: string): void;

package/lib/pluginOptionSchema.d.ts

@@ -5,6 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
-import { PluginOptions } from './types';
+import type { PluginOptions } from './types';
 export declare const DEFAULT_OPTIONS: PluginOptions;
 export declare const PluginOptionSchema: Joi.ObjectSchema<PluginOptions>;

package/lib/types.d.ts

@@ -7,8 +7,8 @@
 import type { RemarkAndRehypePluginOptions } from '@docusaurus/mdx-loader';
 import type { Tag } from '@docusaurus/utils';
 import type { BrokenMarkdownLink, ContentPaths } from '@docusaurus/utils/lib/markdownLinks';
-import { Overwrite } from 'utility-types';
-import { BlogPostFrontMatter } from './blogFrontMatter';
+import type { Overwrite } from 'utility-types';
+import type { BlogPostFrontMatter } from './blogFrontMatter';
 export declare type BlogContentPaths = ContentPaths;
 export interface BlogContent {
     blogSidebarTitle: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-4342",
+  "version": "0.0.0-4351",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,16 +18,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4342",
-    "@docusaurus/logger": "0.0.0-4342",
-    "@docusaurus/mdx-loader": "0.0.0-4342",
-    "@docusaurus/utils": "0.0.0-4342",
-    "@docusaurus/utils-validation": "0.0.0-4342",
+    "@docusaurus/core": "0.0.0-4351",
+    "@docusaurus/logger": "0.0.0-4351",
+    "@docusaurus/mdx-loader": "0.0.0-4351",
+    "@docusaurus/utils": "0.0.0-4351",
+    "@docusaurus/utils-validation": "0.0.0-4351",
     "escape-string-regexp": "^4.0.0",
     "feed": "^4.2.2",
     "fs-extra": "^10.0.0",
     "globby": "^11.0.2",
-    "js-yaml": "^4.0.0",
     "loader-utils": "^2.0.0",
     "lodash": "^4.17.20",
     "reading-time": "^1.5.0",
@@ -37,7 +36,7 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4342"
+    "@docusaurus/types": "0.0.0-4351"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -46,5 +45,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "e9ef727d5f5fefa96d92ad98fa61f3e3e961dd1d"
+  "gitHead": "6633ee41d0b5c670e9e4c18fb6ddd9c8bb05a41b"
 }

package/src/authors.ts

@@ -5,19 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import fs from 'fs-extra';
-import logger from '@docusaurus/logger';
-import path from 'path';
-import {Author, BlogContentPaths} from './types';
-import {findFolderContainingFile} from '@docusaurus/utils';
+import type {Author, BlogContentPaths} from './types';
+import {getDataFileData} from '@docusaurus/utils';
 import {Joi, URISchema} from '@docusaurus/utils-validation';
-import {
+import type {
   BlogPostFrontMatter,
   BlogPostFrontMatterAuthor,
   BlogPostFrontMatterAuthors,
 } from './blogFrontMatter';
-import {getContentPathList} from './blogUtils';
-import Yaml from 'js-yaml';
 
 export type AuthorsMap = Record<string, Author>;
 
@@ -34,63 +29,22 @@ const AuthorsMapSchema = Joi.object<AuthorsMap>().pattern(
     .required(),
 );
 
-export function validateAuthorsMapFile(content: unknown): AuthorsMap {
+export function validateAuthorsMap(content: unknown): AuthorsMap {
   return Joi.attempt(content, AuthorsMapSchema);
 }
 
-export async function readAuthorsMapFile(
-  filePath: string,
-): Promise<AuthorsMap | undefined> {
-  if (await fs.pathExists(filePath)) {
-    const contentString = await fs.readFile(filePath, {encoding: 'utf8'});
-    try {
-      const unsafeContent = Yaml.load(contentString);
-      return validateAuthorsMapFile(unsafeContent);
-    } catch (e) {
-      // TODO replace later by error cause: see https://v8.dev/features/error-cause
-      logger.error('The author list file looks invalid!');
-      throw e;
-    }
-  }
-  return undefined;
-}
-
-type AuthorsMapParams = {
+export async function getAuthorsMap(params: {
   authorsMapPath: string;
   contentPaths: BlogContentPaths;
-};
-
-export async function getAuthorsMapFilePath({
-  authorsMapPath,
-  contentPaths,
-}: AuthorsMapParams): Promise<string | undefined> {
-  // Useful to load an eventually localize authors map
-  const contentPath = await findFolderContainingFile(
-    getContentPathList(contentPaths),
-    authorsMapPath,
+}): Promise<AuthorsMap | undefined> {
+  return getDataFileData(
+    {
+      filePath: params.authorsMapPath,
+      contentPaths: params.contentPaths,
+      fileType: 'authors map',
+    },
+    validateAuthorsMap,
   );
-
-  if (contentPath) {
-    return path.join(contentPath, authorsMapPath);
-  }
-
-  return undefined;
-}
-
-export async function getAuthorsMap(
-  params: AuthorsMapParams,
-): Promise<AuthorsMap | undefined> {
-  const filePath = await getAuthorsMapFilePath(params);
-  if (!filePath) {
-    return undefined;
-  }
-  try {
-    return await readAuthorsMapFile(filePath);
-  } catch (e) {
-    // TODO replace later by error cause, see https://v8.dev/features/error-cause
-    logger.error`Couldn't read blog authors map at path=${filePath}`;
-    throw e;
-  }
 }
 
 type AuthorsParam = {

package/src/blogUtils.ts

@@ -9,7 +9,7 @@ import fs from 'fs-extra';
 import path from 'path';
 import readingTime from 'reading-time';
 import {keyBy, mapValues} from 'lodash';
-import {
+import type {
   PluginOptions,
   BlogPost,
   BlogContentPaths,
@@ -28,10 +28,11 @@ import {
   Globby,
   normalizeFrontMatterTags,
   groupTaggedItems,
+  getContentPathList,
 } from '@docusaurus/utils';
-import {LoadContext} from '@docusaurus/types';
+import type {LoadContext} from '@docusaurus/types';
 import {validateBlogPostFrontMatter} from './blogFrontMatter';
-import {AuthorsMap, getAuthorsMap, getBlogPostAuthors} from './authors';
+import {type AuthorsMap, getAuthorsMap, getBlogPostAuthors} from './authors';
 import logger from '@docusaurus/logger';
 
 export function truncate(fileString: string, truncateMarker: RegExp): string {
@@ -318,8 +319,3 @@ export function linkify({
 
   return newContent;
 }
-
-// Order matters: we look in priority in localized folder
-export function getContentPathList(contentPaths: BlogContentPaths): string[] {
-  return [contentPaths.contentPathLocalized, contentPaths.contentPath];
-}

package/src/feed.ts

@@ -5,10 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {Feed, Author as FeedAuthor, Item as FeedItem} from 'feed';
-import {PluginOptions, Author, BlogPost, FeedType} from './types';
+import {Feed, type Author as FeedAuthor, type Item as FeedItem} from 'feed';
+import type {PluginOptions, Author, BlogPost, FeedType} from './types';
 import {normalizeUrl, mdxToHtml} from '@docusaurus/utils';
-import {DocusaurusConfig} from '@docusaurus/types';
+import type {DocusaurusConfig} from '@docusaurus/types';
 import path from 'path';
 import fs from 'fs-extra';
 

package/src/index.ts

@@ -16,11 +16,13 @@ import {
   posixPath,
   addTrailingPathSeparator,
   createAbsoluteFilePathMatcher,
+  getContentPathList,
+  getDataFilePath,
   DEFAULT_PLUGIN_ID,
 } from '@docusaurus/utils';
 import {translateContent, getTranslationFiles} from './translations';
 
-import {
+import type {
   PluginOptions,
   BlogTags,
   BlogContent,
@@ -33,7 +35,7 @@ import {
   Assets,
 } from './types';
 import {PluginOptionSchema} from './pluginOptionSchema';
-import {
+import type {
   LoadContext,
   ConfigureWebpackUtils,
   Props,
@@ -42,16 +44,14 @@ import {
   OptionValidationContext,
   ValidationResult,
 } from '@docusaurus/types';
-import {Configuration} from 'webpack';
+import type {Configuration} from 'webpack';
 import {
   generateBlogPosts,
-  getContentPathList,
   getSourceToPermalink,
   getBlogTags,
 } from './blogUtils';
-import {BlogPostFrontMatter} from './blogFrontMatter';
+import type {BlogPostFrontMatter} from './blogFrontMatter';
 import {createBlogFeedFiles} from './feed';
-import {getAuthorsMapFilePath} from './authors';
 
 export default async function pluginContentBlog(
   context: LoadContext,
@@ -90,8 +90,8 @@ export default async function pluginContentBlog(
   const aliasedSource = (source: string) =>
     `~blog/${posixPath(path.relative(pluginDataDirRoot, source))}`;
 
-  const authorsMapFilePath = await getAuthorsMapFilePath({
-    authorsMapPath: options.authorsMapPath,
+  const authorsMapFilePath = await getDataFilePath({
+    filePath: options.authorsMapPath,
     contentPaths,
   });
 

package/src/markdownLoader.ts

@@ -7,7 +7,7 @@
 
 import {truncate, linkify} from './blogUtils';
 import {parseQuery} from 'loader-utils';
-import {BlogMarkdownLoaderOptions} from './types';
+import type {BlogMarkdownLoaderOptions} from './types';
 import type {LoaderContext} from 'webpack';
 
 export default function markdownLoader(

package/src/pluginOptionSchema.ts

@@ -13,7 +13,7 @@ import {
   URISchema,
 } from '@docusaurus/utils-validation';
 import {GlobExcludeDefault} from '@docusaurus/utils';
-import {PluginOptions} from './types';
+import type {PluginOptions} from './types';
 
 export const DEFAULT_OPTIONS: PluginOptions = {
   feedOptions: {type: ['rss', 'atom'], copyright: ''},

package/src/types.ts

@@ -11,8 +11,8 @@ import type {
   BrokenMarkdownLink,
   ContentPaths,
 } from '@docusaurus/utils/lib/markdownLinks';
-import {Overwrite} from 'utility-types';
-import {BlogPostFrontMatter} from './blogFrontMatter';
+import type {Overwrite} from 'utility-types';
+import type {BlogPostFrontMatter} from './blogFrontMatter';
 
 export type BlogContentPaths = ContentPaths;