方案
我有JSON文件描述了要执行的一系列任务,其中每个任务都可以引用JSON文件中的其他任务和对象。
{
"tasks": [
{ "id": "first", "action": "doSomething()", "result": {} },
{ "id": "second", "action": "doSomething(${id:first.result})", "result": {} },
]
}
我希望同时拥有JSON架构验证和自定义语言文字效果,例如关键字着色甚至"转到定义"支持JSON中的字符串。
我能做什么
我可以创建一个扩展,为文件扩展名指定JSON模式" * .foo.json"。如果vscode将文件识别为JSON文件,则在编辑器中提供模式验证和代码完成。
我也可以创建一个新的" foo"扩展名为" * .foo.json"在JSON字符串中具有自定义关键字着色的文件。我这样做是通过创建从JSON.tmLanguage.json复制的TextMate(* .tmLanguage.json)文件,然后修改" stringcontent"定义
问题
问题是架构验证和提示仅在我有" JSON"在状态栏中选择作为文件类型,并且自定义文本着色仅在我有" foo"在状态栏中选择作为文件类型。
有没有办法同时兼得?我可以以某种方式扩展vscode中的JSON语言处理吗?
答案 0 :(得分:1)
使用一些help from the vscode team,下面的代码可以解决问题。
的package.json
...
"activationEvents": [
"onLanguage:json",
"onLanguage:jsonc"
],
"main": "./src/extension",
"dependencies": {
"jsonc": "^0.1.0",
"jsonc-parser": "^1.0.0",
"vscode-nls": "^3.2.1"
},
...
的src / extension.js
'use strict';
const path = require( 'path' );
const vscode = require( 'vscode' );
const { getLocation, visit, parse, ParseError, ParseErrorCode } = require( 'jsonc-parser' );
module.exports = {
activate
};
let pendingFooJsonDecoration;
const decoration = vscode.window.createTextEditorDecorationType( {
color: '#04f1f9' // something like cyan
} );
// wire up *.foo.json decorations
function activate ( context /* vscode.ExtensionContext */) {
// decorate when changing the active editor editor
context.subscriptions.push( vscode.window.onDidChangeActiveTextEditor( editor => updateFooJsonDecorations( editor ), null, context.subscriptions ) );
// decorate when the document changes
context.subscriptions.push( vscode.workspace.onDidChangeTextDocument( event => {
if ( vscode.window.activeTextEditor && event.document === vscode.window.activeTextEditor.document ) {
if ( pendingFooJsonDecoration ) {
clearTimeout( pendingFooJsonDecoration );
}
pendingFooJsonDecoration = setTimeout( () => updateFooJsonDecorations( vscode.window.activeTextEditor ), 1000);
}
}, null, context.subscriptions ) );
// decorate the active editor now
updateFooJsonDecorations( vscode.window.activeTextEditor );
// decorate when then cursor moves
context.subscriptions.push( new EditorEventHandler() );
}
const substitutionRegex = /\$\{[\w\:\.]+\}/g;
function updateFooJsonDecorations ( editor /* vscode.TextEditor */ ) {
if ( !editor || !path.basename( editor.document.fileName ).endsWith( '.foo.json' ) ) {
return;
}
const ranges /* vscode.Range[] */ = [];
visit( editor.document.getText(), {
onLiteralValue: ( value, offset, length ) => {
const matches = [];
let match;
while ( ( match = substitutionRegex.exec( value ) ) !== null) {
matches.push( match );
const start = offset + match.index + 1;
const end = match.index + 1 + offset + match[ 0 ].length;
ranges.push( new vscode.Range( editor.document.positionAt( start ), editor.document.positionAt( end ) ) );
}
}
});
editor.setDecorations( decoration, ranges );
}
class EditorEventHandler {
constructor () {
let subscriptions /*: Disposable[] */ = [];
vscode.window.onDidChangeTextEditorSelection( ( e /* TextEditorSelectionChangeEvent */ ) => {
if ( e.textEditor === vscode.window.activeTextEditor) {
updateFooJsonDecorations( e.textEditor );
}
}, this, subscriptions );
this._disposable = vscode.Disposable.from( ...subscriptions );
}
dispose () {
this._disposable.dispose();
}
}