How to handle yaml grammars

[serkonda7]

The grammar in https://github.com/serkonda7/vscode-vba is written in yaml (because it's just better).

It's converted to JSON before extension releases to VS Code. How to do this for linguist?

[lildude]

It's converted to JSON before extension releases to VS Code. How to do this for linguist?

We expect the grammars to be in the format and locations ready to use by the respective editors, without processing, as seen in the code here:

linguist/tools/grammars/compiler/loader.go

Lines 119 to 128 in 8a2415b

	switch strings.ToLower(ext) {
	case ".plist":
	return strings.HasSuffix(dir, "/Syntaxes")
	case ".tmlanguage", ".yaml-tmlanguage":
	return true
	case ".cson", ".json":
	return strings.HasSuffix(dir, "/grammars") || strings.HasSuffix(dir, "/syntaxes") || GrammarsInNonStdPath[filepath.Base(dir)]
	default:
	return false
	}

Anything else is ignored. If you were to try to add that grammar to linguist, the script will report an error because the grammar can't be used as-is directly from the repo.

We then convert these to JSON for our highlighting engine, if not already in JSON format.

[serkonda7]

Thanks for the answer.

I am trying around with renaming the grammar, so it's recognized by linguist and ran into another question/problem:

script/add-grammar https://github.com/serkonda7/vscode-vba does not pull the most recent commit to the vscode-vba repo. Is there some caching or so?

[lildude]

Is there some caching or so?

Nope. The script doesn't do any caching itself. All it does is add it as a submodule and will use the commit at the time of first invocation. If you want to use the latest commit, you need to update the submodule as you would normally for git submodules.

[serkonda7]

Thanks