README

Wxml-languageserver

微信小程序 wxml 的 language server。

主要功能

检查 wxml 完整性，各个节点标签名，属性，以及属性值是否满足要求
支持 doHover，方便查看标签和属性 markdown 文档
支持自动补全，包含标签名，属性，以及可枚举属性值
验证 import 和 include 中 src 定义的文件路径

使用方法

使用 npm 安装到全局：

npm install -g wxml-langserver

启动参数：

  --stdio     Use stdio to communicate with the server, default behaviour
  --node-ipc  Use node-ipc to communicate with the server. Useful for calling
  --socket    Use a socket (with a port number like --socket=5051) to
              communicate with the server

coc.nvim 已集成本插件，推荐使用。

配置

Client 可发送 workspace/didChangeConfiguration 通知来进行配置，支持配置项：

complete
- useSnippet 是否启用 snippet，默认通过 Client 声明的 snippet 支持判定
- completeEvent 是否包含 event 补全，默认为 true

本地使用

clone 整个项目

git clone https://github.com/chemzqm/wxml-langserver.git
安装依赖

yarn install
执行 yarn build 编译 ts 文件
执行 yarn test 运行测试
执行 gulp 生成本地 markdown 文档
执行 ./bin/wxml-langserver 运行服务

感谢

本项目使用了 qiu8310/minapp 提供的 component.json 以及 @miniapp/generator

本项目使用/参考了以下项目的部分代码：

项目协议

MIT

Usage no npm install needed!