Merge pull request #629 from atom/mb-add-jsdoc

Add JSDoc injection w/ tree-sitter-jsdoc

Author: Max Brunsfeld

grammars/tree-sitter-javascript.cson

@@ -5,7 +5,7 @@ parser: 'tree-sitter-javascript'
 
 fileTypes: ['js', 'jsx']
 
-injectionRegex: 'js|javascript'
+injectionRegex: '^js$|^JS$|javascript|JavaScript'
 
 firstLineRegex: [
   # shebang line

grammars/tree-sitter-jsdoc.cson

@@ -0,0 +1,16 @@
+name: 'JSDoc'
+scopeName: 'source.jsdoc'
+type: 'tree-sitter'
+parser: 'tree-sitter-jsdoc'
+
+injectionRegex: '^jsdoc$'
+
+scopes:
+  'tag_name': 'keyword.control'
+  'identifier': 'variable.other.jsdoc'
+  'type': 'support.type'
+  'path_expression > identifier': 'string'
+  '"."': 'meta.delimiter.period'
+  '":"': 'meta.delimiter.colon'
+  '"/"': 'meta.delimiter.slash'
+  '"#", "~"': 'meta.delimiter'

lib/main.js

@@ -49,6 +49,18 @@ exports.activate = function () {
     language (regex) { return 'regex' },
     content (regex) { return regex }
   })
+
+  for (const scopeName of ['source.js', 'source.flow', 'source.ts']) {
+    atom.grammars.addInjectionPoint(scopeName, {
+      type: 'comment',
+      language (comment) {
+        if (comment.text.startsWith('/**')) return 'jsdoc'
+      },
+      content (comment) {
+        return comment
+      }
+    })
+  }
 }
 
 const STYLED_REGEX = /\bstyled\b/i

package.json

@@ -24,6 +24,7 @@
   },
   "dependencies": {
     "tree-sitter-javascript": "^0.13.8",
+    "tree-sitter-jsdoc": "^0.13.4",
     "tree-sitter-regex": "^0.13.1"
   }
 }