filePath option required to avoid null-grammar

[davidtheclark]

In trying to follow the example in the README, I found that I was stuck with null-grammar unless I provided a filePath option. scopeName alone wouldn't do, as the example suggests.

Is there something I'm missing? Or should I make a PR to add this to the docs?

[davidtheclark]

Another twist: filePath seems to work without scopeName and independent of it. If I want JavaScript highlighting, set scopeName: 'scope.js' and filePath: 'foo.css', I get CSS highlighting. If I set scopeName: 'scope.css' and filePath: 'foo.js', I get JS highlighting.

[bcoe]

@davidtheclark would love a PR to the docs 👍 sorry about the confusion.

[davidtheclark]

@bcoe I started trying to write this — then realized I'm not sure what's going on 😬

I'm looking at

highlights/src/highlights.coffee

Lines 150 to 153 in 5958609

	_highlightCommon: ({filePath, fileContents, scopeName}={}) ->
	grammar = @registry.grammarForScopeName(scopeName)
	grammar ?= selector.selectGrammar(@registry, filePath, fileContents)

and thinking:

• scopeName is used to get the grammar if you've registered a non-standard grammar that applies.
• fileName is used to get the grammar if you haven't.

Is that right?