Update of Erlang grammar

[garazdawi]

Hello!

Describe the bug

The Erlang grammar used here has not been updated in 5 years, instead a new fork has been made that has received updates: https://github.com/erlang-ls/grammar. I tried to update the grammar using script/add-grammar --replace erlang.tmbundle https://github.com/erlang-ls/grammar but it failed with this error:

> script/add-grammar --replace erlang.tmbundle https://github.com/erlang-ls/grammar
Checking Docker is installed and running
Deregistering submodule: vendor/grammars/erlang.tmbundle
Cleared directory 'vendor/grammars/erlang.tmbundle'
Submodule 'vendor/grammars/erlang.tmbundle' (https://github.com/textmate/erlang.tmbundle) unregistered for path 'vendor/grammars/erlang.tmbundle'
rm 'vendor/grammars/erlang.tmbundle'
Registering new submodule: https://github.com/erlang-ls/grammar.git
Reactivating local git directory for submodule 'vendor/grammars/grammar'
latest: Pulling from linguist/grammar-compiler
Digest: sha256:fcaf08a6e27d3d88212d9ca8aceee30d4089499a77bb05307871febd8073790f
Status: Image is up to date for linguist/grammar-compiler:latest
docker.io/linguist/grammar-compiler:latest
source 'vendor/grammars/grammar' contains no grammar files

From what I can gather it cannot find the grammar files.

Expected behaviour

I would like to be able to use this new erlang grammar fork, as it is the only place right now that receives any updates.

[lildude]

Converted this to a discussion as this is not a Linguist bug.

From what I can gather it cannot find the grammar files.

The grammar compiler expects to find grammar files in the locations the actual editors expect to find them:

linguist/tools/grammars/compiler/loader.go

Lines 119 to 128 in 8e7ffb3

	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
	}

The grammar you've linked to has a plist grammar file, but it's not in the correct path for editors that use this format. The file needs to be in a /Syntaxes directory.

[garazdawi]

Thanks for the quick reply. The grammar is used by two vs-code plugins to do syntax highlighting and the location works for them. So I would say that it is in a locations that actual editors can find it.

Anyway, would making a soft-link in the repo be enough? That way we can keep things as they are, but allow linguist to work as well.

[garazdawi]

I tried it using my own fork of the Erlang grammar and it seems to work with a soft-link. So I've opened a PR to the grammar repo. One accepted I'll create a PR here with the update.

[lildude]

The grammar is used by two vs-code plugins to do syntax highlighting and the location works for them. So I would say that it is in a locations that actual editors can find it.

Not really. Those plugins are explicitly telling VSCode where to find the grammar with config like this in the package.json file rather than using the /Syntaxes folder and allowing VSCode to find it for itself:

		"grammars": [
			{
				"language": "erlang",
				"scopeName": "source.erlang",
				"path": "./grammar/Erlang.plist"
			}
		],

The TextMate grammar repo this was forked from has the file in the expected location.

Anyway, would making a soft-link in the repo be enough?

Yup, as you found, a symlink will do the trick