Theia 中的 TextMate 支持
TextMate 语法允许我们给源码着色,它只是在句法级别(没有语言深度理解)。 语义着色可以由语言服务器等提供。
TextMate 语法主要有两种格式:.plist 和 .tmLanguage.json,Theia 支持这两种格式。
您可以在此处阅读有关 TextMate 语法的更多信息:https://macromates.com/manual/en/language_grammars
注意:特定语言的语法应该放在该语言的专用扩展中。 @theia/textmate-grammars 只是给目前没有任何特定扩展的语言用的。
添加新语法
为了给一种语言添加新的语法支持,通常的模式是在扩展的根目录下创建一个data文件夹,并在此处存储不同的语法。
extension/ data/ grammars go here lib/ ... src/ ... package.json ...
然后,在您的 package.json 中,您将声明以下属性,以便随同源文件和构建文件一起发布语法。
"files": [ "data", "lib", "src" ],
在您的扩展中,您现在可以通过 LanguageGrammarDefinitionContribution 贡献点进行贡献。
@injectable() export class YourContribution implements LanguageGrammarDefinitionContribution { readonly id = 'languageId'; readonly scopeName = 'source.yourLanguage'; registerTextmateLanguage(registry: TextmateRegisty) { registry.registerTextmateGrammarScope(this.scopeName, { async getGrammarDefinition() { return { format: 'json', content: require('../data/yourGrammar.tmLanguage.json'), } } }); registry.mapLanguageIdToTextmateGrammar(this.id, this.scopeName); } }
如果您使用 .plist 语法,则不能使用 require 来直接获取内容,因为 Webpack 将改为返回要从服务器获取的文件名。 在这种情况下,应用以下模式来获取文件的内容:
@injectable() export class YourContribution implements LanguageGrammarDefinitionContribution { readonly id = 'languageId'; readonly scopeName = 'source.yourLanguage'; registerTextmateLanguage(registry: TextmateRegisty) { registry.registerTextmateGrammarScope(this.scopeName, { async getGrammarDefinition() { const response = await fetch(require('../data/yourGrammar.plist')); return { format: 'plist', content: await response.text(), } } }); registry.mapLanguageIdToTextmateGrammar(this.id, this.scopeName); } }