feat: onUntruncatedBlogPost blog options

facebook · Aug 5, 2024 · bbb522d · bbb522d
1 parent 7be1fea
commit bbb522d
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 0 deletions.
diff --git a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts
@@ -47,6 +47,24 @@ export function truncate(fileString: string, truncateMarker: RegExp): string {
   return fileString.split(truncateMarker, 1).shift()!;
 }
 
+function reportTruncateMarkerProblem({
+  blogSourceRelative,
+  truncateMarker,
+  options,
+  content,
+}: {
+  content: string;
+  truncateMarker: RegExp;
+  blogSourceRelative: string;
+  options: Pick<PluginOptions, 'onUntruncatedBlogPost'>;
+}): void {
+  if (!truncateMarker.test(content)) {
+    logger.report(options.onUntruncatedBlogPost)(
+      logger.interpolate`Blog post path=${blogSourceRelative} is not truncated.`,
+    );
+  }
+}
+
 export function paginateBlogPosts({
   blogPosts,
   basePageUrl,
@@ -228,6 +246,13 @@ async function processBlogSourceFile(
       parseFrontMatter,
     });
 
+  reportTruncateMarkerProblem({
+    blogSourceRelative,
+    truncateMarker,
+    options,
+    content,
+  });
+
   const aliasedSource = aliasedSitePath(blogSourceAbsolute, siteDir);
 
   const lastUpdate = await readLastUpdateData(

diff --git a/packages/docusaurus-plugin-content-blog/src/options.ts b/packages/docusaurus-plugin-content-blog/src/options.ts
@@ -72,6 +72,7 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   tags: undefined,
   authorsBasePath: 'authors',
   onInlineAuthors: 'warn',
+  onUntruncatedBlogPost: '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),
+  onUntruncatedBlogPost: Joi.string()
+    .equal('ignore', 'log', 'warn', 'throw')
+    .default(DEFAULT_OPTIONS.onUntruncatedBlogPost),
 }).default(DEFAULT_OPTIONS);
 
 export function validateOptions({

diff --git a/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts b/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts
@@ -521,6 +521,7 @@ declare module '@docusaurus/plugin-content-blog' {
       authorsBasePath: string;
       /** The behavior of Docusaurus when it finds inline authors. */
       onInlineAuthors: 'ignore' | 'log' | 'warn' | 'throw';
+      onUntruncatedBlogPost: 'ignore' | 'log' | 'warn' | 'throw';
     };
 
   export type UserFeedXSLTOptions =

diff --git a/website/_dogfooding/dogfooding.config.ts b/website/_dogfooding/dogfooding.config.ts
@@ -99,6 +99,7 @@ export const dogfoodingPluginInstances: PluginConfig[] = [
           : defaultReadingTime({content, options: {wordsPerMinute: 5}}),
       onInlineTags: 'warn',
       onInlineAuthors: 'ignore',
+      onUntruncatedBlogPost: 'ignore',
       tags: 'tags.yml',
     } satisfies BlogOptions,
   ],

diff --git a/website/docs/api/plugins/plugin-content-blog.mdx b/website/docs/api/plugins/plugin-content-blog.mdx
@@ -85,6 +85,7 @@ Accepted fields:
 | `showLastUpdateTime` | `boolean` | `false` | Whether to display the last date the blog post was updated. This requires access to git history during the build, so will not work correctly with shallow clones (a common default for CI systems). With GitHub `actions/checkout`, use`fetch-depth: 0`. |
 | `tags` | `string \| false \| null \| undefined` | `tags.yml` | Path to the YAML tags file listing pre-defined tags. Relative to the blog content directory. |
 | `onInlineTags` | `'ignore' \| 'log' \| 'warn' \| 'throw'` | `warn` | The plugin behavior when blog posts contain inline tags (not appearing in the list of pre-defined tags, usually `tags.yml`). |
+| `onUntruncatedBlogPost` | `'ignore' \| 'log' \| 'warn' \| 'throw'` | `warn` | The plugin behavior when blog posts does not contain truncate marker |
 
 ```mdx-code-block
 </APITable>

diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -475,6 +475,7 @@ export default async function createConfigAsync() {
           blog: {
             // routeBasePath: '/',
             path: 'blog',
+            onUntruncatedBlogPost: 'throw',
             showLastUpdateAuthor: true,
             showLastUpdateTime: true,
             editUrl: ({locale, blogDirPath, blogPath}) => {