背景
筆者開(kāi)源了一個(gè)小項(xiàng)目code-run，類(lèi)似codepen的一個(gè)工具，其中代碼編輯器使用的是微軟的Monaco Editor，這個(gè)庫(kù)是直接從VSCode的源碼中生成的，只不過(guò)是做了一點(diǎn)修改讓它支持在瀏覽器中運(yùn)行，但是功能基本是和VSCode一樣強(qiáng)大的，所以在筆者看來(lái)Monaco Editor等于VSCode的編輯器核心。
另外筆者是一個(gè)顏控，不管做什么項(xiàng)目，都熱衷于配套一些好看的皮膚、主題，所以Moncao Editor僅僅內(nèi)置了三種主題是遠(yuǎn)遠(yuǎn)滿(mǎn)足不了筆者需求的，況且還都很丑，于是結(jié)合Monaco Editor和VSCode的關(guān)系就很自然的想到，能不能直接復(fù)用VSCode的主題，接下來(lái)就給大家介紹一下筆者的探索之路。
ps.想直接了解如何實(shí)現(xiàn)的可以跳轉(zhuǎn)到【具體實(shí)現(xiàn)】小節(jié)。
基本使用
先看一下Monaco Editor的基本使用，首先安裝：
npm install monaco-editor
然后引入：
import * as monaco from 'monaco-editor'
// 創(chuàng)建一個(gè)js編輯器
const editor = monaco.editor.create(document.getElementById('container'), {
value: ['function x() {', '\tconsole.log("Hello world!");', '}'].join('\n'),
language: 'javascript',
theme: 'vs'
})
這樣就可以在container元素上創(chuàng)建一個(gè)js語(yǔ)言的編輯器，并且使用了內(nèi)置的vs-dark主題。如果遇到報(bào)錯(cuò)或者語(yǔ)法提示不生效，那么可能需要配置一下worker文件的路徑，可以參考官方示例browser-esm-webpack。
自定義主題
Monaco Editor支持自定義主題，方法如下：
// 定義主題
monaco.editor.defineTheme(themeName, themeData)
// 使用定義的主題
monaco.editor.setTheme(themeName)
themeName是要自定義的主題名稱(chēng)，比如OneDarkPro，themeData是一個(gè)對(duì)象，即主題數(shù)據(jù)，基本結(jié)構(gòu)如下：
{
base: 'vs',// 要繼承的基礎(chǔ)主題，即內(nèi)置的三個(gè)：vs、vs-dark、hc-black
inherit: false,// 是否繼承
rules: [// 高亮規(guī)則，即給代碼里不同token類(lèi)型的代碼設(shè)置不同的顯示樣式
{ token: '', foreground: '000000', background: 'fffffe' }
],
colors: {// 非代碼部分的其他部分的顏色，比如背景、滾動(dòng)條等
[editorBackground]: '#FFFFFE'
}
}
rules里面就是用來(lái)給代碼進(jìn)行高亮的，常見(jiàn)的token有string（字符串）、comment（注釋?zhuān)?code>keyword（關(guān)鍵詞）等等，完整的請(qǐng)移步themes.ts，這些token是怎么確定的呢，Monaco Editor內(nèi)置了一個(gè)語(yǔ)法著色器Monarch，本質(zhì)是通過(guò)正則表達(dá)式來(lái)匹配，然后給匹配到的內(nèi)容命名為一個(gè)token。
可以直接在編輯器中查看代碼某塊對(duì)應(yīng)的token，按F1或鼠標(biāo)右鍵點(diǎn)擊Command Palette，然后再找到并點(diǎn)擊Developer: Inspect Tokens，接下來(lái)鼠標(biāo)點(diǎn)哪一塊代碼，就會(huì)顯示對(duì)應(yīng)的信息，包括token類(lèi)型，當(dāng)前應(yīng)用的顏色等。
踩坑
最開(kāi)始的想法很簡(jiǎn)單，直接找到VSCode的主題文件，然后通過(guò)自定義主題來(lái)使用。
獲取VSCode主題文件
有兩種方法，如果某個(gè)主題已經(jīng)在你的VSCode里安裝并正在使用的話(huà)，那么可以按F1或Command/Control + Shift + P或鼠標(biāo)右鍵點(diǎn)擊Command Palette/命令面板，接著找到并點(diǎn)擊Developer:Generate Color Theme From Current Setting/開(kāi)發(fā)人員:使用當(dāng)前設(shè)置生成顏色主題，然后VSCode就會(huì)生成一份json數(shù)據(jù)，保存即可。
如果某個(gè)主題沒(méi)有安裝的話(huà)，那么可以去vscode主題商店搜索該主題，進(jìn)入主題詳情頁(yè)面后點(diǎn)擊右側(cè)的Download Extension按鈕即可下載該主題，下載完成后找到剛才下載的文件，文件應(yīng)該是以.vsix結(jié)尾的，直接把該后綴改成.zip，然后解壓縮，最后打開(kāi)里面的/extension/themes/文件夾，里面的.json文件即主題文件，打開(kāi)該文件復(fù)制json數(shù)據(jù)即可。
把VSCode主題轉(zhuǎn)換成Monaco Editor主題格式
上一步過(guò)后你應(yīng)該可以發(fā)現(xiàn)VSCode主題的格式是這樣的：
{
"$schema": "vscode://schemas/color-theme",
"type": "dark",
"colors": {
"activityBar.background": "#282c34"
},
"tokenColors": [
{
"scope": "variable.other.generic-type.haskell",
"settings": {
"foreground": "#C678DD"
}
}，
{
"scope": [
"punctuation.section.embedded.begin.php",
"punctuation.section.embedded.end.php"
],
"settings": {
"foreground": "#BE5046"
}
}
]
}
跟Monaco Editor的主題格式有一點(diǎn)區(qū)別，那是不是可以寫(xiě)一個(gè)轉(zhuǎn)換方法把它轉(zhuǎn)換成下面這樣呢：
{
base: 'vs',
inherit: false,
rules: [
{ token: 'variable.other.generic-type.haskell', foreground: '#C678DD' },
{ token: 'punctuation.section.embedded.begin.php', foreground: '#BE5046' },
{ token: 'punctuation.section.embedded.end.php', foreground: '#BE5046' }
],
colors: {
"activityBar.background": "#282c34"
}
}
當(dāng)然可以，這也不難，但是最后當(dāng)你使用這個(gè)自定義的主題后會(huì)發(fā)現(xiàn)，沒(méi)有效果，為什么呢，去Monarch看一下對(duì)應(yīng)語(yǔ)言的解析配置后就會(huì)發(fā)現(xiàn)，壓根就沒(méi)有VSCode主題里定義的這些token，有效果才奇怪，那怎么辦呢，自己擴(kuò)展這個(gè)解析的配置嗎，筆者最開(kāi)始就是這么做的，寫(xiě)正則表達(dá)式嘛，應(yīng)該也不是很難，為此，筆者還把Monarch文檔完整翻譯了一遍Monarch中文，但是當(dāng)筆者在VSCode里看到如下效果時(shí)：
果斷放棄，這顯然是要進(jìn)行語(yǔ)義分析才行，否則誰(shuí)知道abc是個(gè)變量。
其實(shí)在VSCode里語(yǔ)法高亮使用的是TextMate，而在Monaco Editor里使用的是Monarch，兩者壓根不是一個(gè)東西，為什么Monaco Editor不使用TextMate，而是要開(kāi)發(fā)一個(gè)新的東西呢，原因是VSCode使用的是vscode-textmate來(lái)解析TextMate語(yǔ)法，這個(gè)庫(kù)依賴(lài)一個(gè)Oniguruma正則表達(dá)式庫(kù)，而這個(gè)正則表達(dá)式庫(kù)是使用C語(yǔ)言開(kāi)發(fā)的，當(dāng)然不支持在瀏覽器上運(yùn)行。
退而求其次
既然VSCode的主題不能直接使用，那么就只能能用多少用多少，因?yàn)?code>Monaco Editor內(nèi)置的主題token就只有那么多，那么把它所有的token顏色換成VSCode的主題顏色不就行了嗎，雖然語(yǔ)義高亮沒(méi)有，但是總比默認(rèn)主題好看。實(shí)現(xiàn)也很簡(jiǎn)單，首先colors部分的基本可以直接使用，而token部分可以通過(guò)上面介紹的方法Developer: Inspect Tokens在VSCode里找到對(duì)應(yīng)代碼塊的顏色，復(fù)制到Monaco Editor主題的對(duì)應(yīng)token上即可，比如筆者轉(zhuǎn)換后的OneDarkPro的實(shí)際效果如下：
在VSCode里的效果如下：
只可粗看，不要細(xì)究。
這個(gè)事情也有人已經(jīng)做了，可以參考這個(gè)倉(cāng)庫(kù)monaco-themes，里面幫你轉(zhuǎn)換了一些常見(jiàn)的主題，可以拿來(lái)直接使用。
新的曙光
就在筆者已經(jīng)放棄在Monaco Editor中直接使用VSCode主題的想法后，無(wú)意間發(fā)現(xiàn)codesandbox和leetcode兩個(gè)網(wǎng)站中的編輯器主題效果和VSCode中基本一致，而且可以明顯的看到在leetcode中切換主題請(qǐng)求的文件：
基本和VSCode主題格式是一樣的，這就說(shuō)明在Monaco Editor中使用VSCode主題是可以實(shí)現(xiàn)的，那么問(wèn)題就變成了怎么實(shí)現(xiàn)。
實(shí)現(xiàn)
不得不說(shuō)，這方面資料真的很少，相關(guān)文章基本沒(méi)有，百度搜索結(jié)果里只有一兩個(gè)相關(guān)的鏈接，不過(guò)也足以解決問(wèn)題了，相關(guān)鏈接詳見(jiàn)文章尾部。
主要使用的是monaco-editor-textmate這個(gè)工具（所以除了百度谷歌之外，github也是一個(gè)很重要的搜索引擎啊），先安裝：
npm i monaco-editor-textmate
npm應(yīng)該會(huì)同時(shí)幫你再安裝monaco-textmate、onigasm、monaco-editor這幾個(gè)包，monaco-editor自不必說(shuō)，我們自己都裝了，其他兩個(gè)可以自行檢查一下，如果沒(méi)有的話(huà)需要自行安裝。
工具介紹
簡(jiǎn)單介紹一下這幾個(gè)包。
onigasm
這個(gè)庫(kù)就是用來(lái)解決上述瀏覽器不支持C語(yǔ)言編寫(xiě)的Oniguruma的問(wèn)題，解決方法是把Oniguruma編譯為WebAssembly，WebAssembly是一種中間格式，可以把非js代碼編譯成.wasm格式的文件，然后瀏覽器就可以加載并運(yùn)行它了，WebAssembly已經(jīng)是WEB的標(biāo)準(zhǔn)之一了，隨著時(shí)間的推移，相信兼容性也不是問(wèn)題。
monaco-textmate
這個(gè)庫(kù)是在VSCode使用的vscode-textmate庫(kù)的基礎(chǔ)上修改的， 以便讓它在瀏覽器上使用。主要作用是解析TextMate語(yǔ)法，這個(gè)庫(kù)依賴(lài)前面的onigasm。
monaco-editor-textmate
這個(gè)庫(kù)的主要作用是幫我們把monaco-editor和monaco-textmate關(guān)聯(lián)起來(lái)，內(nèi)部首先會(huì)加載對(duì)應(yīng)語(yǔ)言的TextMate語(yǔ)法文件，然后調(diào)用monaco.languages.setTokensProvider方法來(lái)自定義語(yǔ)言的token解析器。
看一下它的使用示例：
import { loadWASM } from 'onigasm'
import { Registry } from 'monaco-textmate'
import { wireTmGrammars } from 'monaco-editor-textmate'
export async function liftOff() {
await loadWASM(`path/to/onigasm.wasm`)
const registry = new Registry({
getGrammarDefinition: async (scopeName) => {
return {
format: 'json',
content: await (await fetch(`static/grammars/css.tmGrammar.json`)).text()
}
}
})
const grammars = new Map()
grammars.set('css', 'source.css')
grammars.set('html', 'text.html.basic')
grammars.set('typescript', 'source.ts')
monaco.editor.defineTheme('vs-code-theme-converted', {});
var editor = monaco.editor.create(document.getElementById('container'), {
value: [
'html, body {',
' margin: 0;',
'}'
].join('\n'),
language: 'css',
theme: 'vs-code-theme-converted'
})
await wireTmGrammars(monaco, registry, grammars, editor)
}
具體實(shí)現(xiàn)
看完前面的使用示例后，接下來(lái)我們?cè)敿?xì)看一下如何使用。
加載onigasm
首先我們要做的是加載onigasm的wasm文件，這個(gè)文件需要首先被加載，且加載一次就可以了，所以我們?cè)诰庉嬈鞒跏蓟斑M(jìn)行加載：
import { loadWASM } from 'onigasm'
const init = async () => {
await loadWASM(`${base}/onigasm/onigasm.wasm`)
// 創(chuàng)建編輯器...
}
init()
onigasm.wasm文件可以在/node_modules/onigasm/lib/目錄下找到，然后復(fù)制到項(xiàng)目的/public/onigasm/目錄下，這樣可以通過(guò)http進(jìn)行請(qǐng)求。
創(chuàng)建作用域映射
接下來(lái)創(chuàng)建語(yǔ)言id到作用域名稱(chēng)的映射：
const grammars = new Map()
grammars.set('css', 'source.css')
其他語(yǔ)言的作用域名稱(chēng)可以在各種語(yǔ)言的語(yǔ)法列表這里找到，比如想知道css的作用域名稱(chēng)，我們進(jìn)入css目錄，然后打開(kāi)package.json文件，可以看到其中有一個(gè)grammars字段：
"grammars": [
{
"language": "css",
"scopeName": "source.css",
"path": "./syntaxes/css.tmLanguage.json",
"tokenTypes": {
"meta.function.url string.quoted": "other"
}
}
]
language就是語(yǔ)言id，scopeName就是作用域名稱(chēng)。常見(jiàn)的如下：
const scopeNameMap = {
html: 'text.html.basic',
pug: 'text.pug',
css: 'source.css',
less: 'source.css.less',
scss: 'source.css.scss',
typescript: 'source.ts',
javascript: 'source.js',
javascriptreact: 'source.js.jsx',
coffeescript: 'source.coffee'
}
注冊(cè)語(yǔ)法映射
再接著注冊(cè)TextMate的語(yǔ)法映射關(guān)系，這樣可以通過(guò)作用域名稱(chēng)來(lái)加載并創(chuàng)建對(duì)應(yīng)的語(yǔ)法：
import {
Registry
} from 'monaco-textmate'
// 創(chuàng)建一個(gè)注冊(cè)表，可以從作用域名稱(chēng)來(lái)加載對(duì)應(yīng)的語(yǔ)法文件
const registry = new Registry({
getGrammarDefinition: async (scopeName) => {
return {
format: 'json',// 語(yǔ)法文件格式，有json、plist
content: await (await fetch(`${base}grammars/css.tmLanguage.json`)).text()
}
}
})
語(yǔ)法文件和前面的作用域名稱(chēng)一樣，也是在各種語(yǔ)言的語(yǔ)法列表這里找，同樣以css語(yǔ)言為例，還是看它的package.json的grammars字段：
"grammars": [
{
"language": "css",
"scopeName": "source.css",
"path": "./syntaxes/css.tmLanguage.json",
"tokenTypes": {
"meta.function.url string.quoted": "other"
}
}
]
path字段就是對(duì)應(yīng)的語(yǔ)法文件的路徑，我們把這些json文件復(fù)制到項(xiàng)目的/public/grammars/目錄下，這樣就可以通過(guò)fetch來(lái)請(qǐng)求到。
定義主題
前面介紹過(guò)，Monaco Editor的主題格式和VSCode的格式是有點(diǎn)不一樣的，所以需要進(jìn)行轉(zhuǎn)換，轉(zhuǎn)換可以自己實(shí)現(xiàn)，也可以直接使用monaco-vscode-textmate-theme-converter這個(gè)工具，它可以同時(shí)轉(zhuǎn)換多個(gè)本地文件：
// convertTheme.js
const converter = require('monaco-vscode-textmate-theme-converter')
const path = require('path')
const run = async () => {
try {
await converter.convertThemeFromDir(
path.resolve(__dirname, './vscodeThemes'),
path.resolve(__dirname, '../public/themes')
);
} catch (error) {
console.log(error)
}
}
run()
運(yùn)行node ./convertTheme.js命令后，就會(huì)把你放在vscodeThemes目錄下所有VSCode的主題文件轉(zhuǎn)換成Monaco Editor的主題文件并輸出到public/themes目錄下，然后我們?cè)诖a里直接通過(guò)fetch來(lái)請(qǐng)求主題文件并使用defineTheme方法定義主題即可：
// 請(qǐng)求OneDarkPro主題文件
const themeData = await (
await fetch(`${base}themes/OneDarkPro.json`)
).json()
// 定義主題
monaco.editor.defineTheme('OneDarkPro', themeData)
設(shè)置token解析器
經(jīng)過(guò)前面這些準(zhǔn)備工作，最后一步要做的是設(shè)置Monaco Editor的token解析器，默認(rèn)使用的是內(nèi)置的Monarch，我們要換成TextMate的解析器，也就是monaco-editor-textmate做的事情：
import {
wireTmGrammars
} from 'monaco-editor-textmate'
import * as monaco from 'monaco-editor'
let editor = monaco.editor.create(document.getElementById('container'), {
value: [
'html, body {',
' margin: 0;',
'}'
].join('\n'),
language: 'css',
theme: 'OneDarkPro'
})
await wireTmGrammars(monaco, registry, grammars, editor)
問(wèn)題1
上一步后應(yīng)該可以看到VSCode的主題在Monaco Editor上生效了，但是多試幾次可能會(huì)發(fā)現(xiàn)偶爾會(huì)失效，原因是Monaco Editor內(nèi)置的語(yǔ)言是延遲加載的，并且加載完后也會(huì)同樣注冊(cè)一個(gè)token解析器，所以會(huì)把我們的給覆蓋掉，詳見(jiàn)issue：setTokensProvider unable to override existing tokenizer。
一種解決方法是去除內(nèi)置的語(yǔ)言，這可以使用monaco-editor-webpack-plugin。
安裝：
npm install monaco-editor-webpack-plugin -D
Vue項(xiàng)目配置如下：
// vue.config.js
const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin')
module.exports = {
configureWebpack: {
plugins: [
new MonacoWebpackPlugin({
languages: []
})
]
}
}
languages選項(xiàng)用來(lái)指定要包含的語(yǔ)言，我們直接設(shè)為空，啥也不要。
然后修改Monaco Editor的引入方式為：
import * as monaco from 'monaco-editor/esm/vs/editor/editor.api'
最后需要手動(dòng)注冊(cè)我們需要的語(yǔ)言，因?yàn)樗袃?nèi)置語(yǔ)言都被去除了嘛，比如我們要使用js語(yǔ)言的話(huà)：
monaco.languages.register({id: 'javascript'})
這種方法雖然可以完美解決該問(wèn)題，但是很大的一個(gè)副作用是語(yǔ)法提示不生效了，因?yàn)橹挥邪藘?nèi)置的html、css、typescript時(shí)才會(huì)去加載對(duì)應(yīng)的worker文件，沒(méi)有語(yǔ)法提示筆者也是無(wú)法接受的，所以最后筆者使用了一種比較low的hack方式：
// 插件配置
new MonacoWebpackPlugin({
languages: ['css', 'html', 'javascript', 'less', 'pug', 'scss', 'typescript', 'coffee']
})
// 注釋掉語(yǔ)言注冊(cè)語(yǔ)句
// monaco.languages.register({id: 'javascript'})
// 當(dāng)worker文件被加載了后再wire
let hasGetAllWorkUrl = false
window.MonacoEnvironment = {
getWorkerUrl: function (moduleId, label) {
hasGetAllWorkUrl = true
if (label === 'json') {
return './monaco/json.worker.bundle.js'
}
if (label === 'css' || label === 'scss' || label === 'less') {
return './monaco/css.worker.bundle.js'
}
if (label === 'html' || label === 'handlebars' || label === 'razor') {
return './monaco/html.worker.bundle.js'
}
if (label === 'typescript' || label === 'javascript') {
return './monaco/ts.worker.bundle.js'
}
return './monaco/editor.worker.bundle.js'
},
}
// 循環(huán)檢測(cè)
let loop = () => {
if (hasGetAllWorkUrl) {
Promise.resolve().then(async () => {
await wireTmGrammars(monaco, registry, grammars, editor)
})
} else {
setTimeout(() => {
loop()
}, 100)
}
}
loop()
問(wèn)題2
筆者遇到的另外一個(gè)問(wèn)題是，轉(zhuǎn)換后有些主題的默認(rèn)顏色并未設(shè)置，所以都是黑色，很丑：
這個(gè)問(wèn)題的解決方法是可以給主題的rules數(shù)組添加一個(gè)空的token，用來(lái)作為沒(méi)有匹配到的默認(rèn)token：
{
"rules": [
{
"foreground": "#abb2bf",
"token": ""
}
]
}
foreground的色值可以取colors選項(xiàng)里的editor.foreground的值，要手動(dòng)修改每個(gè)色值比較麻煩，可以在之前的轉(zhuǎn)換主題的步驟里順便進(jìn)行，會(huì)在下一個(gè)問(wèn)題里一起解決。
問(wèn)題3
monaco-vscode-textmate-theme-converter這個(gè)包本質(zhì)算是nodejs環(huán)境下的工具，所以想在純前端環(huán)境下使用不太方便，另外它對(duì)于非標(biāo)準(zhǔn)json格式的VSCode主題轉(zhuǎn)換時(shí)會(huì)報(bào)錯(cuò)，因?yàn)楹芏嘀黝}格式是.jsonc，內(nèi)容是帶有很多注釋的，所以都需要自己先進(jìn)行檢查并修改，不是很方便，基于這兩個(gè)問(wèn)題，筆者fork了它的代碼，然后修改并分成了兩個(gè)包，分別對(duì)應(yīng)nodejs和瀏覽器環(huán)境，詳見(jiàn)https://github.com/wanglin2/monaco-vscode-textmate-theme-converter。
所以我們可以替換掉monaco-vscode-textmate-theme-converter，改成安裝筆者的：
npm i vscode-theme-to-monaco-theme-node -D
使用方式基本是一樣的：
// 只要修改引入為筆者的包即可
const converter = require('vscode-theme-to-monaco-theme-node')
const path = require('path')
const run = async () => {
try {
await converter.convertThemeFromDir(
path.resolve(__dirname, './vscodeThemes'),
path.resolve(__dirname, '../public/themes')
);
} catch (error) {
console.log(error)
}
}
run()
現(xiàn)在就可以直接轉(zhuǎn)換.jsonc文件，而且輸出統(tǒng)一為.json文件，另外內(nèi)部會(huì)自動(dòng)添加一個(gè)空的token作為沒(méi)有匹配到的默認(rèn)token，效果如下：
最佳實(shí)踐
VSCode主題除了代碼主題外，一般還包含編輯器其他部分的主題，比如標(biāo)題欄、狀態(tài)欄、側(cè)邊欄、按鈕等等，所以我們也可以在頁(yè)面應(yīng)用這些樣式，達(dá)到整個(gè)頁(yè)面的主題也能隨編輯器代碼主題一起切換的效果，這樣能讓頁(yè)面整體更加協(xié)調(diào)，具體的實(shí)現(xiàn)上，我們可以使用CSS變量，先把頁(yè)面所有涉及到的顏色都定義成CSS變量，然后在切換主題時(shí)根據(jù)主題的colors選項(xiàng)里的指定字段來(lái)更新變量即可，具體使用哪個(gè)字段來(lái)對(duì)應(yīng)頁(yè)面的哪個(gè)部分可以根據(jù)實(shí)際情況來(lái)確定，VSCode主題的所有可配置項(xiàng)可以在theme-color這里找到。效果如下：
總結(jié)
本文完整詳細(xì)的介紹了筆者對(duì)于Monaco Editor編輯器主題的探索，希望能給有主題定制需求的小伙伴們一點(diǎn)幫助，完整的代碼請(qǐng)參考本項(xiàng)目源碼：code-run。
參考鏈接
文章：monaco使用vscode相關(guān)語(yǔ)法高亮在瀏覽器上顯示
