From: Krasimir Georgiev Date: Tue, 20 Nov 2018 14:22:43 +0000 (+0000) Subject: [clang-format] JS: don't treat is: as a type matcher X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e0df036e92af1685dac5521d4991870281c02162;p=clang [clang-format] JS: don't treat is: as a type matcher Summary: Clang-format is treating all occurences of `is` in js as type matchers. In some cases this is wrong, as it might be a dict key. Reviewers: mprobst Reviewed By: mprobst Subscribers: cfe-commits Differential Revision: https://reviews.llvm.org/D54753 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@347307 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/lib/Format/TokenAnnotator.cpp b/lib/Format/TokenAnnotator.cpp index 705ee1582c..fbc7691af4 100644 --- a/lib/Format/TokenAnnotator.cpp +++ b/lib/Format/TokenAnnotator.cpp @@ -3113,8 +3113,21 @@ bool TokenAnnotator::canBreakBefore(const AnnotatedLine &Line, // Don't wrap between ":" and "!" of a strict prop init ("field!: type;"). if (Left.is(tok::exclaim) && Right.is(tok::colon)) return false; - if (Right.is(Keywords.kw_is)) - return false; + // Look for is type annotations like: + // function f(): a is B { ... } + // Do not break before is in these cases. + if (Right.is(Keywords.kw_is)) { + const FormatToken* Next = Right.getNextNonComment(); + // If `is` is followed by a colon, it's likely that it's a dict key, so + // ignore it for this check. + // For example this is common in Polymer: + // Polymer({ + // is: 'name', + // ... + // }); + if (!Next || !Next->is(tok::colon)) + return false; + } if (Left.is(Keywords.kw_in)) return Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None; if (Right.is(Keywords.kw_in)) diff --git a/unittests/Format/FormatTestJS.cpp b/unittests/Format/FormatTestJS.cpp index 5a71f00337..a14724f85e 100644 --- a/unittests/Format/FormatTestJS.cpp +++ b/unittests/Format/FormatTestJS.cpp @@ -1186,6 +1186,16 @@ TEST_F(FormatTestJS, WrapRespectsAutomaticSemicolonInsertion) { getGoogleJSStyleWithColumns(25)); } +TEST_F(FormatTestJS, AddsIsTheDictKeyOnNewline) { + // Do not confuse is, the dict key with is, the type matcher. Put is, the dict + // key, on a newline. + verifyFormat("Polymer({\n" + " is: '', //\n" + " rest: 1\n" + "});", + getGoogleJSStyleWithColumns(20)); +} + TEST_F(FormatTestJS, AutomaticSemicolonInsertionHeuristic) { verifyFormat("a\n" "b;",