clang-format: [JS] keep triple slash directives intact.

mprobst · mprobst · commit 2083f31b88c5 · 2017-05-09T12:45:48.000Z
Summary: TypeScript uses triple slash directives of the form: /// <reference path="..."/> For various non-source instructions that should not be wrapped. Reference: https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html Reviewers: djasper Subscribers: cfe-commits, klimek Differential Revision: https://reviews.llvm.org/D32997 llvm-svn: 302523
diff --git a/clang/lib/Format/Format.cpp b/clang/lib/Format/Format.cpp
@@ -637,9 +637,10 @@ FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language) {
     GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
     GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
     GoogleStyle.BreakBeforeTernaryOperators = false;
-    // taze:, @tag followed by { for a lot of JSDoc tags, and @see, which is
-    // commonly followed by overlong URLs.
-    GoogleStyle.CommentPragmas = "(taze:|(@[A-Za-z_0-9-]+[ \\t]*{)|@see)";
+    // taze:, triple slash directives (`/// <...`), @tag followed by { for a lot
+    // of JSDoc tags, and @see, which is commonly followed by overlong URLs.
+    GoogleStyle.CommentPragmas =
+        "(taze:|^/[ \t]*<|(@[A-Za-z_0-9-]+[ \\t]*{)|@see)";
     GoogleStyle.MaxEmptyLinesToKeep = 3;
     GoogleStyle.NamespaceIndentation = FormatStyle::NI_All;
     GoogleStyle.SpacesInContainerLiterals = false;
diff --git a/clang/unittests/Format/FormatTestJS.cpp b/clang/unittests/Format/FormatTestJS.cpp
@@ -1785,6 +1785,7 @@ TEST_F(FormatTestJS, ImportComments) {
   verifyFormat("import {x} from 'x';  // from some location",
                getGoogleJSStyleWithColumns(25));
   verifyFormat("// taze: x from 'location'", getGoogleJSStyleWithColumns(10));
+  verifyFormat("/// <reference path=\"some/location\" />", getGoogleJSStyleWithColumns(10));
 }
 
 TEST_F(FormatTestJS, Exponentiation) {

Original file line number	Diff line number	Diff line change
`@@ -1785,6 +1785,7 @@ TEST_F(FormatTestJS, ImportComments) {`
`1785`	`1785`	`verifyFormat("import {x} from 'x'; // from some location",`
`1786`	`1786`	`getGoogleJSStyleWithColumns(25));`
`1787`	`1787`	`verifyFormat("// taze: x from 'location'", getGoogleJSStyleWithColumns(10));`
	`1788`	`+ verifyFormat("/// <reference path=\"some/location\" />", getGoogleJSStyleWithColumns(10));`
`1788`	`1789`	`}`
`1789`	`1790`
`1790`	`1791`	`TEST_F(FormatTestJS, Exponentiation) {`