Merge pull request atom#19726 from atom/as-ns/fix-injected-grammars

Only cover scope boundaries in the parent layer if there is a scope boundary in the injected layer
gitoby · Jul 30, 2019 · cac1a77 · cac1a77
2 parents 0fddbc7 + a467402
commit cac1a77
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 2 deletions.
diff --git a/spec/tree-sitter-language-mode-spec.js b/spec/tree-sitter-language-mode-spec.js
@@ -18,6 +18,9 @@ const pythonGrammarPath = require.resolve(
 const jsGrammarPath = require.resolve(
   'language-javascript/grammars/tree-sitter-javascript.cson'
 );
+const jsdocGrammarPath = require.resolve(
+  'language-javascript/grammars/tree-sitter-jsdoc.cson'
+);
 const htmlGrammarPath = require.resolve(
   'language-html/grammars/tree-sitter-html.cson'
 );
@@ -518,7 +521,10 @@ describe('TreeSitterLanguageMode', () => {
             'template_substitution > "}"': 'interpolation'
           },
           injectionRegExp: 'javascript',
-          injectionPoints: [HTML_TEMPLATE_LITERAL_INJECTION_POINT]
+          injectionPoints: [
+            HTML_TEMPLATE_LITERAL_INJECTION_POINT,
+            JSDOC_INJECTION_POINT
+          ]
         });
 
         htmlGrammar = new TreeSitterGrammar(atom.grammars, htmlGrammarPath, {
@@ -834,6 +840,32 @@ describe('TreeSitterLanguageMode', () => {
         ]);
       });
 
+      it('only covers scope boundaries in parent layers if a nested layer has a boundary at the same position', async () => {
+        const jsdocGrammar = new TreeSitterGrammar(
+          atom.grammars,
+          jsdocGrammarPath,
+          {
+            scopeName: 'jsdoc',
+            parser: 'tree-sitter-jsdoc',
+            scopes: {},
+            injectionRegExp: 'jsdoc',
+            injectionPoints: []
+          }
+        );
+        atom.grammars.addGrammar(jsGrammar);
+        atom.grammars.addGrammar(jsdocGrammar);
+
+        editor.setGrammar(jsGrammar);
+        editor.setText('/**\n*/\n{\n}');
+
+        expectTokensToEqual(editor, [
+          [{ text: '/**', scopes: ['comment'] }],
+          [{ text: '*/', scopes: ['comment'] }],
+          [{ text: '{', scopes: [] }],
+          [{ text: '}', scopes: [] }]
+        ]);
+      });
+
       it('respects the `includeChildren` property of injection points', async () => {
         const rustGrammar = new TreeSitterGrammar(
           atom.grammars,
@@ -2417,3 +2449,13 @@ const SCRIPT_TAG_INJECTION_POINT = {
     return node.child(1);
   }
 };
+
+const JSDOC_INJECTION_POINT = {
+  type: 'comment',
+  language(comment) {
+    if (comment.text.startsWith('/**')) return 'jsdoc';
+  },
+  content(comment) {
+    return comment;
+  }
+};
diff --git a/src/tree-sitter-language-mode.js b/src/tree-sitter-language-mode.js
@@ -1010,7 +1010,8 @@ class HighlightIterator {
       if (
         next.offset === first.offset &&
         next.atEnd === first.atEnd &&
-        next.depth > first.depth
+        next.depth > first.depth &&
+        next.openTags.length + next.closeTags.length > 0
       ) {
         this.currentScopeIsCovered = true;
         return;