feat: support router yaml block

Author: KeJunMao

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-  "vue.server.configFilePath": "./packages/playground/volar.config.js"
+  "vue.server.configFilePath": "./packages/playground/volar.config.js",
+  "prettier.enable": false
 }

README.md

@@ -63,9 +63,6 @@ export default defineUniPages({
 - **解析器支持：** JSON, JSON5, YAML
 - **默认：** JSON5
 
-> [!NOTE]
-> 尽管支持多种解析器，但是建议你始终使用 `json`、`json5` 来作为默认解析器，因为这些解析器可以配合 [volar-service-uni-pages](./packages/volar/) 来获得**智能感知**和**字段提示**能力。
-
 ```html
 <!-- index.vue -->
 <!-- 使用 type="home" 属性设置首页 -->

packages/volar/package.json

@@ -42,7 +42,9 @@
   "dependencies": {
     "@uni-helper/pages-json-schema": "workspace:^",
     "ts-json-schema-generator": "^1.3.0",
-    "vscode-json-languageservice": "^5.3.6"
+    "vscode-json-languageservice": "^5.3.6",
+    "vscode-languageserver-textdocument": "^1.0.8",
+    "yaml-language-server": "^1.14.0"
   },
   "devDependencies": {
     "@types/json-schema": "^7.0.13",

packages/volar/src/index.ts

@@ -1,14 +1,15 @@
 import type { Service } from '@volar/language-service'
-import * as json from 'vscode-json-languageservice'
-import pagesJsonSchema from '@uni-helper/pages-json-schema/schema.json'
+import { type LanguageService } from 'yaml-language-server'
+import type * as json from 'vscode-json-languageservice'
+import { type TextDocument } from 'vscode-languageserver-textdocument'
+import { createJsonLs } from './jsonLs'
+import { createYamlLs } from './yamlLs'
+import { isYaml } from './utils'
 
-type TextDocument = any
-
-pagesJsonSchema.$ref = '#/definitions/PageMetaDatum'
-pagesJsonSchema.definitions.PageMetaDatum.required = []
 export interface Provide {
   'json/jsonDocument': (document: TextDocument) => json.JSONDocument | undefined
   'json/languageService': () => json.LanguageService
+  'yaml/languageService': () => LanguageService
 }
 
 export default (): Service<Provide> => (context): ReturnType<Service<Provide>> => {
@@ -19,30 +20,39 @@ export default (): Service<Provide> => (context): ReturnType<Service<Provide>> =
     return { triggerCharacters } as any
 
   const jsonDocuments = new WeakMap<TextDocument, [number, json.JSONDocument]>()
-  const jsonLs = json.getLanguageService({})
-  jsonLs.configure({
-    allowComments: true,
-    schemas: [
-      {
-        fileMatch: ['*.customBlock_route_*.json*'],
-        uri: 'foo://route-custom-block.schema.json',
-        schema: {
-          ...pagesJsonSchema,
-        },
-      },
-    ],
-  })
+  const jsonLs = createJsonLs(context)
+  const yamlLs = createYamlLs(context)
 
   return {
 
     provide: {
       'json/jsonDocument': getJsonDocument,
       'json/languageService': () => jsonLs,
+      'yaml/languageService': () => yamlLs,
     },
 
     triggerCharacters,
 
+    provideCodeActions(document, range, context) {
+      if (isYaml(document)) {
+        return yamlLs.getCodeAction(document, {
+          context,
+          range,
+          textDocument: document,
+        })
+      }
+    },
+
+    provideCodeLenses(document) {
+      if (isYaml(document))
+        return yamlLs.getCodeLens(document)
+
+    },
+
     provideCompletionItems(document, position) {
+      if (isYaml(document))
+        return yamlLs.doComplete(document, position, false)
+
       return worker(document, async (jsonDocument) => {
         return await jsonLs.doComplete(document, position, jsonDocument)
       })
@@ -53,12 +63,18 @@ export default (): Service<Provide> => (context): ReturnType<Service<Provide>> =
     },
 
     provideDefinition(document, position) {
+      if (isYaml(document))
+        return yamlLs.doDefinition(document, { position, textDocument: document })
+
       return worker(document, async (jsonDocument) => {
         return await jsonLs.findDefinition(document, position, jsonDocument)
       })
     },
 
     provideDiagnostics(document) {
+      if (isYaml(document))
+        return yamlLs.doValidation(document, false)
+
       return worker(document, async (jsonDocument) => {
         const documentLanguageSettings = undefined // await getSettings(); // TODO
 
@@ -71,19 +87,29 @@ export default (): Service<Provide> => (context): ReturnType<Service<Provide>> =
       })
     },
 
+
     provideHover(document, position) {
+      if (isYaml(document))
+        return yamlLs.doHover(document, position)
+
       return worker(document, async (jsonDocument) => {
         return await jsonLs.doHover(document, position, jsonDocument)
       })
     },
 
     provideDocumentLinks(document) {
+      if (isYaml(document))
+        return yamlLs.findLinks(document)
+
       return worker(document, async (jsonDocument) => {
         return await jsonLs.findLinks(document, jsonDocument)
       })
     },
 
     provideDocumentSymbols(document) {
+      if (isYaml(document))
+        return yamlLs.findDocumentSymbols2(document, {})
+
       return worker(document, async (jsonDocument) => {
         return await jsonLs.findDocumentSymbols2(document, jsonDocument)
       })
@@ -102,17 +128,28 @@ export default (): Service<Provide> => (context): ReturnType<Service<Provide>> =
     },
 
     provideFoldingRanges(document) {
+      if (isYaml(document))
+        return yamlLs.getFoldingRanges(document, {})
+
+
       return worker(document, async () => {
         return await jsonLs.getFoldingRanges(document)
       })
     },
 
     provideSelectionRanges(document, positions) {
+      if (isYaml(document))
+        return yamlLs.getSelectionRanges(document, positions)
+
       return worker(document, async (jsonDocument) => {
         return await jsonLs.getSelectionRanges(document, positions, jsonDocument)
       })
     },
 
+    resolveCodeLens(codeLens) {
+      return yamlLs.resolveCodeLens(codeLens)
+    },
+
     provideDocumentFormattingEdits(document, range, options) {
       return worker(document, async () => {
         const options_2 = await context.env.getConfiguration?.<json.FormattingOptions & { enable: boolean }>('json.format')

packages/volar/src/jsonLs.ts

@@ -0,0 +1,18 @@
+import * as json from 'vscode-json-languageservice'
+import type { ServiceContext } from '@volar/language-service'
+import { schema } from './schema'
+
+export function createJsonLs(_context: ServiceContext) {
+  const jsonLs = json.getLanguageService({})
+  jsonLs.configure({
+    allowComments: true,
+    schemas: [
+      {
+        fileMatch: ['*.customBlock_route_*.json*'],
+        uri: 'foo://route-custom-block.schema.json',
+        schema,
+      },
+    ],
+  })
+  return jsonLs
+}

packages/volar/src/schema.ts

@@ -0,0 +1,6 @@
+import pagesJsonSchema from '@uni-helper/pages-json-schema/schema.json'
+
+pagesJsonSchema.$ref = '#/definitions/PageMetaDatum'
+pagesJsonSchema.definitions.PageMetaDatum.required = []
+
+export const schema = pagesJsonSchema

packages/volar/src/utils.ts

@@ -0,0 +1,5 @@
+import { type TextDocument } from 'vscode-languageserver-textdocument'
+
+export function isYaml(document: TextDocument): boolean {
+  return document.languageId === 'yaml'
+}

packages/volar/src/yamlLs.ts

@@ -0,0 +1,42 @@
+import { getLanguageService } from 'yaml-language-server'
+import type { ServiceContext } from '@volar/language-service'
+import { schema } from './schema'
+
+function noop(): undefined { }
+
+export function createYamlLs(context: ServiceContext) {
+  const ls = getLanguageService({
+    schemaRequestService: async uri => await context.env.fs?.readFile(uri) ?? '',
+    telemetry: {
+      send: noop,
+      sendError: noop,
+      sendTrack: noop,
+    },
+    // @ts-expect-error https://github.com/redhat-developer/yaml-language-server/pull/910
+    clientCapabilities: context?.env?.clientCapabilities,
+    workspaceContext: {
+      resolveRelativePath(relativePath, resource) {
+        return String(new URL(relativePath, resource))
+      },
+    },
+  })
+
+  ls.configure({
+    completion: true,
+    customTags: [],
+    format: true,
+    hover: true,
+    isKubernetes: false,
+    validate: true,
+    yamlVersion: '1.2',
+    schemas: [
+      {
+        fileMatch: ['*.customBlock_route_*.yaml*'],
+        uri: 'foo://route-custom-block.schema.yaml',
+        schema,
+      },
+    ],
+  })
+
+  return ls
+}

packages/volar/tsconfig.json

@@ -1,12 +1,12 @@
 {
   "compilerOptions": {
     "target": "esnext",
+    "jsx": "preserve",
     "useDefineForClassFields": true,
     "module": "esnext",
     "moduleResolution": "node",
-    "jsx": "preserve",
-    "sourceMap": true,
     "resolveJsonModule": true,
+    "sourceMap": true,
     "esModuleInterop": true,
     "skipLibCheck": true
   }