@docusaurus/plugin-content-blog 3.7.0 → 3.8.0

package/assets/atom.xsl

@@ -71,7 +71,7 @@
           <div class="blog-posts">
             <xsl:for-each select="atom:feed/atom:entry">
               <div class="blog-post">
-                <h3><a href="{atom:link[@rel='alternate']/@href}"><xsl:value-of
+                <h3><a href="{atom:link/@href}"><xsl:value-of
                       select="atom:title"
                     /></a></h3>
                 <div class="blog-post-date">

package/lib/blogUtils.js

@@ -19,12 +19,12 @@ const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const reading_time_1 = tslib_1.__importDefault(require("reading-time"));
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const frontMatter_1 = require("./frontMatter");
 const authors_1 = require("./authors");
 const authorsProblems_1 = require("./authorsProblems");
+const readingTime_1 = require("./readingTime");
 function truncate(fileString, truncateMarker) {
     return fileString.split(truncateMarker, 1).shift();
 }
@@ -130,7 +130,7 @@ async function parseBlogPostMarkdownFile({ filePath, parseFrontMatter, }) {
         throw err;
     }
 }
-const defaultReadingTime = ({ content, options }) => (0, reading_time_1.default)(content, options).minutes;
+const defaultReadingTime = ({ content, locale, options }) => (0, readingTime_1.calculateReadingTime)(content, locale, options);
 async function processBlogSourceFile(blogSourceRelative, contentPaths, context, options, tagsFile, authorsMap) {
     const { siteConfig: { baseUrl, markdown: { parseFrontMatter }, }, siteDir, i18n, } = context;
     const { routeBasePath, tagsBasePath: tagsRouteBasePath, truncateMarker, showReadingTime, editUrl, } = options;
@@ -238,6 +238,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
                     content,
                     frontMatter,
                     defaultReadingTime,
+                    locale: i18n.currentLocale,
                 })
                 : undefined,
             hasTruncateMarker: truncateMarker.test(content),

package/lib/options.js

@@ -51,7 +51,7 @@ exports.DEFAULT_OPTIONS = {
     path: 'blog',
     editLocalizedFiles: false,
     authorsMapPath: 'authors.yml',
-    readingTime: ({ content, defaultReadingTime }) => defaultReadingTime({ content }),
+    readingTime: ({ content, defaultReadingTime, locale }) => defaultReadingTime({ content, locale }),
     sortPosts: 'descending',
     showLastUpdateTime: false,
     showLastUpdateAuthor: false,

package/lib/readingTime.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+/**
+ * Calculates the reading time for a given content string using Intl.Segmenter.
+ * @param content The text content to calculate reading time for.
+ * @param locale Required locale string for Intl.Segmenter
+ * @param options Options for reading time calculation.
+ *   - wordsPerMinute: number of words per minute (default 200)
+ * @returns Estimated reading time in minutes (float, rounded to 2 decimals)
+ */
+export declare function calculateReadingTime(content: string, locale: string, options?: {
+    wordsPerMinute?: number;
+}): number;

package/lib/readingTime.js

@@ -0,0 +1,45 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateReadingTime = calculateReadingTime;
+const DEFAULT_WORDS_PER_MINUTE = 200;
+/**
+ * Counts the number of words in a string using Intl.Segmenter.
+ * @param content The text content to count words in.
+ * @param locale The locale to use for segmentation.
+ */
+function countWords(content, locale) {
+    if (!content) {
+        return 0;
+    }
+    const segmenter = new Intl.Segmenter(locale, { granularity: 'word' });
+    let wordCount = 0;
+    for (const { isWordLike } of segmenter.segment(content)) {
+        if (isWordLike) {
+            wordCount += 1;
+        }
+    }
+    return wordCount;
+}
+/**
+ * Calculates the reading time for a given content string using Intl.Segmenter.
+ * @param content The text content to calculate reading time for.
+ * @param locale Required locale string for Intl.Segmenter
+ * @param options Options for reading time calculation.
+ *   - wordsPerMinute: number of words per minute (default 200)
+ * @returns Estimated reading time in minutes (float, rounded to 2 decimals)
+ */
+function calculateReadingTime(content, locale, options) {
+    const wordsPerMinute = options?.wordsPerMinute ?? DEFAULT_WORDS_PER_MINUTE;
+    const words = countWords(content, locale);
+    if (words === 0) {
+        return 0;
+    }
+    // Calculate reading time in minutes and round to 2 decimal places
+    return Math.round((words / wordsPerMinute) * 100) / 100;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,19 +31,19 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.7.0",
-    "@docusaurus/logger": "3.7.0",
-    "@docusaurus/mdx-loader": "3.7.0",
-    "@docusaurus/theme-common": "3.7.0",
-    "@docusaurus/types": "3.7.0",
-    "@docusaurus/utils": "3.7.0",
-    "@docusaurus/utils-common": "3.7.0",
-    "@docusaurus/utils-validation": "3.7.0",
+    "@docusaurus/core": "3.8.0",
+    "@docusaurus/logger": "3.8.0",
+    "@docusaurus/mdx-loader": "3.8.0",
+    "@docusaurus/theme-common": "3.8.0",
+    "@docusaurus/types": "3.8.0",
+    "@docusaurus/utils": "3.8.0",
+    "@docusaurus/utils-common": "3.8.0",
+    "@docusaurus/utils-validation": "3.8.0",
     "cheerio": "1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
     "lodash": "^4.17.21",
-    "reading-time": "^1.5.0",
+    "schema-dts": "^1.1.2",
     "srcset": "^4.0.0",
     "tslib": "^2.6.0",
     "unist-util-visit": "^5.0.0",
@@ -62,5 +62,5 @@
     "@total-typescript/shoehorn": "^0.1.2",
     "tree-node-cli": "^1.6.0"
   },
-  "gitHead": "dd59750c16fe6908a26f18806a54d4c3dbe6db43"
+  "gitHead": "948d63c42fad0ba24b7b531a9deb6167e64dc845"
 }

