3

我正在为 vscode 开发语言扩展。我定义了一个 tmLanguage 文件，一切正常。在悬停功能中，使用vscode.MarkdownString.appendCodeblock()markdown 被正确解释，并且我的自定义语言的语法突出显示开箱即用，通过执行以下操作：

const content = new MarkdownString("", true)
content.appendMarkdown("## Examples: \n")
content.appendCodeblock(examples, "lmps")

其中examples包含我的自定义语言的一些示例代码，并且"lmps"是我的语言标识符。（示例图像悬停）

我想知道是否有办法在 webview 中实现相同的目标。我成功地content在 webview 中显示，将 markdownString 编译成 html：

async function set_doc_panel_content(panel: DocPanel | undefined, md_content: vscode.MarkdownString) {
        const html: string = await vscode.commands.executeCommand('markdown.api.render', md_content.value) as string;
        panel!.webview.html = html;
    }

到目前为止一切都很好，但是通过这种方式，markdown 不知道我的自定义语言并且不做任何语法高亮。（示例图片 Webview）现在，我了解到可以通过在激活函数中返回一个对象来贡献一个 markdown-it 插件，从而为 Markdown 扩展添加语言支持。

export function activate(context: vscode.ExtensionContext) {

...

    return {
        extendMarkdownIt(md: any) {
          return md.use(require('markdown-it-emoji'));
        }
}

但是，如果我没看错的话，这实际上需要开发一个专用的 markdown-it 插件。我想知道是否有更简单的方法可以将我的语言集成到 markdown api 中。因为 vscode 显然已经可以在悬停和完成建议中原生地做到这一点。我可以在 webview 中以某种方式使用此功能吗？或者，有没有一种方法可以从 tmLanguage 文件生成 markdown-it 插件，而无需深入学习 markdown-it 插件开发？也许有人有指向完成类似事情的项目的指针？

4

1 回答 1

1

对于任何有同样问题的人：似乎没有一个超级简单的方法。我为这项工作找到的最容易使用的软件包是highlight。然而，这个包（和其他像 first-mate 的包）依赖于本地模块Oniguruma。该软件包需要针对特定​​版本的 Electron 进行编译。这使得向市场发布 vscode 扩展变得非常困难，因为 vscode 不允许在包安装中运行此编译。

我发现的一个解决方案是为 markdown-it 提供一个突出显示功能。例如， vscode- textmate 可以读取 .plist 或 .tmLanguage 的语法。这个包可以和vscode-oniguruma一起使用。这里的技巧是加载 WASM 以使其工作：

const oniguruma = require('vscode-oniguruma')
const oniguruma_root: string = path.join(env.appRoot, 'node_modules.asar', 'vscode-oniguruma')
const wasm = readFileSync(path.join(oniguruma_root, 'release', 'onig.wasm')).buffer;
const on_wasm = oniguruma.loadWASM(wasm);

然后可以这样做：

const registry = new vsctm.Registry({
    onigLib: Promise.resolve({
        createOnigScanner: (sources) => new oniguruma.OnigScanner(sources),
                createOnigString: (str) => new oniguruma.OnigString(str)
            }),
            loadGrammar: () => {
                return readJSON2plist(path.join(context.extensionPath, 'syntaxes', 'lmps.tmLanguage.json'))
            .then(data => {
                return vsctm.parseRawGrammar(data)
            }).catch(null)
    }
});
    
const grammar = await registry.loadGrammar('source.lmps')
    
const md = require('markdown-it')(
    {
        html: true,
        linkify: true,
        typographer: true,
        langPrefix: '',
        highlight: function (str: string, lang: string) {
            if (grammar && lang && lang == 'lmps') {
                return tokenize_lmps(str, grammar)
            }
        }
    });
return md

md然后可以用于渲染降价内容：

let html = md.render(md_string)

可以在这里找到一个工作实现

于 2020-09-16T10:01:02.483 回答