feat(parser): infer title for each page

slidevjs · Apr 30, 2021 · a0ee374 · a0ee374
1 parent 2317998
commit a0ee374
Show file tree

Hide file tree

Showing 6 changed files with 293 additions and 2 deletions.
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -2,7 +2,6 @@
   "recommendations": [
     "antfu.vite",
     "johnsoncodehk.volar",
-    "lokalise.i18n-ally",
     "antfu.iconify",
     "dbaeumer.vscode-eslint",
     "voorjaar.windicss-intellisense",

diff --git a/packages/parser/src/index.ts b/packages/parser/src/index.ts
@@ -72,8 +72,12 @@ export function parse(
         note = v.trim()
         return ''
       })
+
+    const title = content.match(/^#+ (.*)$/m)?.[1]?.trim()
+
     return {
       raw,
+      title,
       content,
       frontmatter: result.data || {},
       note,
@@ -87,6 +91,7 @@ export function parse(
       return
     const raw = lines.slice(start, end).join('\n')
     slides.push({
+      index: slides.length,
       start,
       end,
       ...parseContent(raw),
@@ -137,7 +142,7 @@ export function parse(
   )
 
   config.theme ??= headmatter.theme ?? 'default'
-  config.title ??= headmatter.title ?? (slides[0].content.match(/^# (.*)$/m)?.[1] || '').trim()
+  config.title ??= headmatter.title ?? slides[0].title ?? 'Slidev'
   config.remoteAssets ??= headmatter.remoteAssets ?? true
   config.monaco ??= headmatter.monaco ?? 'dev'
   config.download ??= headmatter.download ?? false

diff --git a/packages/types/types.d.ts b/packages/types/types.d.ts
@@ -1,10 +1,12 @@
 export interface SlideInfo {
+  index: number
   start: number
   end: number
   raw: string
   content: string
   note?: string
   frontmatter: Record<string, any>
+  title?: string
 }
 
 export interface SlideInfoExtended extends SlideInfo {

diff --git a/test/__snapshots__/parser.test.ts.snap b/test/__snapshots__/parser.test.ts.snap
@@ -1,5 +1,162 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`md parser frontmatter.md: data 1`] = `
+Object {
+  "config": Object {
+    "download": false,
+    "info": true,
+    "monaco": "dev",
+    "remoteAssets": true,
+    "theme": "default",
+    "title": "Hi",
+  },
+  "filepath": "/Users/antfu/i/slidev/test/fixtures/markdown/frontmatter.md",
+  "raw": "---
+layout: cover
+---
+# Hi
+---
+meta:
+  title: FooBar
+  duration: 12
+layout: center
+---
+# Hello
+<!-- This is notes -->
+---
+
+# Morning
+---
+layout: text
+---
+<!-- This is not notes -->
+Hey
+---
+
+\`\`\`md
+---
+this should be treated as code block
+---
+----
+\`\`\`
+",
+  "slides": Array [
+    Object {
+      "content": "
+# Hi
+",
+      "end": 4,
+      "frontmatter": Object {
+        "layout": "cover",
+      },
+      "index": 0,
+      "note": undefined,
+      "raw": "---
+layout: cover
+---
+
+# Hi
+
+",
+      "start": 0,
+      "title": "Hi",
+    },
+    Object {
+      "content": "
+# Hello
+",
+      "end": 12,
+      "frontmatter": Object {
+        "layout": "center",
+        "meta": Object {
+          "duration": 12,
+          "title": "FooBar",
+        },
+      },
+      "index": 1,
+      "note": "This is notes",
+      "raw": "---
+meta:
+  title: FooBar
+  duration: 12
+layout: center
+---
+
+# Hello
+
+<!--
+This is notes
+-->
+",
+      "start": 4,
+      "title": "Hello",
+    },
+    Object {
+      "content": "
+# Morning
+",
+      "end": 15,
+      "frontmatter": Object {},
+      "index": 2,
+      "note": undefined,
+      "raw": "
+# Morning
+
+",
+      "start": 13,
+      "title": "Morning",
+    },
+    Object {
+      "content": "
+<!-- This is not notes -->
+Hey
+",
+      "end": 20,
+      "frontmatter": Object {
+        "layout": "text",
+      },
+      "index": 3,
+      "note": undefined,
+      "raw": "---
+layout: text
+---
+
+<!-- This is not notes -->
+Hey
+
+",
+      "start": 15,
+      "title": undefined,
+    },
+    Object {
+      "content": "
+\`\`\`md
+---
+this should be treated as code block
+---
+----
+\`\`\`
+",
+      "end": 28,
+      "frontmatter": Object {},
+      "index": 4,
+      "note": undefined,
+      "raw": "
+\`\`\`md
+---
+this should be treated as code block
+---
+----
+\`\`\`
+
+",
+      "start": 21,
+      "title": undefined,
+    },
+  ],
+}
+`;
+
 exports[`md parser frontmatter.md: formatted 1`] = `
 "---
 layout: cover
@@ -32,9 +189,128 @@ layout: text
 
 <!-- This is not notes -->
 Hey
+
+
+---
+
+\`\`\`md
+---
+this should be treated as code block
+---
+----
+\`\`\`
 "
 `;
 
+exports[`md parser minimal.md: data 1`] = `
+Object {
+  "config": Object {
+    "download": false,
+    "info": true,
+    "monaco": "dev",
+    "remoteAssets": true,
+    "theme": "default",
+    "title": "H1",
+  },
+  "filepath": "/Users/antfu/i/slidev/test/fixtures/markdown/minimal.md",
+  "raw": "# H1
+## H2
+### H3
+
+Sample Text
+
+\`\`\`ts
+console.log('Hello World')
+\`\`\`
+
+---
+
+# Hello
+
+- Hello
+- Hi
+- Hey
+- Yo
+---
+
+Nice to meet you
+",
+  "slides": Array [
+    Object {
+      "content": "
+# H1
+## H2
+### H3
+
+Sample Text
+
+\`\`\`ts
+console.log('Hello World')
+\`\`\`
+",
+      "end": 10,
+      "frontmatter": Object {},
+      "index": 0,
+      "note": undefined,
+      "raw": "
+# H1
+## H2
+### H3
+
+Sample Text
+
+\`\`\`ts
+console.log('Hello World')
+\`\`\`
+
+",
+      "start": 0,
+      "title": "H1",
+    },
+    Object {
+      "content": "
+# Hello
+
+- Hello
+- Hi
+- Hey
+- Yo
+",
+      "end": 18,
+      "frontmatter": Object {},
+      "index": 1,
+      "note": undefined,
+      "raw": "
+# Hello
+
+- Hello
+- Hi
+- Hey
+- Yo
+
+",
+      "start": 11,
+      "title": "Hello",
+    },
+    Object {
+      "content": "
+Nice to meet you
+",
+      "end": 21,
+      "frontmatter": Object {},
+      "index": 2,
+      "note": undefined,
+      "raw": "
+Nice to meet you
+
+",
+      "start": 19,
+      "title": undefined,
+    },
+  ],
+}
+`;
+
 exports[`md parser minimal.md: formatted 1`] = `
 "# H1
 ## H2

diff --git a/test/fixtures/markdown/frontmatter.md b/test/fixtures/markdown/frontmatter.md
@@ -18,3 +18,11 @@ layout: text
 ---
 <!-- This is not notes -->
 Hey
+---
+
+```md
+---
+this should be treated as code block
+---
+----
+```
diff --git a/test/parser.test.ts b/test/parser.test.ts
@@ -17,6 +17,7 @@ describe('md parser', () => {
       prettify(data)
 
       expect(stringify(data)).toMatchSnapshot('formatted')
+      expect(data).toMatchSnapshot('data')
     })
   }