Mark markdown comment folding regions as comments

mjbvz · mjbvz · commit 6e30cf38a76c · 2020-03-02T11:26:29.000-08:00
Fixes microsoft#91271
diff --git a/extensions/markdown-language-features/src/features/foldingProvider.ts b/extensions/markdown-language-features/src/features/foldingProvider.ts
@@ -77,6 +77,9 @@ export default class MarkdownFoldingProvider implements vscode.FoldingRangeProvi
 					return token.map[1] > token.map[0];
 
 				case 'html_block':
+					if (isRegionMarker(token)) {
+						return false;
+					}
 					return token.map[1] > token.map[0] + 1;
 
 				default:
@@ -92,7 +95,7 @@ export default class MarkdownFoldingProvider implements vscode.FoldingRangeProvi
 			if (document.lineAt(end).isEmptyOrWhitespace && end >= start + 1) {
 				end = end - 1;
 			}
-			return new vscode.FoldingRange(start, end);
+			return new vscode.FoldingRange(start, end, listItem.type === 'html_block' && listItem.content.startsWith('<!--') ? vscode.FoldingRangeKind.Comment : undefined);
 		});
 	}
 }
diff --git a/extensions/markdown-language-features/src/test/foldingProvider.test.ts b/extensions/markdown-language-features/src/test/foldingProvider.test.ts
@@ -175,6 +175,18 @@ a`);
 		assert.strictEqual(firstFold.start, 1);
 		assert.strictEqual(firstFold.end, 3);
 	});
+
+	test('Should fold html block comments', async () => {
+		const folds = await getFoldsForDocument(`x
+<!--
+fa
+-->`);
+		assert.strictEqual(folds.length, 1);
+		const firstFold = folds[0];
+		assert.strictEqual(firstFold.start, 1);
+		assert.strictEqual(firstFold.end, 3);
+		assert.strictEqual(firstFold.kind, vscode.FoldingRangeKind.Comment);
+	});
 });
 
 

Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,9 @@ export default class MarkdownFoldingProvider implements vscode.FoldingRangeProvi`
`77`	`77`	`return token.map[1] > token.map[0];`
`78`	`78`
`79`	`79`	`case 'html_block':`
	`80`	`+ if (isRegionMarker(token)) {`
	`81`	`+ return false;`
	`82`	`+ }`
`80`	`83`	`return token.map[1] > token.map[0] + 1;`
`81`	`84`
`82`	`85`	`default:`
`@@ -92,7 +95,7 @@ export default class MarkdownFoldingProvider implements vscode.FoldingRangeProvi`
`92`	`95`	`if (document.lineAt(end).isEmptyOrWhitespace && end >= start + 1) {`
`93`	`96`	`end = end - 1;`
`94`	`97`	`}`
`95`		`- return new vscode.FoldingRange(start, end);`
	`98`	`+ return new vscode.FoldingRange(start, end, listItem.type === 'html_block' && listItem.content.startsWith('<!--') ? vscode.FoldingRangeKind.Comment : undefined);`
`96`	`99`	`});`
`97`	`100`	`}`
`98`	`101`	`}`