@docusaurus/plugin-content-blog 0.0.0-6021 → 0.0.0-6023

package/lib/blogUtils.d.ts

@@ -8,6 +8,10 @@ import type { LoadContext } from '@docusaurus/types';
 import type { AuthorsMap, PluginOptions, BlogPost, BlogTags, BlogPaginated } from '@docusaurus/plugin-content-blog';
 import type { BlogContentPaths } from './types';
 export declare function truncate(fileString: string, truncateMarker: RegExp): string;
+export declare function reportUntruncatedBlogPosts({ blogPosts, onUntruncatedBlogPosts, }: {
+    blogPosts: BlogPost[];
+    onUntruncatedBlogPosts: PluginOptions['onUntruncatedBlogPosts'];
+}): void;
 export declare function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, pageBasePath, }: {
     blogPosts: BlogPost[];
     basePageUrl: string;

package/lib/blogUtils.js

@@ -7,6 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.truncate = truncate;
+exports.reportUntruncatedBlogPosts = reportUntruncatedBlogPosts;
 exports.paginateBlogPosts = paginateBlogPosts;
 exports.shouldBeListed = shouldBeListed;
 exports.getBlogTags = getBlogTags;
@@ -27,6 +28,19 @@ const authorsProblems_1 = require("./authorsProblems");
 function truncate(fileString, truncateMarker) {
     return fileString.split(truncateMarker, 1).shift();
 }
+function reportUntruncatedBlogPosts({ blogPosts, onUntruncatedBlogPosts, }) {
+    const untruncatedBlogPosts = blogPosts.filter((p) => !p.metadata.hasTruncateMarker);
+    if (onUntruncatedBlogPosts !== 'ignore' && untruncatedBlogPosts.length > 0) {
+        const message = logger_1.default.interpolate `Docusaurus found blog posts without truncation markers:
+- ${untruncatedBlogPosts
+            .map((p) => logger_1.default.path((0, utils_1.aliasedSitePathToRelativePath)(p.metadata.source)))
+            .join('\n- ')}
+
+We recommend using truncation markers (code=${`<!-- truncate -->`} or code=${`{/* truncate */}`}) in blog posts to create shorter previews on blog paginated lists.
+Tip: turn this security off with the code=${`onUntruncatedBlogPosts: 'ignore'`} blog plugin option.`;
+        logger_1.default.report(onUntruncatedBlogPosts)(message);
+    }
+}
 function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, pageBasePath, }) {
     const totalCount = blogPosts.length;
     const postsPerPage = postsPerPageOption === 'ALL' ? totalCount : postsPerPageOption;

package/lib/index.js

@@ -107,6 +107,10 @@ async function pluginContentBlog(context, options) {
                 blogPosts,
                 processBlogPosts: options.processBlogPosts,
             });
