only disable warnings + fix frontmatter date type

facebook · May 14, 2021 · 3a65621 · 3a65621
1 parent 28cb3aa
commit 3a65621
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 22 deletions.
diff --git a/packages/docusaurus-plugin-content-blog/src/blogFrontMatter.ts b/packages/docusaurus-plugin-content-blog/src/blogFrontMatter.ts
@@ -20,7 +20,7 @@ export type BlogPostFrontMatter = {
   tags?: (string | Tag)[];
   slug?: string;
   draft?: boolean;
-  date?: string;
+  date?: Date;
 
   author?: string;
   author_title?: string;
@@ -66,18 +66,13 @@ const BlogFrontMatterSchema = Joi.object<BlogPostFrontMatter>({
   keywords: Joi.array().items(Joi.string().required()),
   hide_table_of_contents: Joi.boolean(),
 
-  /*
-  TODO re-enable later, our v1 blog posts use those frontmatter fields
-  authorURL: Joi.string().uri().warning('deprecate.error', {
-    alternative: '"author_url"',
-  }),
-  authorTitle: Joi.string().warning('deprecate.error', {
-    alternative: '"author_title"',
-  }),
-  authorImageURL: Joi.string().uri().warning('deprecate.error', {
-    alternative: '"author_image_url"',
-  }),
-   */
+  // TODO re-enable warnings later, our v1 blog posts use those older frontmatter fields
+  authorURL: Joi.string().uri(),
+  // .warning('deprecate.error', { alternative: '"author_url"'}),
+  authorTitle: Joi.string(),
+  // .warning('deprecate.error', { alternative: '"author_title"'}),
+  authorImageURL: Joi.string().uri(),
+  // .warning('deprecate.error', { alternative: '"author_image_url"'}),
 })
   .unknown()
   .messages({

diff --git a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts
@@ -46,7 +46,7 @@ export function getSourceToPermalink(
 
 // YYYY-MM-DD-{name}.mdx?
 // Prefer named capture, but older Node versions do not support it.
-const FILENAME_PATTERN = /^(\d{4}-\d{1,2}-\d{1,2})-?(.*?).mdx?$/;
+const DATE_FILENAME_PATTERN = /^(\d{4}-\d{1,2}-\d{1,2})-?(.*?).mdx?$/;
 
 function toUrl({date, link}: DateLink) {
   return `${date
@@ -165,24 +165,24 @@ export async function generateBlogPosts(
         );
       }
 
-      let date;
+      let date: Date | undefined;
       // Extract date and title from filename.
-      const match = blogFileName.match(FILENAME_PATTERN);
+      const dateFilenameMatch = blogFileName.match(DATE_FILENAME_PATTERN);
       let linkName = blogFileName.replace(/\.mdx?$/, '');
 
-      if (match) {
-        const [, dateString, name] = match;
+      if (dateFilenameMatch) {
+        const [, dateString, name] = dateFilenameMatch;
         date = new Date(dateString);
         linkName = name;
       }
 
       // Prefer user-defined date.
       if (frontMatter.date) {
-        date = new Date(frontMatter.date);
+        date = frontMatter.date;
       }
 
       // Use file create time for blog.
-      date = date || (await fs.stat(source)).birthtime;
+      date = date ?? (await fs.stat(source)).birthtime;
       const formattedDate = new Intl.DateTimeFormat(i18n.currentLocale, {
         day: 'numeric',
         month: 'long',
@@ -193,7 +193,8 @@ export async function generateBlogPosts(
       const description = frontMatter.description ?? excerpt ?? '';
 
       const slug =
-        frontMatter.slug || (match ? toUrl({date, link: linkName}) : linkName);
+        frontMatter.slug ||
+        (dateFilenameMatch ? toUrl({date, link: linkName}) : linkName);
 
       const permalink = normalizeUrl([baseUrl, routeBasePath, slug]);
 

diff --git a/packages/docusaurus-utils-validation/src/validationUtils.ts b/packages/docusaurus-utils-validation/src/validationUtils.ts
@@ -114,7 +114,7 @@ export function validateFrontMatter<T>(
 
   if (error) {
     const frontMatterString = JSON.stringify(frontMatter, null, 2);
-    const errorDetails = (error as Joi.ValidationError).details;
+    const errorDetails = error.details;
     const invalidFields = errorDetails.map(({path}) => path).join(', ');
     const errorMessages = errorDetails
       .map(({message}) => ` - ${message}`)