Improve searchresult textmate scopes

2025-12-24 12:19:20 +00:00 · 2019-12-11 08:59:06 -08:00
parent 68db7fc3f7
commit 57c8caeb7c
2 changed files with 3178 additions and 1197 deletions
--- a/extensions/search-result/syntaxes/generateTMLanguage.js
+++ b/extensions/search-result/syntaxes/generateTMLanguage.js
@@ -1,36 +1,45 @@
 // @ts-check

-const languages = [
+const mappings = [
 	['bat', 'source.batchfile'],
 	['c', 'source.c'],
+	['cc', 'source.cpp'],
 	['clj', 'source.clojure'],
 	['coffee', 'source.coffee'],
 	['cpp', 'source.cpp'],
 	['cs', 'source.cs'],
+	['cshtml', 'text.html.cshtml'],
 	['css', 'source.css'],
 	['dart', 'source.dart'],
 	['diff', 'source.diff'],
-	['dockerfile', 'source.dockerfile'],
+	['dockerfile', 'source.dockerfile', '(?:dockerfile|Dockerfile)'],
 	['fs', 'source.fsharp'],
 	['go', 'source.go'],
 	['groovy', 'source.groovy'],
 	['h', 'source.objc'],
+	['handlebars', 'text.html.handlebars'],
+	['hbs', 'text.html.handlebars'],
+	['hlsl', 'source.hlsl'],
 	['hpp', 'source.objcpp'],
-	['html', 'source.html'],
+	['html', 'text.html.basic'],
+	['ini', 'source.ini'],
 	['java', 'source.java'],
 	['js', 'source.js'],
 	['json', 'source.json.comments'],
 	['jsx', 'source.js.jsx'],
 	['less', 'source.css.less'],
+	['log', 'text.log'],
 	['lua', 'source.lua'],
 	['m', 'source.objc'],
-	['make', 'source.makefile'],
+	['makefile', 'source.makefile', '(?:makefile|Makefile)(?:\\..*)?'],
+	['md', 'text.html.markdown'],
 	['mm', 'source.objcpp'],
 	['p6', 'source.perl.6'],
 	['perl', 'source.perl'],
 	['php', 'source.php'],
 	['pl', 'source.perl'],
 	['ps1', 'source.powershell'],
+	['pug', 'text.pug'],
 	['py', 'source.python'],
 	['r', 'source.r'],
 	['rb', 'source.ruby'],
@@ -42,121 +51,193 @@ const languages = [
 	['swift', 'source.swift'],
 	['ts', 'source.ts'],
 	['tsx', 'source.tsx'],
+	['vb', 'source.asp.vb.net'],
+	['xml', 'text.xml'],
 	['yaml', 'source.yaml'],
 ];

-const repository = {};
-languages.forEach(([ext, scope]) =>
-	repository[ext] = {
-		begin: `^(?!\\s)(.*?)([^\\\\\\/\\n]*.${ext})(:)$`,
-		end: "^(?!\\s)",
-		name: `searchResult.block.${ext}`,
-		beginCaptures: {
-			"0": {
-				name: "string path.searchResult"
-			},
-			"1": {
-				name: "dirname.path.searchResult"
-			},
-			"2": {
-				name: "basename.path.searchResult"
-			},
-			"3": {
-				name: "endingColon.path.searchResult"
+const scopes = {
+	root: 'text.searchResult',
+	header: {
+		meta: 'meta.header.search keyword.operator.word.search',
+		key: 'entity.other.attribute-name',
+		value: 'entity.other.attribute-value string.unquoted',
+		flags: {
+			keyword: 'keyword.other',
+		},
+		contextLines: {
+			number: 'constant.numeric.integer',
+			invalid: 'invalid.illegal',
+		},
+		query: {
+			escape: 'constant.character.escape',
+			invalid: 'invalid.illegal',
+		}
+	},
+	resultBlock: {
+		meta: 'meta.resultBlock.search',
+		path: {
+			meta: 'string meta.path.search',
+			dirname: 'meta.path.dirname.search',
+			basename: 'meta.path.basename.search',
+			colon: 'punctuation.separator',
+		},
+		result: {
+			meta: 'meta.resultLine.search',
+			metaSingleLine: 'meta.resultLine.singleLine.search',
+			metaMultiLine: 'meta.resultLine.multiLine.search',
+			prefix: {
+				meta: 'constant.numeric.integer meta.resultLinePrefix.search',
+				metaContext: 'meta.resultLinePrefix.contextLinePrefix.search',
+				metaMatch: 'meta.resultLinePrefix.matchLinePrefix.search',
+				lineNumber: 'meta.resultLinePrefix.lineNumber.search',
+				colon: 'punctuation.separator',
 			}
+		}
+	}
+};
+
+const repository = {};
+mappings.forEach(([ext, scope, regexp]) =>
+	repository[ext] = {
+		name: scopes.resultBlock.meta,
+		begin: `^(?!\\s)(.*?)([^\\\\\\/\\n]*${regexp || `\\.${ext}`})(:)$`,
+		end: "^(?!\\s)",
+		beginCaptures: {
+			"0": { name: scopes.resultBlock.path.meta },
+			"1": { name: scopes.resultBlock.path.dirname },
+			"2": { name: scopes.resultBlock.path.basename },
+			"3": { name: scopes.resultBlock.path.colon },
 		},
 		patterns: [
 			{
-				begin: "^  (\\d+)( )",
-				while: "^  (\\d+)(:| )",
+				name: [scopes.resultBlock.result.meta, scopes.resultBlock.result.metaMultiLine].join(' '),
+				begin: "^  ((\\d+) )",
+				while: "^  ((\\d+)(:))|((\\d+) )",
 				beginCaptures: {
-					"1": {
-						name: "constant.numeric lineNumber.searchResult resultPrefix.searchResult"
-					},
-					"2": {
-						name: "resultPrefixSeparator.searchResult resultPrefix.searchResult"
-					}
+					"0": { name: scopes.resultBlock.result.prefix.meta },
+					"1": { name: scopes.resultBlock.result.prefix.metaContext },
+					"2": { name: scopes.resultBlock.result.prefix.lineNumber },
 				},
 				whileCaptures: {
-					"1": {
-						name: "constant.numeric lineNumber.searchResult resultPrefix.searchResult"
-					},
-					"2": {
-						name: "resultPrefixSeparator.searchResult resultPrefix.searchResult"
-					}
+					"0": { name: scopes.resultBlock.result.prefix.meta },
+					"1": { name: scopes.resultBlock.result.prefix.metaMatch },
+					"2": { name: scopes.resultBlock.result.prefix.lineNumber },
+					"3": { name: scopes.resultBlock.result.prefix.colon },
+
+					"4": { name: scopes.resultBlock.result.prefix.metaContext },
+					"5": { name: scopes.resultBlock.result.prefix.lineNumber },
 				},
-				name: `searchResult.resultLine.${ext} searchResult.multiline`,
-				patterns: [
-					{
-						include: scope
-					}
-				]
+				patterns: [{ include: scope }]
 			},
 			{
-				match: "^  (\\d+)(:)(.*)",
-				name: `searchResult.resultLine.${ext} searchResult.singleline`,
-				captures: {
-					"1": {
-						name: "constant.numeric lineNumber.searchResult resultPrefix.searchResult"
-					},
-					"2": {
-						name: "resultPrefixSeparator.searchResult resultPrefix.searchResult"
-					},
-					"3": {
-						patterns: [
-							{
-								include: scope
-							}
-						]
-					}
-				}
+				begin: "^  ((\\d+)(:))",
+				while: "(?=not)possible",
+				name: [scopes.resultBlock.result.meta, scopes.resultBlock.result.metaSingleLine].join(' '),
+				beginCaptures: {
+					"0": { name: scopes.resultBlock.result.prefix.meta },
+					"1": { name: scopes.resultBlock.result.prefix.metaMatch },
+					"2": { name: scopes.resultBlock.result.prefix.lineNumber },
+					"3": { name: scopes.resultBlock.result.prefix.colon },
+				},
+				patterns: [{ include: scope }]
 			}
 		]
 	});

-const header = {
-	"match": "^# (Query|Flags|Including|Excluding|ContextLines): .*$",
-	"name": "comment"
-};
+const header = [
+	{
+		begin: "^(# Query): ",
+		end: "\n",
+		name: scopes.header.meta,
+		beginCaptures: { "1": { name: scopes.header.key }, },
+		patterns: [
+			{
+				match: '(\\\\n)|(\\\\\\\\)',
+				name: [scopes.header.value, scopes.header.query.escape].join(' ')
+			},
+			{
+				match: '\\\\.|\\\\$',
+				name: [scopes.header.value, scopes.header.query.invalid].join(' ')
+			},
+			{
+				match: '[^\\\\\\\n]+',
+				name: [scopes.header.value].join(' ')
+			},
+		]
+	},
+	{
+		begin: "^(# Flags): ",
+		end: "\n",
+		name: scopes.header.meta,
+		beginCaptures: { "1": { name: scopes.header.key }, },
+		patterns: [
+			{
+				match: '(RegExp|CaseSensitive|IgnoreExcludeSettings|WordMatch)',
+				name: [scopes.header.value, 'keyword.other'].join(' ')
+			},
+			{ match: '.' },
+		]
+	},
+	{
+		begin: "^(# ContextLines): ",
+		end: "\n",
+		name: scopes.header.meta,
+		beginCaptures: { "1": { name: scopes.header.key }, },
+		patterns: [
+			{
+				match: '\\d',
+				name: [scopes.header.value, scopes.header.contextLines.number].join(' ')
+			},
+			{ match: '.', name: scopes.header.contextLines.invalid },
+		]
+	},
+	{
+		match: "^(# (?:Including|Excluding)): (.*)$",
+		name: scopes.header.meta,
+		captures: {
+			"1": { name: scopes.header.key },
+			"2": { name: scopes.header.value }
+		}
+	},
+];

-const plainText = [{
-	match: "^(?!\\s)(.*?)([^\\\\\\/\\n]*)(:)$",
-	name: "string path.searchResult",
-	captures: {
-		"1": {
-			name: "dirname.path.searchResult"
-		},
-		"2": {
-			name: "basename.path.searchResult"
-		},
-		"3": {
-			name: "endingColon.path.searchResult"
+const plainText = [
+	{
+		match: "^(?!\\s)(.*?)([^\\\\\\/\\n]*)(:)$",
+		name: [scopes.resultBlock.meta, scopes.resultBlock.path.meta].join(' '),
+		captures: {
+			"1": { name: scopes.resultBlock.path.dirname },
+			"2": { name: scopes.resultBlock.path.basename },
+			"3": { name: scopes.resultBlock.path.colon }
+		}
+	},
+	{
+		match: "^  ((\\d+)(:))|((\\d+)( ))(.*)",
+		name: [scopes.resultBlock.meta, scopes.resultBlock.result.meta].join(' '),
+		captures: {
+			"1": { name: [scopes.resultBlock.result.prefix.meta, scopes.resultBlock.result.prefix.metaMatch].join(' ') },
+			"2": { name: scopes.resultBlock.result.prefix.lineNumber },
+			"3": { name: scopes.resultBlock.result.prefix.colon },
+
+			"4": { name: [scopes.resultBlock.result.prefix.meta, scopes.resultBlock.result.prefix.metaContext].join(' ') },
+			"5": { name: scopes.resultBlock.result.prefix.lineNumber },
 		}
 	}
-},
-{
-	match: "^  (\\d+)(:| )",
-	captures: {
-		"1": {
-			name: "constant.numeric lineNumber.searchResult resultPrefix.searchResult"
-		},
-		"2": {
-			name: "resultPrefixSeparator.searchResult resultPrefix.searchResult"
-		}
-	}
-}];
+];

 const tmLanguage = {
 	"information_for_contributors": "This file is generated from ./generateTMLanguage.js.",
 	name: "Search Results",
-	scopeName: "text.searchResult",
+	scopeName: scopes.root,
 	patterns: [
-		header,
-		...languages.map(([ext]) => ({ include: `#${ext}` })),
+		...header,
+		...mappings.map(([ext]) => ({ include: `#${ext}` })),
 		...plainText
 	],
 	repository
 };

-require('fs')
-	.writeFileSync(require('path').join(__dirname, './searchResult.tmLanguage.json'), JSON.stringify(tmLanguage, null, 2));
+require('fs').writeFileSync(
+	require('path').join(__dirname, './searchResult.tmLanguage.json'),
+	JSON.stringify(tmLanguage, null, 2));