@docusaurus/plugin-content-blog 3.7.0-canary-6313 → 3.7.0-canary-6315

package/lib/blogUtils.js

@@ -130,7 +130,7 @@ async function parseBlogPostMarkdownFile({ filePath, parseFrontMatter, }) {
         throw err;
     }
 }
-const defaultReadingTime = ({ content, options }) => (0, readingTime_1.calculateReadingTime)(content, options);
+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

@@ -4,13 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-interface ReadingTimeOptions {
-    wordsPerMinute?: number;
-    wordBound?: (char: string) => boolean;
-}
 /**
- * Calculates the reading time for a given content string.
- * Uses the reading-time package under the hood.
+ * 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, options?: ReadingTimeOptions): number;
-export {};
+export declare function calculateReadingTime(content: string, locale: string, options?: {
+    wordsPerMinute?: number;
+}): number;

package/lib/readingTime.js

@@ -7,16 +7,39 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.calculateReadingTime = calculateReadingTime;
-const tslib_1 = require("tslib");
-const reading_time_1 = tslib_1.__importDefault(require("reading-time"));
 const DEFAULT_WORDS_PER_MINUTE = 200;
 /**
- * Calculates the reading time for a given content string.
- * Uses the reading-time package under the hood.
+ * 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 calculateReadingTime(content, options = {}) {
-    const wordsPerMinute = options.wordsPerMinute ?? DEFAULT_WORDS_PER_MINUTE;
-    const { wordBound } = options;
-    return (0, reading_time_1.default)(content, { wordsPerMinute, ...(wordBound && { wordBound }) })
-        .minutes;
+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-canary-6313",
+  "version": "3.7.0-canary-6315",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,19 +31,18 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.7.0-canary-6313",
-    "@docusaurus/logger": "3.7.0-canary-6313",
-    "@docusaurus/mdx-loader": "3.7.0-canary-6313",
-    "@docusaurus/theme-common": "3.7.0-canary-6313",
-    "@docusaurus/types": "3.7.0-canary-6313",
-    "@docusaurus/utils": "3.7.0-canary-6313",
-    "@docusaurus/utils-common": "3.7.0-canary-6313",
-    "@docusaurus/utils-validation": "3.7.0-canary-6313",
+    "@docusaurus/core": "3.7.0-canary-6315",
+    "@docusaurus/logger": "3.7.0-canary-6315",
+    "@docusaurus/mdx-loader": "3.7.0-canary-6315",
+    "@docusaurus/theme-common": "3.7.0-canary-6315",
+    "@docusaurus/types": "3.7.0-canary-6315",
+    "@docusaurus/utils": "3.7.0-canary-6315",
+    "@docusaurus/utils-common": "3.7.0-canary-6315",
+    "@docusaurus/utils-validation": "3.7.0-canary-6315",
     "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",
@@ -63,5 +62,5 @@
     "@total-typescript/shoehorn": "^0.1.2",
     "tree-node-cli": "^1.6.0"
   },
-  "gitHead": "9e3b01a35981d62fc38c796b6e358d488c8fe5fe"
+  "gitHead": "9cf2656b9b5ba64585ab220c91a0dbbac9758ae4"
 }

package/src/blogUtils.ts

@@ -210,8 +210,8 @@ async function parseBlogPostMarkdownFile({
   }
 }
 
-const defaultReadingTime: ReadingTimeFunction = ({content, options}) =>
-  calculateReadingTime(content, options);
+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

@@ -387,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;
   };
 
   /**
@@ -405,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;
     },

package/src/readingTime.ts

@@ -5,25 +5,45 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import readingTime from 'reading-time';
-
 const DEFAULT_WORDS_PER_MINUTE = 200;
 
-interface ReadingTimeOptions {
-  wordsPerMinute?: number;
-  wordBound?: (char: string) => boolean;
+/**
+ * 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.
- * Uses the reading-time package under the hood.
+ * 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,
-  options: ReadingTimeOptions = {},
+  locale: string,
+  options?: {wordsPerMinute?: number},
 ): number {
-  const wordsPerMinute = options.wordsPerMinute ?? DEFAULT_WORDS_PER_MINUTE;
-  const {wordBound} = options;
-  return readingTime(content, {wordsPerMinute, ...(wordBound && {wordBound})})
-    .minutes;
+  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;
 }