@docusaurus/plugin-content-blog 2.0.0-beta.677e53d4d → 2.0.0-beta.7

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "2.0.0-beta.677e53d4d",
+  "version": "2.0.0-beta.7",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
-  "types": "index.d.ts",
+  "types": "src/plugin-content-blog.d.ts",
   "scripts": {
     "build": "tsc",
     "watch": "tsc --watch"
@@ -18,21 +18,23 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.677e53d4d",
-    "@docusaurus/mdx-loader": "2.0.0-beta.677e53d4d",
-    "@docusaurus/types": "2.0.0-beta.677e53d4d",
-    "@docusaurus/utils": "2.0.0-beta.677e53d4d",
-    "@docusaurus/utils-validation": "2.0.0-beta.677e53d4d",
-    "chalk": "^4.1.1",
+    "@docusaurus/core": "2.0.0-beta.7",
+    "@docusaurus/mdx-loader": "2.0.0-beta.7",
+    "@docusaurus/types": "2.0.0-beta.7",
+    "@docusaurus/utils": "2.0.0-beta.7",
+    "@docusaurus/utils-validation": "2.0.0-beta.7",
+    "chalk": "^4.1.2",
     "escape-string-regexp": "^4.0.0",
     "feed": "^4.2.2",
     "fs-extra": "^10.0.0",
     "globby": "^11.0.2",
+    "js-yaml": "^4.0.0",
     "loader-utils": "^2.0.0",
     "lodash": "^4.17.20",
-    "reading-time": "^1.3.0",
+    "reading-time": "^1.5.0",
     "remark-admonitions": "^1.2.1",
-    "tslib": "^2.2.0",
+    "tslib": "^2.3.1",
+    "utility-types": "^3.10.0",
     "webpack": "^5.40.0"
   },
   "peerDependencies": {
@@ -42,5 +44,5 @@
   "engines": {
     "node": ">=12.13.0"
   },
-  "gitHead": "7fd8a4f8df207d6c603dec985604207d3b32a8bd"
+  "gitHead": "71a934b4d7319cd026657e3bb7e5832447454d07"
 }

package/src/__tests__/__fixtures__/authorsMapFiles/authors.json

@@ -0,0 +1,29 @@
+{
+  "JMarcey": {
+    "name": "Joel Marcey",
+    "title": "Technical Lead & Developer Advocate at Facebook",
+    "url": "http://twitter.com/JoelMarcey",
+    "image_url": "https://github.com/JoelMarcey.png",
+    "twitter": "JoelMarcey"
+  },
+  "slorber": {
+    "name": "Sébastien Lorber",
+    "title": "Docusaurus maintainer",
+    "url": "https://sebastienlorber.com",
+    "image_url": "https://github.com/slorber.png",
+    "twitter": "sebastienlorber"
+  },
+  "yangshun": {
+    "name": "Yangshun Tay",
+    "title": "Front End Engineer at Facebook",
+    "url": "https://github.com/yangshun",
+    "image_url": "https://github.com/yangshun.png",
+    "twitter": "yangshunz"
+  },
+  "lex111": {
+    "name": "Alexey Pyltsyn",
+    "title": "Open-source enthusiast",
+    "url": "https://github.com/lex111",
+    "image_url": "https://github.com/lex111.png"
+  }
+}

package/src/__tests__/__fixtures__/authorsMapFiles/authors.yml

@@ -0,0 +1,27 @@
+
+JMarcey:
+  name: Joel Marcey
+  title: Technical Lead & Developer Advocate at Facebook
+  url: http://twitter.com/JoelMarcey
+  image_url: https://github.com/JoelMarcey.png
+  twitter: JoelMarcey
+
+slorber:
+  name: Sébastien Lorber
+  title: Docusaurus maintainer
+  url: https://sebastienlorber.com
+  image_url: https://github.com/slorber.png
+  twitter: sebastienlorber
+
+yangshun:
+  name: Yangshun Tay
+  title: Front End Engineer at Facebook
+  url: https://github.com/yangshun
+  image_url: https://github.com/yangshun.png
+  twitter: yangshunz
+
+lex111:
+  name: Alexey Pyltsyn
+  title: Open-source enthusiast
+  url: https://github.com/lex111
+  image_url: https://github.com/lex111.png

