update a bit

Author: mysticatea

lib/rules/html-indent.js

@@ -155,7 +155,7 @@ function isComment (token) {
  * @returns {boolean} `false` if the token is a comment.
  */
 function isNotComment (token) {
-  return token != null && !token.type.endsWith('Comment')
+  return token != null && token.type !== 'Block' && token.type !== 'Line' && token.type !== 'Shebang' && !token.type.startsWith('Comment')
 }
 
 /**
@@ -218,12 +218,12 @@ function create (context) {
    * Process the given node list.
    * The first node is offsetted from the given left token.
    * Rest nodes are adjusted to the first node.
-   * @param {NodeList} nodeList The node to process.
+   * @param {Node[]} nodeList The node to process.
    * @param {boolean} canParenthized If `true` then the node can be parenthized.
    * @returns {void}
    */
   function processNodeList (nodeList, leftToken, rightToken, offset) {
-    let t
+    let t, u
 
     if (nodeList.length >= 1) {
       let lastToken = leftToken
@@ -232,31 +232,49 @@ function create (context) {
       for (let i = 0; i < nodeList.length; ++i) {
         const node = nodeList[i]
         if (node == null) {
+          // Holes of an array.
           continue
         }
 
+        // Get the first token of the node. If it's parenthesized then get the outermost left parenthesis.
         let elementFirstToken = template.getFirstToken(node)
+        let elementLastToken = template.getLastToken(node)
         t = elementFirstToken
-        while ((t = template.getTokenBefore(t)) != null && isLeftParen(t) && t.range[0] >= lastToken.range[1]) {
+        u = elementLastToken
+        while ((t = template.getTokenBefore(t)) != null && (u = template.getTokenAfter(u)) != null && isLeftParen(t) && isRightParen(u) && t.range[0] >= lastToken.range[1]) {
           elementFirstToken = t
+          elementLastToken = u
         }
 
+        // Collect related tokens.
+        // Commas between this and the previous, and the first token of this node.
         t = lastToken
-        while ((t = template.getTokenAfter(t)) != null && t.range[1] <= elementFirstToken.range[0]) {
-          alignTokens.push(t)
+        while ((u = template.getTokenAfter(t)) != null && u.range[1] <= elementFirstToken.range[0]) {
+          // This offset is smaller than the content, so it causes unintentional unindent.
+          // E.g.
+          // var obj = {
+          //     key:
+          //        value, // ← this comma is the same offset as `key`. It should avoid.
+          // }
+          if (u.loc.start.line !== t.loc.end.line) {
+            alignTokens.push(u)
+          }
+          t = u
         }
         alignTokens.push(elementFirstToken)
 
-        lastToken = template.getLastToken(node)
+        lastToken = elementLastToken
       }
 
+      // Check trailing commas.
       if (rightToken != null) {
         let t = lastToken
         while ((t = template.getTokenAfter(t)) != null && t.range[1] <= rightToken.range[0]) {
           alignTokens.push(t)
         }
       }
 
+      // Set offsets.
       const baseToken = alignTokens.shift()
       if (baseToken != null) {
         setOffset(baseToken, offset, leftToken)
@@ -465,19 +483,19 @@ function create (context) {
     }
 
     // Debug log
-    console.log('line', line, '=', indents[line], 'from:')
-    for (const token of tokens) {
-      const offsetInfo = offsets.get(token)
-      if (offsetInfo == null) {
-        console.log('    ', JSON.stringify(sourceCode.getText(token)), 'is unknown.')
-      } else if (offsetInfo.offset === 0) {
-        console.log('    ', JSON.stringify(sourceCode.getText(token)), 'is the same as', JSON.stringify(sourceCode.getText(offsetInfo.baseToken)), '(line', offsetInfo.baseToken.loc.start.line, ')')
-      } else if (offsetInfo.offset === EXACT) {
-        console.log('    ', JSON.stringify(sourceCode.getText(token)), 'is the exactly same as', JSON.stringify(sourceCode.getText(offsetInfo.baseToken)), '(line', offsetInfo.baseToken.loc.start.line, ')')
-      } else {
-        console.log('    ', JSON.stringify(sourceCode.getText(token)), 'is', offsetInfo.offset, 'offset from', JSON.stringify(sourceCode.getText(offsetInfo.baseToken)), '(line', offsetInfo.baseToken.loc.start.line, ')')
-      }
-    }
+    // console.log('line', line, '=', indents[line], 'from:')
+    // for (const token of tokens) {
+    //   const offsetInfo = offsets.get(token)
+    //   if (offsetInfo == null) {
+    //     console.log('    ', JSON.stringify(sourceCode.getText(token)), 'is unknown.')
+    //   } else if (offsetInfo.offset === 0) {
+    //     console.log('    ', JSON.stringify(sourceCode.getText(token)), 'is the same as', JSON.stringify(sourceCode.getText(offsetInfo.baseToken)), '(line', offsetInfo.baseToken.loc.start.line, ')')
+    //   } else if (offsetInfo.offset === EXACT) {
+    //     console.log('    ', JSON.stringify(sourceCode.getText(token)), 'is the exactly same as', JSON.stringify(sourceCode.getText(offsetInfo.baseToken)), '(line', offsetInfo.baseToken.loc.start.line, ')')
+    //   } else {
+    //     console.log('    ', JSON.stringify(sourceCode.getText(token)), 'is', offsetInfo.offset, 'offset from', JSON.stringify(sourceCode.getText(offsetInfo.baseToken)), '(line', offsetInfo.baseToken.loc.start.line, ')')
+    //   }
+    // }
 
     if (expectedIndent === Number.MAX_SAFE_INTEGER) {
       return
@@ -666,19 +684,18 @@ function create (context) {
     },
 
     ConditionalExpression (node) {
-      const headToken = getChainHeadToken(node)
+      const firstToken = template.getFirstToken(node)
       const questionToken = template.getTokenAfter(node.test, isNotRightParen)
       const consequentToken = template.getTokenAfter(questionToken)
       const colonToken = template.getTokenAfter(node.consequent, isNotRightParen)
       const alternateToken = template.getTokenAfter(colonToken)
       const isFlat = (node.test.loc.end.line === node.consequent.loc.start.line)
 
       if (isFlat) {
-        setOffset([questionToken, consequentToken, colonToken, alternateToken], 0, headToken)
+        setOffset([questionToken, consequentToken, colonToken, alternateToken], 0, firstToken)
       } else {
-        setOffset([questionToken, colonToken], 1, headToken)
-        setOffset(consequentToken, 1, questionToken)
-        setOffset(alternateToken, 1, colonToken)
+        setOffset([questionToken, colonToken], 1, firstToken)
+        setOffset([consequentToken, alternateToken], 1, questionToken)
       }
     },
 
@@ -707,8 +724,8 @@ function create (context) {
 
       setOffset(leftParenToken, 1, forToken)
       setOffset(leftToken, 1, leftParenToken)
-      setOffset(inToken, 1, leftParenToken)
-      setOffset(rightToken, 1, inToken)
+      setOffset(inToken, 1, leftToken)
+      setOffset(rightToken, 1, leftToken)
       setOffset(rightParenToken, 0, leftParenToken)
       processMaybeBlock(node.body, forToken)
     },
@@ -733,7 +750,7 @@ function create (context) {
         const bodyToken = template.getFirstToken(node.body)
 
         processNodeList(node.params, leftToken, rightToken, 1)
-        setOffset(bodyToken, 0, firstToken)
+        setOffset(bodyToken, 0, template.getFirstToken(node.parent))
       } else {
         // Normal functions.
         const functionToken = node.async ? template.getTokenAfter(firstToken) : firstToken
@@ -744,15 +761,15 @@ function create (context) {
         const bodyToken = template.getFirstToken(node.body)
 
         if (node.async) {
-          setOffset(functionToken, 1, firstToken)
+          setOffset(functionToken, 0, firstToken)
         }
         if (node.generator) {
-          setOffset(starToken, 1, functionToken)
+          setOffset(starToken, 1, firstToken)
         }
         if (node.id != null) {
-          setOffset(idToken, 1, starToken || functionToken)
+          setOffset(idToken, 1, firstToken)
         }
-        setOffset(leftToken, 1, idToken || starToken || functionToken)
+        setOffset(leftToken, 1, firstToken)
         processNodeList(node.params, leftToken, rightToken, 1)
         setOffset(bodyToken, 0, firstToken)
       }
@@ -797,8 +814,7 @@ function create (context) {
         const dotToken = template.getTokenBefore(node.property)
         const propertyToken = template.getTokenAfter(dotToken)
 
-        setOffset(dotToken, 1, objectToken)
-        setOffset(propertyToken, 1, dotToken)
+        setOffset([dotToken, propertyToken], 1, objectToken)
       }
     },
 
@@ -808,7 +824,7 @@ function create (context) {
       const hasPrefix = prefixTokens.length >= 1
 
       for (let i = 1; i < prefixTokens.length; ++i) {
-        setOffset(prefixTokens[i], 1, prefixTokens[i - 1])
+        setOffset(prefixTokens[i], 0, prefixTokens[i - 1])
       }
 
       let lastKeyToken = null
@@ -818,15 +834,15 @@ function create (context) {
         const keyRightToken = lastKeyToken = template.getTokenAfter(node.key, isRightBracket)
 
         if (hasPrefix) {
-          setOffset(keyLeftToken, 1, last(prefixTokens))
+          setOffset(keyLeftToken, 0, last(prefixTokens))
         }
         setOffset(keyToken, 1, keyLeftToken)
         setOffset(keyRightToken, 0, keyLeftToken)
       } else {
         const idToken = lastKeyToken = template.getFirstToken(node.key)
 
         if (hasPrefix) {
-          setOffset(idToken, 1, last(prefixTokens))
+          setOffset(idToken, 0, last(prefixTokens))
         }
       }
 
@@ -838,8 +854,7 @@ function create (context) {
         const colonToken = template.getTokenAfter(lastKeyToken)
         const valueToken = template.getTokenAfter(colonToken)
 
-        setOffset(colonToken, 1, lastKeyToken)
-        setOffset(valueToken, 1, colonToken)
+        setOffset([colonToken, valueToken], 1, lastKeyToken)
       }
     },
 
@@ -1033,7 +1048,7 @@ function create (context) {
       const indents = []
       let comments = []
       let tokensOnSameLine = []
-      let shouldSkip = false
+      let isBesideMultilineToken = false
 
       // Set the base indent.
       {
@@ -1042,25 +1057,29 @@ function create (context) {
         setOffset(firstToken, 0, firstToken)
       }
 
-      // Validate indentations of tokens.
+      // Validate indentation of tokens.
       for (const token of template.getTokens(node, { includeComments: true, filter: isNotWhitespace })) {
-        if (tokensOnSameLine.length === 0 || last(tokensOnSameLine).loc.start.line === token.loc.start.line) {
+        if (tokensOnSameLine.length === 0 || tokensOnSameLine[0].loc.start.line === token.loc.start.line) {
+          // This is on the same line (or the first token).
           tokensOnSameLine.push(token)
         } else if (tokensOnSameLine.every(isComment)) {
+          // New line is detected, but the all tokens of the previous line are comment.
+          // Comment lines are adjusted to the next code line.
           comments.push(tokensOnSameLine[0])
-          shouldSkip = (last(tokensOnSameLine).loc.end.line === token.loc.start.line)
+          isBesideMultilineToken = last(tokensOnSameLine).loc.end.line === token.loc.start.line
           tokensOnSameLine = [token]
         } else {
-          if (!shouldSkip) {
+          // New line is detected, so validate the tokens.
+          if (!isBesideMultilineToken) {
             validate(tokensOnSameLine, comments, indents)
           }
-          shouldSkip = (last(tokensOnSameLine).loc.end.line === token.loc.start.line)
+          isBesideMultilineToken = last(tokensOnSameLine).loc.end.line === token.loc.start.line
           tokensOnSameLine = [token]
           comments = []
         }
       }
       if (tokensOnSameLine.length >= 1 && tokensOnSameLine.some(isNotComment)) {
-        validate(tokensOnSameLine, [], indents)
+        validate(tokensOnSameLine, comments, indents)
       }
     }
   })