+            (0, blogUtils_1.reportUntruncatedBlogPosts)({
+                blogPosts,
+                onUntruncatedBlogPosts: options.onUntruncatedBlogPosts,
+            });
             const listedBlogPosts = blogPosts.filter(blogUtils_1.shouldBeListed);
             if (!blogPosts.length) {
                 return {

package/lib/options.js

@@ -60,6 +60,7 @@ exports.DEFAULT_OPTIONS = {
     tags: undefined,
     authorsBasePath: 'authors',
     onInlineAuthors: 'warn',
+    onUntruncatedBlogPosts: 'warn',
 };
 exports.XSLTBuiltInPaths = {
     rss: path_1.default.resolve(__dirname, '..', 'assets', 'rss.xsl'),
@@ -189,6 +190,9 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
     onInlineAuthors: utils_validation_1.Joi.string()
         .equal('ignore', 'log', 'warn', 'throw')
         .default(exports.DEFAULT_OPTIONS.onInlineAuthors),
+    onUntruncatedBlogPosts: utils_validation_1.Joi.string()
+        .equal('ignore', 'log', 'warn', 'throw')
+        .default(exports.DEFAULT_OPTIONS.onUntruncatedBlogPosts),
 }).default(exports.DEFAULT_OPTIONS);
 function validateOptions({ validate, options, }) {
     const validatedOptions = validate(PluginOptionSchema, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-6021",
+  "version": "0.0.0-6023",
   "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": "0.0.0-6021",
-    "@docusaurus/logger": "0.0.0-6021",
-    "@docusaurus/mdx-loader": "0.0.0-6021",
-    "@docusaurus/theme-common": "0.0.0-6021",
-    "@docusaurus/types": "0.0.0-6021",
-    "@docusaurus/utils": "0.0.0-6021",
-    "@docusaurus/utils-common": "0.0.0-6021",
-    "@docusaurus/utils-validation": "0.0.0-6021",
+    "@docusaurus/core": "0.0.0-6023",
+    "@docusaurus/logger": "0.0.0-6023",
+    "@docusaurus/mdx-loader": "0.0.0-6023",
+    "@docusaurus/theme-common": "0.0.0-6023",
+    "@docusaurus/types": "0.0.0-6023",
+    "@docusaurus/utils": "0.0.0-6023",
+    "@docusaurus/utils-common": "0.0.0-6023",
+    "@docusaurus/utils-validation": "0.0.0-6023",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -62,5 +62,5 @@
     "@total-typescript/shoehorn": "^0.1.2",
     "tree-node-cli": "^1.6.0"
   },
-  "gitHead": "7876673a736b8c3d5715a8edb6cb21bf464d9315"
+  "gitHead": "b639416f1286febfd49285f17a964371d2735afb"
 }

package/src/blogUtils.ts

@@ -26,6 +26,7 @@ import {
   isDraft,
   readLastUpdateData,
   normalizeTags,
+  aliasedSitePathToRelativePath,
 } from '@docusaurus/utils';
 import {getTagsFile} from '@docusaurus/utils-validation';
 import {validateBlogPostFrontMatter} from './frontMatter';
@@ -47,6 +48,28 @@ export function truncate(fileString: string, truncateMarker: RegExp): string {
   return fileString.split(truncateMarker, 1).shift()!;
 }
 
+export function reportUntruncatedBlogPosts({
+  blogPosts,
+  onUntruncatedBlogPosts,
+}: {
+  blogPosts: BlogPost[];
+  onUntruncatedBlogPosts: PluginOptions['onUntruncatedBlogPosts'];
+}): void {
+  const untruncatedBlogPosts = blogPosts.filter(
+    (p) => !p.metadata.hasTruncateMarker,
+  );
+  if (onUntruncatedBlogPosts !== 'ignore' && untruncatedBlogPosts.length > 0) {
+    const message = logger.interpolate`Docusaurus found blog posts without truncation markers:
+- ${untruncatedBlogPosts
+      .map((p) => logger.path(aliasedSitePathToRelativePath(p.metadata.source)))
+      .join('\n- ')}
+
+We recommend using truncation markers (code=${`<!-- truncate -->`} or code=${`{/* truncate */}`}) in blog posts to create shorter previews on blog paginated lists.
+Tip: turn this security off with the code=${`onUntruncatedBlogPosts: 'ignore'`} blog plugin option.`;
+    logger.report(onUntruncatedBlogPosts)(message);
+  }
+}
+
 export function paginateBlogPosts({
   blogPosts,
   basePageUrl,

package/src/index.ts

@@ -28,6 +28,7 @@ import {
   shouldBeListed,
   applyProcessBlogPosts,
   generateBlogPosts,
+  reportUntruncatedBlogPosts,
 } from './blogUtils';
 import footnoteIDFixer from './remark/footnoteIDFixer';
 import {translateContent, getTranslationFiles} from './translations';
@@ -189,6 +190,10 @@ export default async function pluginContentBlog(
         blogPosts,
         processBlogPosts: options.processBlogPosts,
       });
+      reportUntruncatedBlogPosts({
+        blogPosts,
+        onUntruncatedBlogPosts: options.onUntruncatedBlogPosts,
+      });
       const listedBlogPosts = blogPosts.filter(shouldBeListed);
 
       if (!blogPosts.length) {

package/src/options.ts

@@ -72,6 +72,7 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   tags: undefined,
   authorsBasePath: 'authors',
   onInlineAuthors: 'warn',
+  onUntruncatedBlogPosts: 'warn',
 };
 
 export const XSLTBuiltInPaths = {
@@ -240,6 +241,9 @@ const PluginOptionSchema = Joi.object<PluginOptions>({
   onInlineAuthors: Joi.string()
     .equal('ignore', 'log', 'warn', 'throw')
     .default(DEFAULT_OPTIONS.onInlineAuthors),
+  onUntruncatedBlogPosts: Joi.string()
+    .equal('ignore', 'log', 'warn', 'throw')
+    .default(DEFAULT_OPTIONS.onUntruncatedBlogPosts),
 }).default(DEFAULT_OPTIONS);
 
 export function validateOptions({

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

@@ -521,6 +521,8 @@ declare module '@docusaurus/plugin-content-blog' {
       authorsBasePath: string;
       /** The behavior of Docusaurus when it finds inline authors. */
       onInlineAuthors: 'ignore' | 'log' | 'warn' | 'throw';
+      /** The behavior of Docusaurus when it finds untruncated blog posts. */
+      onUntruncatedBlogPosts: 'ignore' | 'log' | 'warn' | 'throw';
     };
 
   export type UserFeedXSLTOptions =