package/src/__tests__/__fixtures__/authorsMapFiles/authorsBad1.json

@@ -0,0 +1,5 @@
+{
+  "slorber": {
+    "title": "Docusaurus maintainer"
+  }
+}

package/src/__tests__/__fixtures__/authorsMapFiles/authorsBad1.yml

@@ -0,0 +1,3 @@
+
+slorber:
+  title: Docusaurus maintainer

package/src/__tests__/__fixtures__/authorsMapFiles/authorsBad2.json

@@ -0,0 +1,3 @@
+{
+  "name": "Sébastien Lorber"
+}

package/src/__tests__/__fixtures__/authorsMapFiles/authorsBad2.yml

@@ -0,0 +1,2 @@
+
+name: Sébastien Lorber

package/src/__tests__/__fixtures__/authorsMapFiles/authorsBad3.json

@@ -0,0 +1,8 @@
+[
+  {
+    "name": "Sébastien Lorber"
+  },
+  {
+    "name": "Joel Marcey"
+  }
+]

package/src/__tests__/__fixtures__/authorsMapFiles/authorsBad3.yml

@@ -0,0 +1,3 @@
+
+- name: Sébastien Lorber
+- name: Joel Marcey

package/src/__tests__/__fixtures__/component/Typography.tsx

@@ -0,0 +1,6 @@
+import React from 'react';
+
+export const Typography: React.FC = (props) => {
+  return <p>{props.children}</p>
+}
+Typography.displayName = 'Typography'

package/src/__tests__/__fixtures__/website/blog/2018-12-14-Happy-First-Birthday-Slash.md

@@ -1,5 +1,8 @@
 ---
 title: Happy 1st Birthday Slash!
+authors:
+  - name: Yangshun Tay
+  - slorber
 ---
 
 Happy birthday!

package/src/__tests__/__fixtures__/website/blog/_partials/somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with _:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/website/blog/_partials/subfolder/somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with _:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/website/blog/_somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with \_:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/website/blog/authors.yml

@@ -0,0 +1,4 @@
+
+slorber:
+  name: Sébastien Lorber
+  title: Docusaurus maintainer

package/src/__tests__/__fixtures__/website/blog/mdx-blog-post.mdx

