@docusaurus/plugin-content-blog 3.7.0-canary-6292 → 3.7.0-canary-6296

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, options }) => (0, readingTime_1.calculateReadingTime)(content, 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;

package/lib/readingTime.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+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.
+ */
+export declare function calculateReadingTime(content: string, options?: ReadingTimeOptions): number;
+export {};

package/lib/readingTime.js

@@ -0,0 +1,22 @@
+"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 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.
+ */
+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;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "3.7.0-canary-6292",
+  "version": "3.7.0-canary-6296",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,14 +31,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.7.0-canary-6292",
-    "@docusaurus/logger": "3.7.0-canary-6292",
-    "@docusaurus/mdx-loader": "3.7.0-canary-6292",
-    "@docusaurus/theme-common": "3.7.0-canary-6292",
-    "@docusaurus/types": "3.7.0-canary-6292",
-    "@docusaurus/utils": "3.7.0-canary-6292",
-    "@docusaurus/utils-common": "3.7.0-canary-6292",
-    "@docusaurus/utils-validation": "3.7.0-canary-6292",
+    "@docusaurus/core": "3.7.0-canary-6296",
+    "@docusaurus/logger": "3.7.0-canary-6296",
+    "@docusaurus/mdx-loader": "3.7.0-canary-6296",
+    "@docusaurus/theme-common": "3.7.0-canary-6296",
+    "@docusaurus/types": "3.7.0-canary-6296",
+    "@docusaurus/utils": "3.7.0-canary-6296",
+    "@docusaurus/utils-common": "3.7.0-canary-6296",
+    "@docusaurus/utils-validation": "3.7.0-canary-6296",
     "cheerio": "1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -63,5 +63,5 @@
     "@total-typescript/shoehorn": "^0.1.2",
     "tree-node-cli": "^1.6.0"
   },
-  "gitHead": "202a6243823c4fdc0ae16d50fb72193fc1fd7d6a"
+  "gitHead": "f7529479014cdcbe2569fa315724be244d554531"
 }

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 {
@@ -211,7 +211,7 @@ async function parseBlogPostMarkdownFile({
 }
 
 const defaultReadingTime: ReadingTimeFunction = ({content, options}) =>
-  readingTime(content, options).minutes;
+  calculateReadingTime(content, options);
 
 async function processBlogSourceFile(
   blogSourceRelative: string,

package/src/readingTime.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 readingTime from 'reading-time';
+
+const DEFAULT_WORDS_PER_MINUTE = 200;
+
+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.
+ */
+export function calculateReadingTime(
+  content: string,
+  options: ReadingTimeOptions = {},
+): number {
+  const wordsPerMinute = options.wordsPerMinute ?? DEFAULT_WORDS_PER_MINUTE;
+  const {wordBound} = options;
+  return readingTime(content, {wordsPerMinute, ...(wordBound && {wordBound})})
+    .minutes;
+}