@docusaurus/plugin-content-blog 3.10.1 → 4.0.0-canary-6808

package/assets/atom.css

@@ -11,7 +11,13 @@ main {
   margin: 2rem auto;
   max-width: 800px;
   /* stylelint-disable-next-line font-family-name-quotes */
-  font-family: system-ui, -apple-system, Segoe UI, Roboto, Ubuntu, Cantarell;
+  font-family:
+    system-ui,
+    -apple-system,
+    'Segoe UI',
+    Roboto,
+    Ubuntu,
+    Cantarell;
 }
 
 .info {

package/assets/atom.xsl

@@ -1,4 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
+<!--
+Copyright (c) Facebook, Inc. and its affiliates.
+
+This source code is licensed under the MIT license found in the
+LICENSE file in the root directory of this source tree.
+-->
 <xsl:stylesheet
   version="3.0"
   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"

package/assets/rss.css

@@ -11,7 +11,13 @@ main {
   margin: 2rem auto;
   max-width: 800px;
   /* stylelint-disable-next-line font-family-name-quotes */
-  font-family: system-ui, -apple-system, Segoe UI, Roboto, Ubuntu, Cantarell;
+  font-family:
+    system-ui,
+    -apple-system,
+    'Segoe UI',
+    Roboto,
+    Ubuntu,
+    Cantarell;
 }
 
 .info {

package/assets/rss.xsl

@@ -1,4 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
+<!--
+Copyright (c) Facebook, Inc. and its affiliates.
+
+This source code is licensed under the MIT license found in the
+LICENSE file in the root directory of this source tree.
+-->
 <xsl:stylesheet
   version="3.0"
   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"

package/lib/client/contexts.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { useMemo, useContext } from 'react';
-import { ReactContextError } from '@docusaurus/theme-common/internal';
+import { ReactContextError } from '@docusaurus/theme-common';
 import useRouteContext from '@docusaurus/useRouteContext';
 export function useBlogMetadata() {
     const routeContext = useRouteContext();

package/lib/client/structuredDataUtils.js

@@ -7,14 +7,22 @@
 import { useBaseUrlUtils } from '@docusaurus/useBaseUrl';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import { useBlogMetadata } from '@docusaurus/plugin-content-blog/client';
+import { applyTrailingSlash } from '@docusaurus/utils-common';
 import { useBlogPost } from './contexts';
 const convertDate = (dateMs) => new Date(dateMs).toISOString();
+function getAbsoluteUrl(permalink, siteConfig) {
+    const absoluteUrl = `${siteConfig.url}${permalink}`;
+    return applyTrailingSlash(absoluteUrl, {
+        trailingSlash: siteConfig.trailingSlash,
+        baseUrl: siteConfig.baseUrl,
+    });
+}
 function getBlogPost(blogPostContent, siteConfig, withBaseUrl) {
     const { assets, frontMatter, metadata } = blogPostContent;
     const { date, title, description, lastUpdatedAt } = metadata;
     const image = assets.image ?? frontMatter.image;
     const keywords = frontMatter.keywords ?? [];
-    const blogUrl = `${siteConfig.url}${metadata.permalink}`;
+    const blogUrl = getAbsoluteUrl(metadata.permalink, siteConfig);
     const dateModified = lastUpdatedAt ? convertDate(lastUpdatedAt) : undefined;
     return {
         '@type': 'BlogPosting',
@@ -53,7 +61,7 @@ export function useBlogListPageStructuredData(props) {
     const { siteConfig } = useDocusaurusContext();
     const { withBaseUrl } = useBaseUrlUtils();
     const { metadata: { blogDescription, blogTitle, permalink }, } = props;
-    const url = `${siteConfig.url}${permalink}`;
+    const url = getAbsoluteUrl(permalink, siteConfig);
     // details on structured data support: https://schema.org/Blog
     return {
         '@context': 'https://schema.org',
@@ -74,7 +82,7 @@ export function useBlogPostStructuredData() {
     const image = assets.image ?? frontMatter.image;
     const keywords = frontMatter.keywords ?? [];
     const dateModified = lastUpdatedAt ? convertDate(lastUpdatedAt) : undefined;
-    const url = `${siteConfig.url}${metadata.permalink}`;
+    const url = getAbsoluteUrl(metadata.permalink, siteConfig);
     // details on structured data support: https://schema.org/BlogPosting
     // BlogPosting is one of the structured data types that Google explicitly
     // supports: https://developers.google.com/search/docs/appearance/structured-data/article#structured-data-type-definitions
@@ -94,7 +102,7 @@ export function useBlogPostStructuredData() {
         ...(keywords ? { keywords } : {}),
         isPartOf: {
             '@type': 'Blog',
-            '@id': `${siteConfig.url}${blogMetadata.blogBasePath}`,
+            '@id': getAbsoluteUrl(blogMetadata.blogBasePath, siteConfig),
             name: blogMetadata.blogTitle,
         },
     };

package/lib/feed.js

@@ -12,7 +12,7 @@ const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const feed_1 = require("feed");
-const srcset = tslib_1.__importStar(require("srcset"));
+const srcset_1 = require("srcset");
 const utils_1 = require("@docusaurus/utils");
 const utils_common_1 = require("@docusaurus/utils-common");
 const cheerio_1 = require("cheerio");
@@ -80,7 +80,7 @@ async function defaultCreateFeedItems({ blogPosts, siteConfig, outDir, }) {
                     elm.attribs.src = toAbsoluteUrl(src);
                 }
                 if (srcsetAttr) {
-                    elm.attribs.srcset = srcset.stringify(srcset.parse(srcsetAttr).map((props) => ({
+                    elm.attribs.srcset = (0, srcset_1.stringifySrcset)((0, srcset_1.parseSrcset)(srcsetAttr).map((props) => ({
                         ...props,
                         url: toAbsoluteUrl(props.url),
                     })));
@@ -109,8 +109,8 @@ async function defaultCreateFeedItems({ blogPosts, siteConfig, outDir, }) {
 async function resolveXsltFilePaths({ xsltFilePath, contentPaths, }) {
     const xsltAbsolutePath = path_1.default.isAbsolute(xsltFilePath)
         ? xsltFilePath
-        : (await (0, utils_1.getDataFilePath)({ filePath: xsltFilePath, contentPaths })) ??
-            path_1.default.resolve(contentPaths.contentPath, xsltFilePath);
+        : ((await (0, utils_1.getDataFilePath)({ filePath: xsltFilePath, contentPaths })) ??
+            path_1.default.resolve(contentPaths.contentPath, xsltFilePath));
     if (!(await fs_extra_1.default.pathExists(xsltAbsolutePath))) {
         throw new Error(logger_1.default.interpolate `Blog feed XSLT file not found at path=${path_1.default.relative(process.cwd(), xsltAbsolutePath)}`);
     }

package/lib/frontMatter.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
 import type { BlogPostFrontMatter } from '@docusaurus/plugin-content-blog';
 export declare function validateBlogPostFrontMatter(frontMatter: {
     [key: string]: unknown;

package/lib/frontMatter.js

@@ -1,12 +1,13 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateBlogPostFrontMatter = validateBlogPostFrontMatter;
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/* eslint-disable camelcase */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateBlogPostFrontMatter = validateBlogPostFrontMatter;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const authorsSocials_1 = require("./authorsSocials");
 const BlogPostFrontMatterAuthorSchema = utils_validation_1.JoiFrontMatter.object({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "3.10.1",
+  "version": "4.0.0-canary-6808",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -19,7 +19,7 @@
   "scripts": {
     "build": "tsc --build",
     "watch": "tsc --build --watch",
-    "test:generate-build-snap": "yarn docusaurus build src/__tests__/__fixtures__/website --out-dir build-snap && yarn rimraf src/__tests__/__fixtures__/website/.docusaurus && yarn rimraf src/__tests__/__fixtures__/website/build-snap/assets && git add src/__tests__/__fixtures__/website/build-snap"
+    "test:generate-build-snap": "pnpm docusaurus build src/__tests__/__fixtures__/website --out-dir build-snap && pnpm rimraf src/__tests__/__fixtures__/website/.docusaurus && pnpm rimraf src/__tests__/__fixtures__/website/build-snap/assets && git add src/__tests__/__fixtures__/website/build-snap"
   },
   "repository": {
     "type": "git",
@@ -31,37 +31,37 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.10.1",
-    "@docusaurus/logger": "3.10.1",
-    "@docusaurus/mdx-loader": "3.10.1",
-    "@docusaurus/theme-common": "3.10.1",
-    "@docusaurus/types": "3.10.1",
-    "@docusaurus/utils": "3.10.1",
-    "@docusaurus/utils-common": "3.10.1",
-    "@docusaurus/utils-validation": "3.10.1",
-    "cheerio": "1.0.0-rc.12",
-    "combine-promises": "^1.1.0",
-    "feed": "^4.2.2",
-    "fs-extra": "^11.1.1",
-    "lodash": "^4.17.21",
-    "schema-dts": "^1.1.2",
-    "srcset": "^4.0.0",
-    "tslib": "^2.6.0",
-    "unist-util-visit": "^5.0.0",
-    "utility-types": "^3.10.0",
-    "webpack": "^5.88.1"
+    "@docusaurus/core": "4.0.0-canary-6808",
+    "@docusaurus/logger": "4.0.0-canary-6808",
+    "@docusaurus/mdx-loader": "4.0.0-canary-6808",
+    "@docusaurus/module-type-aliases": "4.0.0-canary-6808",
+    "@docusaurus/theme-common": "4.0.0-canary-6808",
+    "@docusaurus/types": "4.0.0-canary-6808",
+    "@docusaurus/utils": "4.0.0-canary-6808",
+    "@docusaurus/utils-common": "4.0.0-canary-6808",
+    "@docusaurus/utils-validation": "4.0.0-canary-6808",
+    "cheerio": "^1.2.0",
+    "combine-promises": "^1.2.0",
+    "feed": "^5.2.1",
+    "fs-extra": "^11.4.0",
+    "lodash": "^4.18.1",
+    "schema-dts": "^1.1.5",
+    "srcset": "^5.0.3",
+    "tslib": "^2.8.1",
+    "unist-util-visit": "^5.1.0",
+    "utility-types": "^3.11.0",
+    "webpack": "^5.110.3"
   },
   "peerDependencies": {
-    "@docusaurus/plugin-content-docs": "*",
-    "react": "^18.0.0 || ^19.0.0",
-    "react-dom": "^18.0.0 || ^19.0.0"
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0"
   },
   "engines": {
-    "node": ">=20.0"
+    "node": ">=24.14"
   },
   "devDependencies": {
     "@total-typescript/shoehorn": "^0.1.2",
-    "tree-node-cli": "^1.6.0"
+    "tree-node-cli": "^3.0.0"
   },
-  "gitHead": "41c1a458ecb07d61b6df2761ea4bc1b13db49d12"
+  "gitHead": "91e445730a91fbe20dd5fefae560303a0c655aa7"
 }

package/src/blogUtils.ts

@@ -415,7 +415,7 @@ export async function generateBlogPosts(
     } catch (err) {
       throw new Error(
         `Processing of blog source file path=${blogSourceFile} failed.`,
-        {cause: err as Error},
+        {cause: err},
       );
     }
   }

package/src/client/contexts.tsx

@@ -6,7 +6,7 @@
  */
 
 import React, {useMemo, type ReactNode, useContext} from 'react';
-import {ReactContextError} from '@docusaurus/theme-common/internal';
+import {ReactContextError} from '@docusaurus/theme-common';
 import useRouteContext from '@docusaurus/useRouteContext';
 
 import type {

package/src/client/sidebarUtils.test.ts

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import {describe, expect, it} from 'vitest';
 import {groupBlogSidebarItemsByYear} from './sidebarUtils';
 import type {BlogSidebarItem} from '@docusaurus/plugin-content-blog';
 

package/src/client/structuredDataUtils.ts

@@ -8,6 +8,7 @@
 import {useBaseUrlUtils, type BaseUrlUtils} from '@docusaurus/useBaseUrl';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import {useBlogMetadata} from '@docusaurus/plugin-content-blog/client';
+import {applyTrailingSlash} from '@docusaurus/utils-common';
 import type {Props as BlogListPageStructuredDataProps} from '@theme/BlogListPage/StructuredData';
 import {useBlogPost} from './contexts';
 
@@ -26,6 +27,17 @@ import type {DocusaurusConfig} from '@docusaurus/types';
 
 const convertDate = (dateMs: number) => new Date(dateMs).toISOString();
 
+function getAbsoluteUrl(
+  permalink: string,
+  siteConfig: DocusaurusConfig,
+): string {
+  const absoluteUrl = `${siteConfig.url}${permalink}`;
+  return applyTrailingSlash(absoluteUrl, {
+    trailingSlash: siteConfig.trailingSlash,
+    baseUrl: siteConfig.baseUrl,
+  });
+}
+
 function getBlogPost(
   blogPostContent: PropBlogPostContent,
   siteConfig: DocusaurusConfig,
@@ -37,7 +49,7 @@ function getBlogPost(
   const image = assets.image ?? frontMatter.image;
   const keywords = frontMatter.keywords ?? [];
 
-  const blogUrl = `${siteConfig.url}${metadata.permalink}`;
+  const blogUrl = getAbsoluteUrl(metadata.permalink, siteConfig);
 
   const dateModified = lastUpdatedAt ? convertDate(lastUpdatedAt) : undefined;
 
@@ -92,7 +104,7 @@ export function useBlogListPageStructuredData(
     metadata: {blogDescription, blogTitle, permalink},
   } = props;
 
-  const url = `${siteConfig.url}${permalink}`;
+  const url = getAbsoluteUrl(permalink, siteConfig);
 
   // details on structured data support: https://schema.org/Blog
   return {
@@ -121,7 +133,7 @@ export function useBlogPostStructuredData(): WithContext<BlogPosting> {
 
   const dateModified = lastUpdatedAt ? convertDate(lastUpdatedAt) : undefined;
 
-  const url = `${siteConfig.url}${metadata.permalink}`;
+  const url = getAbsoluteUrl(metadata.permalink, siteConfig);
 
   // details on structured data support: https://schema.org/BlogPosting
   // BlogPosting is one of the structured data types that Google explicitly
@@ -142,7 +154,7 @@ export function useBlogPostStructuredData(): WithContext<BlogPosting> {
     ...(keywords ? {keywords} : {}),
     isPartOf: {
       '@type': 'Blog',
-      '@id': `${siteConfig.url}${blogMetadata.blogBasePath}`,
+      '@id': getAbsoluteUrl(blogMetadata.blogBasePath, siteConfig),
       name: blogMetadata.blogTitle,
     },
   };

package/src/feed.ts

@@ -8,7 +8,7 @@
 import path from 'path';
 import fs from 'fs-extra';
 import {Feed, type Author as FeedAuthor} from 'feed';
-import * as srcset from 'srcset';
+import {parseSrcset, stringifySrcset} from 'srcset';
 import {
   getDataFilePath,
   normalizeUrl,
@@ -153,8 +153,8 @@ async function defaultCreateFeedItems({
               elm.attribs.src = toAbsoluteUrl(src);
             }
             if (srcsetAttr) {
-              elm.attribs.srcset = srcset.stringify(
-                srcset.parse(srcsetAttr).map((props) => ({
+              elm.attribs.srcset = stringifySrcset(
+                parseSrcset(srcsetAttr).map((props) => ({
                   ...props,
                   url: toAbsoluteUrl(props.url),
                 })),
@@ -196,8 +196,8 @@ async function resolveXsltFilePaths({
 }) {
   const xsltAbsolutePath: string = path.isAbsolute(xsltFilePath)
     ? xsltFilePath
-    : (await getDataFilePath({filePath: xsltFilePath, contentPaths})) ??
-      path.resolve(contentPaths.contentPath, xsltFilePath);
+    : ((await getDataFilePath({filePath: xsltFilePath, contentPaths})) ??
+      path.resolve(contentPaths.contentPath, xsltFilePath));
 
   if (!(await fs.pathExists(xsltAbsolutePath))) {
     throw new Error(
@@ -323,7 +323,7 @@ async function createBlogFeedFile({
     await fs.outputFile(outputPath, feedContent);
   } catch (err) {
     throw new Error(`Generating ${feedType} feed failed.`, {
-      cause: err as Error,
+      cause: err,
     });
   }
 }

package/src/frontMatter.ts

@@ -4,6 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/* eslint-disable camelcase */
+
 import {
   ContentVisibilitySchema,
   FrontMatterLastUpdateSchema,

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

@@ -7,8 +7,7 @@
 /// <reference types="@docusaurus/module-type-aliases" />
 
 declare module '@docusaurus/plugin-content-blog' {
-  import type {LoadedMDXContent} from '@docusaurus/mdx-loader';
-  import type {MDXOptions} from '@docusaurus/mdx-loader';
+  import type {LoadedMDXContent, MDXOptions} from '@docusaurus/mdx-loader';
   import type {
     FrontMatterTag,
     TagMetadata,