Fix multiline jsdoc type highlightingFixes microsoft#27777

mjbvz · mjbvz · commit 0ae3ecbf15c6 · 2019-04-11T10:05:36.000-07:00
diff --git a/extensions/javascript/syntaxes/JavaScript.tmLanguage.json b/extensions/javascript/syntaxes/JavaScript.tmLanguage.json
@@ -5254,10 +5254,6 @@
 		},
 		"jsdoctype": {
 			"patterns": [
-				{
-					"name": "invalid.illegal.type.jsdoc",
-					"match": "\\G{(?:[^}*]|\\*[^/}])+$"
-				},
 				{
 					"contentName": "entity.name.type.instance.jsdoc",
 					"begin": "\\G({)",
diff --git a/extensions/javascript/syntaxes/JavaScriptReact.tmLanguage.json b/extensions/javascript/syntaxes/JavaScriptReact.tmLanguage.json
@@ -5254,10 +5254,6 @@
 		},
 		"jsdoctype": {
 			"patterns": [
-				{
-					"name": "invalid.illegal.type.jsdoc",
-					"match": "\\G{(?:[^}*]|\\*[^/}])+$"
-				},
 				{
 					"contentName": "entity.name.type.instance.jsdoc",
 					"begin": "\\G({)",
diff --git a/extensions/typescript-basics/build/update-grammars.js b/extensions/typescript-basics/build/update-grammars.js
@@ -17,6 +17,20 @@ function removeDom(grammar) {
 	return grammar;
 }
 
+function patchJsdoctype(grammar) {
+	grammar.repository['jsdoctype'].patterns = grammar.repository['jsdoctype'].patterns.filter(pattern => {
+		if (pattern.name && pattern.name.indexOf('illegal') >= -1) {
+			return false;
+		}
+		return true;
+	});
+	return grammar;
+}
+
+function patchGrammar(grammar) {
+	return removeDom(patchJsdoctype(grammar));
+}
+
 function adaptToJavaScript(grammar, replacementScope) {
 	grammar.name = 'JavaScript (with React support)';
 	grammar.fileTypes = ['.js', '.jsx', '.es6', '.mjs'];
@@ -44,7 +58,7 @@ function adaptToJavaScript(grammar, replacementScope) {
 }
 
 var tsGrammarRepo = 'Microsoft/TypeScript-TmLanguage';
-updateGrammar.update(tsGrammarRepo, 'TypeScript.tmLanguage', './syntaxes/TypeScript.tmLanguage.json', grammar => removeDom(grammar));
-updateGrammar.update(tsGrammarRepo, 'TypeScriptReact.tmLanguage', './syntaxes/TypeScriptReact.tmLanguage.json', grammar => removeDom(grammar));
-updateGrammar.update(tsGrammarRepo, 'TypeScriptReact.tmLanguage', '../javascript/syntaxes/JavaScript.tmLanguage.json', grammar => adaptToJavaScript(removeDom(grammar), '.js'));
-updateGrammar.update(tsGrammarRepo, 'TypeScriptReact.tmLanguage', '../javascript/syntaxes/JavaScriptReact.tmLanguage.json', grammar => adaptToJavaScript(removeDom(grammar), '.js.jsx'));
+updateGrammar.update(tsGrammarRepo, 'TypeScript.tmLanguage', './syntaxes/TypeScript.tmLanguage.json', grammar => patchGrammar(grammar));
+updateGrammar.update(tsGrammarRepo, 'TypeScriptReact.tmLanguage', './syntaxes/TypeScriptReact.tmLanguage.json', grammar => patchGrammar(grammar));
+updateGrammar.update(tsGrammarRepo, 'TypeScriptReact.tmLanguage', '../javascript/syntaxes/JavaScript.tmLanguage.json', grammar => adaptToJavaScript(patchGrammar(grammar), '.js'));
+updateGrammar.update(tsGrammarRepo, 'TypeScriptReact.tmLanguage', '../javascript/syntaxes/JavaScriptReact.tmLanguage.json', grammar => adaptToJavaScript(patchGrammar(grammar), '.js.jsx'));
diff --git a/extensions/typescript-basics/package.json b/extensions/typescript-basics/package.json
@@ -79,18 +79,8 @@
         }
       },
       {
-        "scopeName": "documentation.markdown.injection",
-        "path": "./syntaxes/MarkdownDocumentationInjection.tmLanguage.json",
-        "injectTo": [
-          "source.ts",
-          "source.tsx",
-          "source.js",
-          "source.js.jsx"
-        ]
-      },
-      {
-        "scopeName": "documentation.example.injection",
-        "path": "./syntaxes/ExampleJsDoc.injection.tmLanguage.json",
+        "scopeName": "documentation.injection",
+        "path": "./syntaxes/jsdoc.injection.tmLanguage.json",
         "injectTo": [
           "source.ts",
           "source.tsx",
diff --git a/extensions/typescript-basics/syntaxes/MarkdownDocumentationInjection.tmLanguage.json b/extensions/typescript-basics/syntaxes/MarkdownDocumentationInjection.tmLanguage.json
diff --git a/extensions/typescript-basics/syntaxes/TypeScript.tmLanguage.json b/extensions/typescript-basics/syntaxes/TypeScript.tmLanguage.json
@@ -5303,10 +5303,6 @@
 		},
 		"jsdoctype": {
 			"patterns": [
-				{
-					"name": "invalid.illegal.type.jsdoc",
-					"match": "\\G{(?:[^}*]|\\*[^/}])+$"
-				},
 				{
 					"contentName": "entity.name.type.instance.jsdoc",
 					"begin": "\\G({)",
diff --git a/extensions/typescript-basics/syntaxes/TypeScriptReact.tmLanguage.json b/extensions/typescript-basics/syntaxes/TypeScriptReact.tmLanguage.json
@@ -5254,10 +5254,6 @@
 		},
 		"jsdoctype": {
 			"patterns": [
-				{
-					"name": "invalid.illegal.type.jsdoc",
-					"match": "\\G{(?:[^}*]|\\*[^/}])+$"
-				},
 				{
 					"contentName": "entity.name.type.instance.jsdoc",
 					"begin": "\\G({)",
diff --git a/extensions/typescript-basics/syntaxes/jsdoc.injection.tmLanguage.json b/extensions/typescript-basics/syntaxes/jsdoc.injection.tmLanguage.json
@@ -2,10 +2,31 @@
 	"injectionSelector": "L:comment.block.documentation",
 	"patterns": [
 		{
-			"include": "#example"
+			"include": "#jsdocbody"
 		}
 	],
 	"repository": {
+		"jsdocbody": {
+			"begin": "(?<=/\\*\\*)([^*]|\\*(?!/))*$",
+			"while": "(^|\\G)\\s*\\*(?!/)(?=([^*]|[*](?!/))*$)",
+			"patterns": [
+				{
+					"include": "text.html.markdown#fenced_code_block"
+				},
+				{
+					"include": "text.html.markdown#lists"
+				},
+				{
+					"include": "#example"
+				},
+				{
+					"include": "source.ts#docblock"
+				},
+				{
+					"include": "text.html.markdown#inline"
+				}
+			]
+		},
 		"example": {
 			"begin": "((@)example)\\s+(?=([^*]|[*](?!/))*$).*$",
 			"while": "(^|\\G)\\s(?!@)(?=([^*]|[*](?!/))*$)",
@@ -25,5 +46,5 @@
 			]
 		}
 	},
-	"scopeName": "documentation.example.injection"
+	"scopeName": "documentation.injection"
 }
diff --git a/extensions/typescript-basics/test/colorize-fixtures/test-jsdoc-example.ts b/extensions/typescript-basics/test/colorize-fixtures/test-jsdoc-example.ts
@@ -0,0 +1,8 @@
+/**
+ * @example
+ * 1 + 1
+ *
+ * @other
+ * not colored
+ */
+const a = 1
diff --git a/extensions/typescript-basics/test/colorize-fixtures/test-jsdoc-markdown.ts b/extensions/typescript-basics/test/colorize-fixtures/test-jsdoc-markdown.ts
@@ -0,0 +1,7 @@
+/**
+ * **Bold**
+ * ```js
+ * 1 + code
+ * ```
+ */
+const a = 1
diff --git a/extensions/typescript-basics/test/colorize-fixtures/test-jsdoc-multiline-type.ts b/extensions/typescript-basics/test/colorize-fixtures/test-jsdoc-multiline-type.ts
@@ -0,0 +1,22 @@
+/**
+ * @typedef {{
+ *   id: number,
+ *   fn: !Function,
+ *   context: (!Object|undefined)
+ * }}
+ * @private
+ */
+goog.dom.animationFrame.Task_;
+
+
+/**
+ * @typedef {{
+ *   measureTask: goog.dom.animationFrame.Task_,
+ *   mutateTask: goog.dom.animationFrame.Task_,
+ *   state: (!Object|undefined),
+ *   args: (!Array|undefined),
+ *   isScheduled: boolean
+ * }}
+ * @private
+ */
+goog.dom.animationFrame.TaskSet_;
diff --git a/extensions/typescript-basics/test/colorize-results/test-jsdoc-example_ts.json b/extensions/typescript-basics/test/colorize-results/test-jsdoc-example_ts.json
diff --git a/extensions/typescript-basics/test/colorize-results/test-jsdoc-markdown_ts.json b/extensions/typescript-basics/test/colorize-results/test-jsdoc-markdown_ts.json
diff --git a/extensions/typescript-basics/test/colorize-results/test-jsdoc-multiline-type_ts.json b/extensions/typescript-basics/test/colorize-results/test-jsdoc-multiline-type_ts.json
