Add support for indentation of fields with leading commas (#45)

Author: jimmeyer-els

src/main/com/intellij/lang/jsgraphql/ide/formatter/JSGraphQLBlock.java

@@ -107,6 +107,11 @@ public Indent getIndent() {
         if (myNode.getElementType() == JSGraphQLTokenTypes.RBRACE || myNode.getElementType() == JSGraphQLTokenTypes.LBRACE) {
             return Indent.getNoneIndent();
         }
+        if(myNode.getElementType() == JSGraphQLTokenTypes.PUNCTUATION) {
+            if(",".equals(myNode.getText())) {
+                return Indent.getNormalIndent();
+            }
+        }
 
         if(parent != null) {
             JSGraphQLElementType astNode = getAstNode(parent);

src/main/com/intellij/lang/jsgraphql/languageservice/api/Token.java

@@ -50,6 +50,16 @@ public void setKind(String kind) {
         this.kind = kind;
     }
 
+    public Token withTextAndOffset(String text, int offset) {
+        final Token token = new Token();
+        token.type = type;
+        token.text = text;
+        token.kind = kind;
+        token.start = start + offset;
+        token.end = token.start + text.length();
+        return token;
+    }
+
     @Override
     public String toString() {
         return "Token{" +

src/main/com/intellij/lang/jsgraphql/lexer/JSGraphQLCodeMirrorTokenMapper.java

@@ -18,12 +18,14 @@ public class JSGraphQLCodeMirrorTokenMapper {
 
     private final static Map<String, IElementType> mappings = Maps.newConcurrentMap();
 
+    public static final String CODEMIRROR_WHITESPACE = "ws";
+
     static {
         for (IElementType tokenType : JSGraphQLTokenTypes.ALL_TOKEN_TYPES) {
             if(tokenType instanceof JSGraphQLTokenType) {
                 mappings.put(((JSGraphQLTokenType)tokenType).getLexerTokenType(), tokenType);
             } else if(tokenType.equals(JSGraphQLTokenTypes.WHITESPACE)) {
-                mappings.put("ws", tokenType); // CodeMirror uses 'ws' for whitespace
+                mappings.put(CODEMIRROR_WHITESPACE, tokenType); // CodeMirror uses 'ws' for whitespace
             } else if(tokenType.equals(JSGraphQLTokenTypes.INVALIDCHAR)) {
                 mappings.put("invalidchar", tokenType); // CodeMirror uses 'invalidchar' for whitespace
             }

src/main/com/intellij/lang/jsgraphql/lexer/JSGraphQLLexer.java

@@ -18,6 +18,8 @@
 import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.project.Project;
 import com.intellij.psi.tree.IElementType;
+
+import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -99,6 +101,21 @@ private void fetchTokensFromLanguageService() {
                 final IElementType punctuationTokenType = getPunctuationTokenType(text);
                 if (punctuationTokenType != null) {
                     tokenType = punctuationTokenType;
+                } else if(text.contains(",")) {
+                    // separate out commas from surrounding whitespace to support indentation on ", field" lines
+                    int offset = 0;
+                    final String[] parts = StringUtils.splitByCharacterType(text);
+                    for (String part : parts) {
+                        final Token partSourceToken = token.withTextAndOffset(part, offset);
+                        if(part.equals(",")) {
+                            tokens.add(new JSGraphQLToken(tokenType, partSourceToken));
+                        } else {
+                            partSourceToken.setKind(JSGraphQLCodeMirrorTokenMapper.CODEMIRROR_WHITESPACE);
+                            tokens.add(new JSGraphQLToken(JSGraphQLTokenTypes.WHITESPACE, partSourceToken));
+                        }
+                        offset += part.length();
+                    }
+                    continue; // already added the required tokens
                 } else if (JSGraphQLKeywords.FRAGMENT_DOTS.equals(text)) {
                     // consider the "..." spread operator a keyword for highlighting
                     tokenType = JSGraphQLTokenTypes.KEYWORD;

test-resources/testData/FormatterExpectedResult.graphql

@@ -126,6 +126,17 @@ query queryName($foo: TestInput, $site: TestEnum = RED) {
     }
 }
 
+
+### comma before fields ###
+
+query Commas {
+    foo {
+        bar
+        , baz
+        , baz2
+    }
+}
+
 ### --------- annotations.graphql --------- ###
 
 type AnnotatedObject @foo(foo: {test: true}) {

test-resources/testData/FormatterTestData.graphql

@@ -126,6 +126,17 @@ __typename
 }
 }
 
+
+### comma before fields ###
+
+query Commas {
+foo {
+bar
+, baz
+, baz2
+}
+}
+
 ### --------- annotations.graphql --------- ###
 
 type AnnotatedObject @foo(foo: {test: true}) {

test-resources/testData/ParsingTestData.txt

@@ -493,7 +493,8 @@ GraphQL File(0,2428)
         PsiElement(OPEN_QUOTE)('"')(1471,1472)
         PsiElement(STRING)('foo')(1472,1475)
         PsiElement(CLOSE_QUOTE)('"')(1475,1476)
-        PsiElement(PUNCTUATION)(', ')(1476,1478)
+        PsiElement(PUNCTUATION)(',')(1476,1477)
+        PsiWhiteSpace(' ')(1477,1478)
         PsiElement(ATTRIBUTE)('option')(1478,1484)
         PsiElement(PUNCTUATION)(':')(1484,1485)
         PsiWhiteSpace(' ')(1485,1486)
@@ -577,7 +578,8 @@ GraphQL File(0,2428)
     PsiWhiteSpace(' ')(1734,1735)
     JSGraphQLNamedTypePsiElement(Atom)(1735,1744)
       PsiElement(ATOM)('TestInput')(1735,1744)
-    PsiElement(PUNCTUATION)(', ')(1744,1746)
+    PsiElement(PUNCTUATION)(',')(1744,1745)
+    PsiWhiteSpace(' ')(1745,1746)
     PsiElement(VARIABLE)('$')(1746,1747)
     PsiElement(VARIABLE)('site')(1747,1751)
     PsiElement(PUNCTUATION)(':')(1751,1752)
@@ -631,9 +633,11 @@ GraphQL File(0,2428)
           PsiWhiteSpace(' ')(1868,1869)
           PsiElement(LBRACKET)('[')(1869,1870)
           PsiElement(<UNKNOWN>)('RED')(1870,1873)
-          PsiElement(PUNCTUATION)(', ')(1873,1875)
+          PsiElement(PUNCTUATION)(',')(1873,1874)
+          PsiWhiteSpace(' ')(1874,1875)
           PsiElement(<UNKNOWN>)('GREEN')(1875,1880)
-          PsiElement(PUNCTUATION)(', ')(1880,1882)
+          PsiElement(PUNCTUATION)(',')(1880,1881)
+          PsiWhiteSpace(' ')(1881,1882)
           PsiElement(<UNKNOWN>)('BLUE')(1882,1886)
           PsiElement(RBRACKET)(']')(1886,1887)
           PsiWhiteSpace('\n')(1887,1888)
@@ -649,9 +653,11 @@ GraphQL File(0,2428)
           PsiWhiteSpace(' ')(1921,1922)
           PsiElement(LBRACKET)('[')(1922,1923)
           PsiElement(NUMBER)('1.23')(1923,1927)
-          PsiElement(PUNCTUATION)(', ')(1927,1929)
+          PsiElement(PUNCTUATION)(',')(1927,1928)
+          PsiWhiteSpace(' ')(1928,1929)
           PsiElement(NUMBER)('1.3e-1')(1929,1935)
-          PsiElement(PUNCTUATION)(', ')(1935,1937)
+          PsiElement(PUNCTUATION)(',')(1935,1936)
+          PsiWhiteSpace(' ')(1936,1937)
           PsiElement(NUMBER)('-1.35384e+3')(1937,1948)
           PsiElement(RBRACKET)(']')(1948,1949)
           PsiWhiteSpace('\n')(1949,1950)
@@ -810,7 +816,8 @@ GraphQL File(0,2428)
         PsiElement(OPEN_QUOTE)('"')(2340,2341)
         PsiElement(STRING)('test')(2341,2345)
         PsiElement(CLOSE_QUOTE)('"')(2345,2346)
-        PsiElement(PUNCTUATION)(', ')(2346,2348)
+        PsiElement(PUNCTUATION)(',')(2346,2347)
+        PsiWhiteSpace(' ')(2347,2348)
         PsiElement(ATTRIBUTE)('foo')(2348,2351)
         PsiElement(PUNCTUATION)(':')(2351,2352)
         PsiWhiteSpace(' ')(2352,2353)