@docusaurus/plugin-content-blog 0.0.0-4521 → 0.0.0-4526

package/lib/authors.js

@@ -52,9 +52,9 @@ function getFrontMatterAuthorLegacy(frontMatter) {
 function normalizeFrontMatterAuthors(frontMatterAuthors = []) {
     function normalizeAuthor(authorInput) {
         if (typeof authorInput === 'string') {
-            // Technically, we could allow users to provide an author's name here
-            // IMHO it's better to only support keys here
-            // Reason: a typo in a key would fallback to becoming a name and may end-up un-noticed
+            // Technically, we could allow users to provide an author's name here, but
+            // we only support keys, otherwise, a typo in a key would fallback to
+            // becoming a name and may end up unnoticed
             return { key: authorInput };
         }
         return authorInput;
@@ -97,7 +97,8 @@ function getBlogPostAuthors(params) {
     const authorLegacy = getFrontMatterAuthorLegacy(params.frontMatter);
     const authors = getFrontMatterAuthors(params);
     if (authorLegacy) {
-        // Technically, we could allow mixing legacy/authors front matter, but do we really want to?
+        // Technically, we could allow mixing legacy/authors front matter, but do we
+        // really want to?
         if (authors.length > 0) {
             throw new Error(`To declare blog post authors, use the 'authors' front matter in priority.
 Don't mix 'authors' with other existing 'author_*' front matter. Choose one or the other, not both at the same time.`);

package/lib/blogUtils.js

@@ -33,7 +33,7 @@ function getBlogTags(blogPosts) {
     }));
 }
 exports.getBlogTags = getBlogTags;
-const DATE_FILENAME_REGEX = /^(?<folder>.*)(?<date>\d{4}[-/]\d{1,2}[-/]\d{1,2})[-/]?(?<text>.*?)(\/index)?.mdx?$/;
+const DATE_FILENAME_REGEX = /^(?<folder>.*)(?<date>\d{4}[-/]\d{1,2}[-/]\d{1,2})[-/]?(?<text>.*?)(?:\/index)?.mdx?$/;
 function parseBlogFileName(blogSourceRelative) {
     const dateFilenameMatch = blogSourceRelative.match(DATE_FILENAME_REGEX);
     if (dateFilenameMatch) {
@@ -44,11 +44,9 @@ function parseBlogFileName(blogSourceRelative) {
         const slug = `/${slugDate}/${folder}${text}`;
         return { date, text, slug };
     }
-    else {
-        const text = blogSourceRelative.replace(/(\/index)?\.mdx?$/, '');
-        const slug = `/${text}`;
-        return { date: undefined, text, slug };
-    }
+    const text = blogSourceRelative.replace(/(?:\/index)?\.mdx?$/, '');
+    const slug = `/${text}`;
+    return { date: undefined, text, slug };
 }
 exports.parseBlogFileName = parseBlogFileName;
 function formatBlogPostDate(locale, date) {

package/lib/index.js

@@ -193,7 +193,8 @@ async function pluginContentBlog(context, options) {
                     modules: {
                         sidebar: aliasedSource(sidebarProp),
                         items: items.map((postID) => 
-                        // To tell routes.js this is an import and not a nested object to recurse.
+                        // To tell routes.js this is an import and not a nested object
+                        // to recurse.
                         ({
                             content: {
                                 __import: true,
@@ -286,7 +287,7 @@ async function pluginContentBlog(context, options) {
                 module: {
                     rules: [
                         {
-                            test: /(\.mdx?)$/,
+                            test: /\.mdx?$/i,
                             include: contentDirs
                                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                                 .map(utils_1.addTrailingPathSeparator),
@@ -311,7 +312,8 @@ async function pluginContentBlog(context, options) {
                                         // For blog posts a title in markdown is always removed
                                         // Blog posts title are rendered separately
                                         removeContentTitle: true,
-                                        // Assets allow to convert some relative images paths to require() calls
+                                        // Assets allow to convert some relative images paths to
+                                        // require() calls
                                         createAssets: ({ frontMatter, metadata, }) => ({
                                             image: frontMatter.image,
                                             authorsImageUrls: metadata.authors.map((author) => author.imageURL),

package/lib/pluginOptionSchema.js

@@ -14,7 +14,7 @@ exports.DEFAULT_OPTIONS = {
     beforeDefaultRehypePlugins: [],
     beforeDefaultRemarkPlugins: [],
     admonitions: {},
-    truncateMarker: /<!--\s*(truncate)\s*-->/,
+    truncateMarker: /<!--\s*truncate\s*-->/,
     rehypePlugins: [],
     remarkPlugins: [],
     showReadingTime: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-4521",
+  "version": "0.0.0-4526",
   "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": "0.0.0-4521",
-    "@docusaurus/logger": "0.0.0-4521",
-    "@docusaurus/mdx-loader": "0.0.0-4521",
-    "@docusaurus/utils": "0.0.0-4521",
-    "@docusaurus/utils-common": "0.0.0-4521",
-    "@docusaurus/utils-validation": "0.0.0-4521",
+    "@docusaurus/core": "0.0.0-4526",
+    "@docusaurus/logger": "0.0.0-4526",
+    "@docusaurus/mdx-loader": "0.0.0-4526",
+    "@docusaurus/utils": "0.0.0-4526",
+    "@docusaurus/utils-common": "0.0.0-4526",
+    "@docusaurus/utils-validation": "0.0.0-4526",
     "cheerio": "^1.0.0-rc.10",
     "feed": "^4.2.2",
     "fs-extra": "^10.0.0",
@@ -35,7 +35,7 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4521",
+    "@docusaurus/types": "0.0.0-4526",
     "escape-string-regexp": "^4.0.0"
   },
   "peerDependencies": {
@@ -46,5 +46,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "10eacaa44e87420d300c367fc5e1538c21485767"
+  "gitHead": "3086e9e823783e306698097d959007f44de275b1"
 }

package/src/authors.ts

@@ -83,9 +83,9 @@ function normalizeFrontMatterAuthors(
     authorInput: string | BlogPostFrontMatterAuthor,
   ): BlogPostFrontMatterAuthor {
     if (typeof authorInput === 'string') {
-      // Technically, we could allow users to provide an author's name here
-      // IMHO it's better to only support keys here
-      // Reason: a typo in a key would fallback to becoming a name and may end-up un-noticed
+      // Technically, we could allow users to provide an author's name here, but
+      // we only support keys, otherwise, a typo in a key would fallback to
+      // becoming a name and may end up unnoticed
       return {key: authorInput};
     }
     return authorInput;
@@ -137,7 +137,8 @@ export function getBlogPostAuthors(params: AuthorsParam): Author[] {
   const authors = getFrontMatterAuthors(params);
 
   if (authorLegacy) {
-    // Technically, we could allow mixing legacy/authors front matter, but do we really want to?
+    // Technically, we could allow mixing legacy/authors front matter, but do we
+    // really want to?
     if (authors.length > 0) {
       throw new Error(
         `To declare blog post authors, use the 'authors' front matter in priority.

package/src/blogUtils.ts

@@ -63,7 +63,7 @@ export function getBlogTags(blogPosts: BlogPost[]): BlogTags {
 }
 
 const DATE_FILENAME_REGEX =
-  /^(?<folder>.*)(?<date>\d{4}[-/]\d{1,2}[-/]\d{1,2})[-/]?(?<text>.*?)(\/index)?.mdx?$/;
+  /^(?<folder>.*)(?<date>\d{4}[-/]\d{1,2}[-/]\d{1,2})[-/]?(?<text>.*?)(?:\/index)?.mdx?$/;
 
 type ParsedBlogFileName = {
   date: Date | undefined;
@@ -82,11 +82,10 @@ export function parseBlogFileName(
     const slugDate = dateString.replace(/-/g, '/');
     const slug = `/${slugDate}/${folder}${text}`;
     return {date, text, slug};
-  } else {
-    const text = blogSourceRelative.replace(/(\/index)?\.mdx?$/, '');
-    const slug = `/${text}`;
-    return {date: undefined, text, slug};
   }
+  const text = blogSourceRelative.replace(/(?:\/index)?\.mdx?$/, '');
+  const slug = `/${text}`;
+  return {date: undefined, text, slug};
 }
 
 function formatBlogPostDate(locale: string, date: Date): string {

package/src/index.ts

@@ -322,7 +322,8 @@ export default async function pluginContentBlog(
             modules: {
               sidebar: aliasedSource(sidebarProp),
               items: items.map((postID) =>
-                // To tell routes.js this is an import and not a nested object to recurse.
+                // To tell routes.js this is an import and not a nested object
+                // to recurse.
                 ({
                   content: {
                     __import: true,
@@ -451,7 +452,7 @@ export default async function pluginContentBlog(
         module: {
           rules: [
             {
-              test: /(\.mdx?)$/,
+              test: /\.mdx?$/i,
               include: contentDirs
                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                 .map(addTrailingPathSeparator),
@@ -485,7 +486,8 @@ export default async function pluginContentBlog(
                     // Blog posts title are rendered separately
                     removeContentTitle: true,
 
-                    // Assets allow to convert some relative images paths to require() calls
+                    // Assets allow to convert some relative images paths to
+                    // require() calls
                     createAssets: ({
                       frontMatter,
                       metadata,

package/src/pluginOptionSchema.ts

@@ -20,7 +20,7 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   beforeDefaultRehypePlugins: [],
   beforeDefaultRemarkPlugins: [],
   admonitions: {},
-  truncateMarker: /<!--\s*(truncate)\s*-->/,
+  truncateMarker: /<!--\s*truncate\s*-->/,
   rehypePlugins: [],
   remarkPlugins: [],
   showReadingTime: true,