feat(vscode): add Slidev language server (#1743)

Co-authored-by: _Kerman <[email protected]> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Anthony Fu <[email protected]> Co-authored-by: Anthony Fu <[email protected]>
slidevjs · Jul 20, 2024 · 73f5b4b · 73f5b4b
1 parent 6293e10
commit 73f5b4b
Show file tree

Hide file tree

Showing 34 changed files with 2,116 additions and 128 deletions.
diff --git a/.gitignore b/.gitignore
@@ -20,5 +20,6 @@ packages/create-app/template/pages
 packages/create-app/template/slides.md
 packages/create-app/template/snippets
 packages/slidev/README.md
+packages/vscode/syntaxes/codeblock-patch.json
 slides-export.md
 *slides-export.pptx
diff --git a/.npmrc b/.npmrc
@@ -1,3 +1,4 @@
 shamefully-hoist=true
 ignore-workspace-root-check=true
 strict-peer-dependencies=false
+link-workspace-packages=true
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -6,7 +6,8 @@
       "type": "extensionHost",
       "request": "launch",
       "args": [
-        "--extensionDevelopmentPath=${workspaceFolder}/packages/vscode"
+        "--extensionDevelopmentPath=${workspaceFolder}/packages/vscode",
+        "--folder-uri=${workspaceRoot}/packages/vscode/syntaxes"
       ],
       "outFiles": [
         "${workspaceFolder}/out/**/*.js"

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -46,5 +46,9 @@
     "jsonc",
     "yaml"
   ],
-  "vitest.disableWorkspaceWarning": true
+  "vitest.disableWorkspaceWarning": true,
+  "slidev.include": [
+    "**/slides.md",
+    "packages/vscode/syntax/slidev.example.md"
+  ]
 }
diff --git a/eslint.config.js b/eslint.config.js
@@ -17,6 +17,7 @@ export default antfu(
           '**/template.md',
           '**/example.md',
           'test/fixtures/markdown/**/*.md',
+          'packages/vscode/syntaxes/slidev.example.md',
         ],
       },
     },

diff --git a/package.json b/package.json
@@ -66,6 +66,7 @@
     "shiki": "^1.10.2",
     "simple-git-hooks": "^2.11.1",
     "taze": "^0.14.2",
+    "ts-json-schema-generator": "^2.3.0",
     "tsup": "^8.1.0",
     "typescript": "^5.5.3",
     "vite": "^5.3.3",

diff --git a/packages/parser/src/config.ts b/packages/parser/src/config.ts
@@ -36,10 +36,12 @@ export function getDefaultConfig(): SlidevConfig {
     css: 'unocss',
     presenter: true,
     htmlAttrs: {},
-    transition: undefined,
+    transition: null,
     editor: true,
-    contextMenu: undefined,
+    contextMenu: null,
     wakeLock: true,
+    remote: false,
+    mdc: false,
   }
 }
 

diff --git a/packages/parser/src/core.ts b/packages/parser/src/core.ts
@@ -2,6 +2,11 @@ import YAML from 'yaml'
 import { ensurePrefix } from '@antfu/utils'
 import type { FrontmatterStyle, SlidevDetectedFeatures, SlidevMarkdown, SlidevPreparserExtension, SourceSlideInfo } from '@slidev/types'
 
+export interface SlidevParserOptions {
+  noParseYAML?: boolean
+  preserveCR?: boolean
+}
+
 export function stringify(data: SlidevMarkdown) {
   return `${data.slides.map(stringifySlide).join('\n').trim()}\n`
 }
@@ -30,7 +35,7 @@ export function prettify(data: SlidevMarkdown) {
   return data
 }
 
-function matter(code: string) {
+function matter(code: string, options: SlidevParserOptions) {
   let type: FrontmatterStyle | undefined
   let raw: string | undefined
 
@@ -50,13 +55,13 @@ function matter(code: string) {
       })
   }
 
-  const doc = YAML.parseDocument(raw || '')
+  const doc = raw && !options.noParseYAML ? YAML.parseDocument(raw) : undefined
 
   return {
     type,
     raw,
     doc,
-    data: doc.toJSON(),
+    data: doc?.toJSON(),
     content,
   }
 }
@@ -70,8 +75,8 @@ export function detectFeatures(code: string): SlidevDetectedFeatures {
   }
 }
 
-export function parseSlide(raw: string): Omit<SourceSlideInfo, 'filepath' | 'index' | 'start' | 'contentStart' | 'end'> {
-  const matterResult = matter(raw)
+export function parseSlide(raw: string, options: SlidevParserOptions = {}): Omit<SourceSlideInfo, 'filepath' | 'index' | 'start' | 'contentStart' | 'end'> {
+  const matterResult = matter(raw, options)
   let note: string | undefined
   const frontmatter = matterResult.data || {}
   let content = matterResult.content.trim()
@@ -115,8 +120,9 @@ export async function parse(
   markdown: string,
   filepath: string,
   extensions?: SlidevPreparserExtension[],
+  options: SlidevParserOptions = {},
 ): Promise<SlidevMarkdown> {
-  const lines = markdown.split(/\r?\n/g)
+  const lines = markdown.split(options.preserveCR ? '\n' : /\r?\n/g)
   const slides: SourceSlideInfo[] = []
 
   let start = 0
@@ -127,7 +133,7 @@ export async function parse(
       return
     const raw = lines.slice(start, end).join('\n')
     const slide: SourceSlideInfo = {
-      ...parseSlide(raw),
+      ...parseSlide(raw, options),
       filepath,
       index: slides.length,
       start,
@@ -195,6 +201,74 @@ export async function parse(
   }
 }
 
+export function parseSync(
+  markdown: string,
+  filepath: string,
+  options: SlidevParserOptions = {},
+): SlidevMarkdown {
+  const lines = markdown.split(options.preserveCR ? '\n' : /\r?\n/g)
+  const slides: SourceSlideInfo[] = []
+
+  let start = 0
+  let contentStart = 0
+
+  function slice(end: number) {
+    if (start === end)
+      return
+    const raw = lines.slice(start, end).join('\n')
+    const slide: SourceSlideInfo = {
+      ...parseSlide(raw, options),
+      filepath,
+      index: slides.length,
+      start,
+      contentStart,
+      end,
+    }
+    slides.push(slide)
+    start = end + 1
+    contentStart = end + 1
+  }
+
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i].trimEnd()
+    if (line.startsWith('---')) {
+      slice(i)
+
+      const next = lines[i + 1]
+      // found frontmatter, skip next dash
+      if (line[3] !== '-' && next?.trim()) {
+        start = i
+        for (i += 1; i < lines.length; i++) {
+          if (lines[i].trimEnd() === '---')
+            break
+        }
+        contentStart = i + 1
+      }
+    }
+    // skip code block
+    else if (line.trimStart().startsWith('```')) {
+      const codeBlockLevel = line.match(/^\s*`+/)![0]
+      let j = i + 1
+      for (; j < lines.length; j++) {
+        if (lines[j].startsWith(codeBlockLevel))
+          break
+      }
+      // Update i only when code block ends
+      if (j !== lines.length)
+        i = j
+    }
+  }
+
+  if (start <= lines.length - 1)
+    slice(lines.length)
+
+  return {
+    filepath,
+    raw: markdown,
+    slides,
+  }
+}
+
 function scanMonacoReferencedMods(md: string) {
   const types = new Set<string>()
   const deps = new Set<string>()