Add warning for Linguist captures bug

Author: RedCMD

src/DiagnosticCollection.ts

@@ -200,6 +200,7 @@ async function Diagnostics(document: vscode.TextDocument) {
 		diagnosticsOnigurumaRegexErrors(diagnostics, trees),
 		diagnosticsBrokenIncludes(diagnostics, rootNode),
 		diagnosticsUnusedRepos(diagnostics, rootNode),
+		diagnosticsLinguistCaptures(diagnostics, rootNode),
 		diagnosticsDeadTextMateCode(diagnostics, rootNode),
 	]);
 
@@ -881,3 +882,42 @@ async function diagnosticsMismatchingRootScopeName(diagnostics: vscode.Diagnosti
 	}
 	// vscode.window.showInformationMessage(`scopeName ${(performance.now() - start).toFixed(3)}ms`);
 }
+
+async function diagnosticsLinguistCaptures(diagnostics: vscode.Diagnostic[], rootNode: webTreeSitter.Node) {
+	// vscode.window.showInformationMessage(JSON.stringify("diagnostics (captures)"))
+	// const start = performance.now();
+
+	const capturesQuery = `;scm
+		(captures		"{" (_ (key) @captures))
+		(beginCaptures	"{" (_ (key) @beginCaptures))
+		(endCaptures	"{" (_ (key) @endCaptures))
+		(whileCaptures	"{" (_ (key) @whileCaptures))
+		(captures		"{" (_ "{") @object)
+		(beginCaptures	"{" (_ "{") @object)
+		(endCaptures	"{" (_ "{") @object)
+		(whileCaptures	"{" (_ "{") @object)
+	`;
+	const capturesCaptures = queryNode(rootNode, capturesQuery);
+	// vscode.window.showInformationMessage(`(captures) ${JSON.stringify(capturesCaptures)} ${(performance.now() - start).toFixed(3)}ms`);
+	for (const captureCapture of capturesCaptures) {
+		const name = captureCapture.name;
+		if (name === 'object') {
+			diagnostics.pop();
+			continue;
+		}
+
+		const node = captureCapture.node;
+
+		const range = toRange(node);
+		const diagnostic: vscode.Diagnostic = {
+			range: range,
+			message: 'Incompatible with Github-Linguist. Only object values are supported within "captures"',
+			severity: vscode.DiagnosticSeverity.Warning,
+			source: 'TextMate',
+			code: 'captures',
+		};
+		diagnostics.push(diagnostic);
+	}
+
+	// vscode.window.showInformationMessage(`(captures) ${(performance.now() - start).toFixed(3)}ms`);
+}

src/Providers/DocumentSymbolProvider.ts

@@ -165,20 +165,24 @@ export const DocumentSymbolProvider: vscode.DocumentSymbolProvider = {
 
 function newDocumentSymbol(node: webTreeSitter.Node): vscode.DocumentSymbol {
 	let text = '';
+	let index = 0;
 	switch (node.type) {
-		case 'pattern':
+		case 'repo': // objects
+		case 'capture':
+			const firstChild = node.firstNamedChild;
+			if (firstChild?.type == 'key') {
+				text = firstChild.text;
+				break;
+			}
+			index = -1;
+		case 'pattern': // arrays
 		case 'injection':
-			let index = 0;
 			let sibling: webTreeSitter.Node | null = node;
 			while (sibling = sibling.previousNamedSibling) {
 				index++;
 			}
 			text = index.toString();
 			break;
-		case 'repo':
-		case 'capture':
-			text = node.firstNamedChild!.text;
-			break;
 		case 'name':
 			text = 'name';
 			break;

src/extension.ts

@@ -42,7 +42,7 @@ export async function activate(context: vscode.ExtensionContext) {
 	await initTreeSitter(context);
 	await initOniguruma(context);
 	initTextMate(context);
-	initDiagnostics(context);
+	await initDiagnostics(context);
 	initCallStackView(context);
 	initTokenColorCustomizations(context);
 	initThemeScopes(context);

src/tree-sitter/tree-sitter-json/grammar.js

@@ -7,7 +7,7 @@ module.exports = grammar({
 	name: "jsontm",
 	// word: $ => $._string,
 	extras: $ => [
-		//$._whitespace,
+		// $._whitespace,
 	],
 	externals: $ => [
 		$._forceStringNode, // Forces a 0width empty node if it is before a double quote " . Useful when querying the resulting syntax tree
@@ -459,7 +459,10 @@ module.exports = grammar({
 					),
 				),
 				array($,
-					$._pattern,
+					alias(
+						$._pattern,
+						$.capture,
+					),
 				),
 			),
 		),
@@ -474,7 +477,10 @@ module.exports = grammar({
 					),
 				),
 				array($,
-					$._pattern,
+					alias(
+						$._pattern,
+						$.capture,
+					),
 				),
 			),
 		),
@@ -489,7 +495,10 @@ module.exports = grammar({
 					),
 				),
 				array($,
-					$._pattern,
+					alias(
+						$._pattern,
+						$.capture,
+					),
 				),
 			),
 		),
@@ -504,7 +513,10 @@ module.exports = grammar({
 					),
 				),
 				array($,
-					$._pattern,
+					alias(
+						$._pattern,
+						$.capture,
+					),
 				),
 			),
 		),

vscode.tmLanguage.schema.json

@@ -842,7 +842,7 @@
 				"default": { }
 			},
 			"items": {
-				"markdownDescription": "An array of `\"captures\"` is not officially supported by VSCode TextMate  \nBut still happens to work because JavaScript's for-in works with both object (keys) array (indexes)",
+				"markdownDescription": "An array of `\"captures\"` is not officially supported by VSCode TextMate  \nBut still happens to work because JavaScript's for-in works with both object (keys) and array (indexes)\n  It is **not** supported by TextMate 2.0 or Github-Linguist",
 				"$ref": "#/definitions/capture"
 			},
 			"defaultSnippets": [