package/src/blogUtils.ts

@@ -9,7 +9,6 @@ import fs from 'fs-extra';
 import path from 'path';
 import _ from 'lodash';
 import logger from '@docusaurus/logger';
-import readingTime from 'reading-time';
 import {
   parseMarkdownFile,
   normalizeUrl,
@@ -32,6 +31,7 @@ import {getTagsFile} from '@docusaurus/utils-validation';
 import {validateBlogPostFrontMatter} from './frontMatter';
 import {getBlogPostAuthors} from './authors';
 import {reportAuthorsProblems} from './authorsProblems';
+import {calculateReadingTime} from './readingTime';
 import type {TagsFile} from '@docusaurus/utils';
 import type {LoadContext, ParseFrontMatter} from '@docusaurus/types';
 import type {
@@ -210,8 +210,8 @@ async function parseBlogPostMarkdownFile({
   }
 }
 
-const defaultReadingTime: ReadingTimeFunction = ({content, options}) =>
-  readingTime(content, options).minutes;
+const defaultReadingTime: ReadingTimeFunction = ({content, locale, options}) =>
+  calculateReadingTime(content, locale, options);
 
 async function processBlogSourceFile(
   blogSourceRelative: string,
@@ -373,6 +373,7 @@ async function processBlogSourceFile(
             content,
             frontMatter,
             defaultReadingTime,
+            locale: i18n.currentLocale,
           })
         : undefined,
       hasTruncateMarker: truncateMarker.test(content),

package/src/options.ts

@@ -63,7 +63,8 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   path: 'blog',
   editLocalizedFiles: false,
   authorsMapPath: 'authors.yml',
-  readingTime: ({content, defaultReadingTime}) => defaultReadingTime({content}),
+  readingTime: ({content, defaultReadingTime, locale}) =>
+    defaultReadingTime({content, locale}),
   sortPosts: 'descending',
   showLastUpdateTime: false,
   showLastUpdateAuthor: false,

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

@@ -16,7 +16,12 @@ declare module '@docusaurus/plugin-content-blog' {
     FrontMatterLastUpdate,
     TagsPluginOptions,
   } from '@docusaurus/utils';
-  import type {DocusaurusConfig, Plugin, LoadContext} from '@docusaurus/types';
+  import type {
+    DocusaurusConfig,
+    Plugin,
+    LoadContext,
+    OptionValidationContext,
+  } from '@docusaurus/types';
   import type {Item as FeedItem} from 'feed';
   import type {Overwrite} from 'utility-types';
 
@@ -382,15 +387,10 @@ declare module '@docusaurus/plugin-content-blog' {
   };
 
   /**
-   * Duplicate from ngryman/reading-time to keep stability of API.
+   * Options for reading time calculation using Intl.Segmenter.
    */
   type ReadingTimeOptions = {
     wordsPerMinute?: number;
-    /**
-     * @param char The character to be matched.
-     * @returns `true` if this character is a word bound.
-     */
-    wordBound?: (char: string) => boolean;
   };
 
   /**
@@ -400,24 +400,22 @@ declare module '@docusaurus/plugin-content-blog' {
   export type ReadingTimeFunction = (params: {
     /** Markdown content. */
     content: string;
+    /** Locale for word segmentation. */
+    locale: string;
     /** Front matter. */
     frontMatter?: BlogPostFrontMatter & {[key: string]: unknown};
-    /** Options accepted by ngryman/reading-time. */
+    /** Options for reading time calculation. */
     options?: ReadingTimeOptions;
   }) => number;
 
   /**
-   * @returns The reading time directly plugged into metadata. `undefined` to
-   * hide reading time for a specific post.
+   * @returns The reading time directly plugged into metadata.
+   * `undefined` to hide reading time for a specific post.
    */
   export type ReadingTimeFunctionOption = (
-    /**
-     * The `options` is not provided by the caller; the user can inject their
-     * own option values into `defaultReadingTime`
-     */
     params: Required<Omit<Parameters<ReadingTimeFunction>[0], 'options'>> & {
       /**
-       * The default reading time implementation from ngryman/reading-time.
+       * The default reading time implementation.
        */
       defaultReadingTime: ReadingTimeFunction;
     },
@@ -666,6 +664,10 @@ declare module '@docusaurus/plugin-content-blog' {
     context: LoadContext,
     options: PluginOptions,
   ): Promise<Plugin<BlogContent>>;
+
+  export function validateOptions(
+    args: OptionValidationContext<Options | undefined, PluginOptions>,
+  ): PluginOptions;
 }
 
 declare module '@theme/BlogPostPage' {

package/src/readingTime.ts

@@ -0,0 +1,49 @@
+/**
+ * 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.
+ */
+
+const DEFAULT_WORDS_PER_MINUTE = 200;
+
+/**
+ * Counts the number of words in a string using Intl.Segmenter.
+ * @param content The text content to count words in.
+ * @param locale The locale to use for segmentation.
+ */
+function countWords(content: string, locale: string): number {
+  if (!content) {
+    return 0;
+  }
+  const segmenter = new Intl.Segmenter(locale, {granularity: 'word'});
+  let wordCount = 0;
+  for (const {isWordLike} of segmenter.segment(content)) {
+    if (isWordLike) {
+      wordCount += 1;
+    }
+  }
+  return wordCount;
+}
+
+/**
+ * Calculates the reading time for a given content string using Intl.Segmenter.
+ * @param content The text content to calculate reading time for.
+ * @param locale Required locale string for Intl.Segmenter
+ * @param options Options for reading time calculation.
+ *   - wordsPerMinute: number of words per minute (default 200)
+ * @returns Estimated reading time in minutes (float, rounded to 2 decimals)
+ */
+export function calculateReadingTime(
+  content: string,
+  locale: string,
+  options?: {wordsPerMinute?: number},
+): number {
+  const wordsPerMinute = options?.wordsPerMinute ?? DEFAULT_WORDS_PER_MINUTE;
+  const words = countWords(content, locale);
+  if (words === 0) {
+    return 0;
+  }
+  // Calculate reading time in minutes and round to 2 decimal places
+  return Math.round((words / wordsPerMinute) * 100) / 100;
+}

package/src/remark/footnoteIDFixer.ts

@@ -6,7 +6,6 @@
  */
 
 import {simpleHash} from '@docusaurus/utils';
-// @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
 import type {Transformer} from 'unified';
 import type {FootnoteReference, FootnoteDefinition} from 'mdast';