@@ -0,0 +1,36 @@
+---
+title: Full Blog Sample
+date: 2021-03-05
+---
+
+<h1>HTML Heading 1</h1>
+<h2>HTML Heading 2</h2>
+<p>HTML Paragraph</p>
+
+import Typography from '../../component/Typography'
+
+<Typography>Import DOM</Typography>
+
+# Heading 1
+
+## Heading 2
+
+### Heading 3
+
+#### Heading 4
+
+##### Heading 5
+
+- list1
+- list2
+- list3
+
+
+* list1
+* list2
+* list3
+
+Normal Text *Italics Text* **Bold Text**
+
+[link](https://v2.docusaurus.io/)
+![image](https://v2.docusaurus.io/)

package/src/__tests__/__fixtures__/website/blog/simple-slug.md

@@ -2,6 +2,10 @@
 slug: /simple/slug
 title: Simple Slug
 date: 2020-08-15
+
+author: Sébastien Lorber
+author_title: Docusaurus maintainer
+author_url: https://sebastienlorber.com
 ---
 
 simple url slug

package/src/__tests__/__fixtures__/website/i18n/en/docusaurus-plugin-content-blog/2018-12-14-Happy-First-Birthday-Slash.md

@@ -1,5 +1,8 @@
 ---
 title: Happy 1st Birthday Slash! (translated)
+authors:
+  - name: Yangshun Tay (translated)
+  - slorber
 ---
 
 Happy birthday! (translated)

package/src/__tests__/__fixtures__/website/i18n/en/docusaurus-plugin-content-blog/authors.yml

@@ -0,0 +1,5 @@
+
+
+slorber:
+  name: Sébastien Lorber (translated)
+  title: Docusaurus maintainer (translated)

package/src/__tests__/__snapshots__/generateBlogFeed.test.ts.snap

@@ -7,18 +7,54 @@ exports[`blogFeed atom shows feed item for each post 1`] = `
 <feed xmlns=\\"http://www.w3.org/2005/Atom\\">
     <id>https://docusaurus.io/myBaseUrl/blog</id>
     <title>Hello Blog</title>
-    <updated>2020-02-27T00:00:00.000Z</updated>
+    <updated>2021-03-05T00:00:00.000Z</updated>
     <generator>https://github.com/jpmonette/feed</generator>
     <link rel=\\"alternate\\" href=\\"https://docusaurus.io/myBaseUrl/blog\\"/>
     <subtitle>Hello Blog</subtitle>
     <icon>https://docusaurus.io/myBaseUrl/image/favicon.ico</icon>
     <rights>Copyright</rights>
+    <entry>
+        <title type=\\"html\\"><![CDATA[Full Blog Sample]]></title>
+        <id>Full Blog Sample</id>
+        <link href=\\"https://docusaurus.io/myBaseUrl/blog/mdx-blog-post\\"/>
+        <updated>2021-03-05T00:00:00.000Z</updated>
+        <summary type=\\"html\\"><![CDATA[HTML Heading 1]]></summary>
+        <content type=\\"html\\"><![CDATA[<h1>HTML Heading 1</h1><h2>HTML Heading 2</h2><p>HTML Paragraph</p><div>Import DOM</div><h1>Heading 1</h1><h2>Heading 2</h2><h3>Heading 3</h3><h4>Heading 4</h4><h5>Heading 5</h5><ul><li>list1</li><li>list2</li><li>list3</li></ul><ul><li>list1</li><li>list2</li><li>list3</li></ul><p>Normal Text <em>Italics Text</em> <strong>Bold Text</strong></p><p><a href=\\"https://v2.docusaurus.io/\\">link</a>
+<img src=\\"https://v2.docusaurus.io/\\" alt=\\"image\\"/></p>]]></content>
+    </entry>
+    <entry>
+        <title type=\\"html\\"><![CDATA[Complex Slug]]></title>
+        <id>/hey/my super path/héllô</id>
+        <link href=\\"https://docusaurus.io/myBaseUrl/blog/hey/my super path/héllô\\"/>
+        <updated>2020-08-16T00:00:00.000Z</updated>
+        <summary type=\\"html\\"><![CDATA[complex url slug]]></summary>
+        <content type=\\"html\\"><![CDATA[<p>complex url slug</p>]]></content>
+    </entry>
+    <entry>
+        <title type=\\"html\\"><![CDATA[Simple Slug]]></title>
+        <id>/simple/slug</id>
+        <link href=\\"https://docusaurus.io/myBaseUrl/blog/simple/slug\\"/>
+        <updated>2020-08-15T00:00:00.000Z</updated>
+        <summary type=\\"html\\"><![CDATA[simple url slug]]></summary>
+        <content type=\\"html\\"><![CDATA[<p>simple url slug</p>]]></content>
+        <author>
+            <name>Sébastien Lorber</name>
+            <uri>https://sebastienlorber.com</uri>
+        </author>
+    </entry>
     <entry>
         <title type=\\"html\\"><![CDATA[draft]]></title>
         <id>draft</id>
         <link href=\\"https://docusaurus.io/myBaseUrl/blog/draft\\"/>
         <updated>2020-02-27T00:00:00.000Z</updated>
         <summary type=\\"html\\"><![CDATA[this post should not be published yet]]></summary>
+        <content type=\\"html\\"><![CDATA[<p>this post should not be published yet</p>]]></content>
+    </entry>
+    <entry>
+        <title type=\\"html\\"><![CDATA[some heading]]></title>
+        <id>some heading</id>
+        <link href=\\"https://docusaurus.io/myBaseUrl/blog/heading-as-title\\"/>
+        <updated>2019-01-02T00:00:00.000Z</updated>
     </entry>
     <entry>
         <title type=\\"html\\"><![CDATA[date-matter]]></title>
@@ -26,6 +62,7 @@ exports[`blogFeed atom shows feed item for each post 1`] = `
         <link href=\\"https://docusaurus.io/myBaseUrl/blog/date-matter\\"/>
         <updated>2019-01-01T00:00:00.000Z</updated>
         <summary type=\\"html\\"><![CDATA[date inside front matter]]></summary>
+        <content type=\\"html\\"><![CDATA[<p>date inside front matter</p>]]></content>
     </entry>
     <entry>
         <title type=\\"html\\"><![CDATA[Happy 1st Birthday Slash! (translated)]]></title>
@@ -33,6 +70,13 @@ exports[`blogFeed atom shows feed item for each post 1`] = `
         <link href=\\"https://docusaurus.io/myBaseUrl/blog/2018/12/14/Happy-First-Birthday-Slash\\"/>
         <updated>2018-12-14T00:00:00.000Z</updated>
         <summary type=\\"html\\"><![CDATA[Happy birthday! (translated)]]></summary>
+        <content type=\\"html\\"><![CDATA[<p>Happy birthday! (translated)</p>]]></content>
+        <author>
+            <name>Yangshun Tay (translated)</name>
+        </author>
+        <author>
+            <name>Sébastien Lorber (translated)</name>
+        </author>
     </entry>
 </feed>"
 `;
@@ -41,21 +85,53 @@ exports[`blogFeed rss should not show feed without posts 1`] = `null`;
 
 exports[`blogFeed rss shows feed item for each post 1`] = `
 "<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>
-<rss version=\\"2.0\\">
+<rss version=\\"2.0\\" xmlns:dc=\\"http://purl.org/dc/elements/1.1/\\" xmlns:content=\\"http://purl.org/rss/1.0/modules/content/\\">
     <channel>
         <title>Hello Blog</title>
         <link>https://docusaurus.io/myBaseUrl/blog</link>
         <description>Hello Blog</description>
-        <lastBuildDate>Thu, 27 Feb 2020 00:00:00 GMT</lastBuildDate>
+        <lastBuildDate>Fri, 05 Mar 2021 00:00:00 GMT</lastBuildDate>
         <docs>https://validator.w3.org/feed/docs/rss2.html</docs>
         <generator>https://github.com/jpmonette/feed</generator>
         <copyright>Copyright</copyright>
+        <item>
+            <title><![CDATA[Full Blog Sample]]></title>
+            <link>https://docusaurus.io/myBaseUrl/blog/mdx-blog-post</link>
+            <guid>Full Blog Sample</guid>
+            <pubDate>Fri, 05 Mar 2021 00:00:00 GMT</pubDate>
+            <description><![CDATA[HTML Heading 1]]></description>
+            <content:encoded><![CDATA[<h1>HTML Heading 1</h1><h2>HTML Heading 2</h2><p>HTML Paragraph</p><div>Import DOM</div><h1>Heading 1</h1><h2>Heading 2</h2><h3>Heading 3</h3><h4>Heading 4</h4><h5>Heading 5</h5><ul><li>list1</li><li>list2</li><li>list3</li></ul><ul><li>list1</li><li>list2</li><li>list3</li></ul><p>Normal Text <em>Italics Text</em> <strong>Bold Text</strong></p><p><a href=\\"https://v2.docusaurus.io/\\">link</a>
+<img src=\\"https://v2.docusaurus.io/\\" alt=\\"image\\"/></p>]]></content:encoded>
+        </item>
+        <item>
+            <title><![CDATA[Complex Slug]]></title>
+            <link>https://docusaurus.io/myBaseUrl/blog/hey/my super path/héllô</link>
+            <guid>/hey/my super path/héllô</guid>
+            <pubDate>Sun, 16 Aug 2020 00:00:00 GMT</pubDate>
+            <description><![CDATA[complex url slug]]></description>
+            <content:encoded><![CDATA[<p>complex url slug</p>]]></content:encoded>
+        </item>
+        <item>
+            <title><![CDATA[Simple Slug]]></title>
+            <link>https://docusaurus.io/myBaseUrl/blog/simple/slug</link>
+            <guid>/simple/slug</guid>
+            <pubDate>Sat, 15 Aug 2020 00:00:00 GMT</pubDate>
+            <description><![CDATA[simple url slug]]></description>
+            <content:encoded><![CDATA[<p>simple url slug</p>]]></content:encoded>
+        </item>
         <item>
             <title><![CDATA[draft]]></title>
             <link>https://docusaurus.io/myBaseUrl/blog/draft</link>
             <guid>draft</guid>
             <pubDate>Thu, 27 Feb 2020 00:00:00 GMT</pubDate>
             <description><![CDATA[this post should not be published yet]]></description>
+            <content:encoded><![CDATA[<p>this post should not be published yet</p>]]></content:encoded>
+        </item>
+        <item>
+            <title><![CDATA[some heading]]></title>
+            <link>https://docusaurus.io/myBaseUrl/blog/heading-as-title</link>
+            <guid>some heading</guid>
+            <pubDate>Wed, 02 Jan 2019 00:00:00 GMT</pubDate>
         </item>
         <item>
             <title><![CDATA[date-matter]]></title>
@@ -63,6 +139,7 @@ exports[`blogFeed rss shows feed item for each post 1`] = `
             <guid>date-matter</guid>
             <pubDate>Tue, 01 Jan 2019 00:00:00 GMT</pubDate>
             <description><![CDATA[date inside front matter]]></description>
+            <content:encoded><![CDATA[<p>date inside front matter</p>]]></content:encoded>
         </item>
         <item>
             <title><![CDATA[Happy 1st Birthday Slash! (translated)]]></title>
@@ -70,6 +147,7 @@ exports[`blogFeed rss shows feed item for each post 1`] = `
             <guid>Happy 1st Birthday Slash! (translated)</guid>
             <pubDate>Fri, 14 Dec 2018 00:00:00 GMT</pubDate>
             <description><![CDATA[Happy birthday! (translated)]]></description>
+            <content:encoded><![CDATA[<p>Happy birthday! (translated)</p>]]></content:encoded>
         </item>
     </channel>
 </rss>"

package/src/__tests__/__snapshots__/translations.test.ts.snap

@@ -0,0 +1,64 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getContentTranslationFiles should return translation files matching snapshot 1`] = `
+Array [
+  Object {
+    "content": Object {
+      "description": Object {
+        "description": "The description for the blog used in SEO",
+        "message": "Someone's random blog",
+      },
+      "sidebar.title": Object {
+        "description": "The label for the left sidebar",
+        "message": "All my posts",
+      },
+      "title": Object {
+        "description": "The title for the blog used in SEO",
+        "message": "My blog",
+      },
+    },
+    "path": "options",
+  },
+]
+`;
+
+exports[`translateContent should return translated loaded content matching snapshot 1`] = `
+Object {
+  "blogListPaginated": Array [
+    Object {
+      "items": Array [
+        "hello",
+      ],
+      "metadata": Object {
+        "blogDescription": "Someone's random blog (translated)",
+        "blogTitle": "My blog (translated)",
+        "nextPage": null,
+        "page": 1,
+        "permalink": "/",
+        "postsPerPage": 10,
+        "previousPage": null,
+        "totalCount": 1,
+        "totalPages": 1,
+      },
+    },
+  ],
+  "blogPosts": Array [
+    Object {
+      "id": "hello",
+      "metadata": Object {
+        "date": 2021-07-19T00:00:00.000Z,
+        "description": "/blog/2021/06/19/hello",
+        "formattedDate": "June 19, 2021",
+        "permalink": "/blog/2021/06/19/hello",
+        "source": "/blog/2021/06/19/hello",
+        "tags": Array [],
+        "title": "Hello",
+        "truncated": true,
+      },
+    },
+  ],
+  "blogSidebarTitle": "All my posts (translated)",
+  "blogTags": Object {},
+  "blogTagsListPath": "/tags",
+}
+`;