indent-common.js 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545
  1. /**
  2. * @author Toru Nagashima <https://github.com/mysticatea>
  3. * See LICENSE file in root directory for full license.
  4. */
  5. 'use strict'
  6. // ------------------------------------------------------------------------------
  7. // Requirements
  8. // ------------------------------------------------------------------------------
  9. const assert = require('assert')
  10. // ------------------------------------------------------------------------------
  11. // Helpers
  12. // ------------------------------------------------------------------------------
  13. const KNOWN_NODES = new Set(['ArrayExpression', 'ArrayPattern', 'ArrowFunctionExpression', 'AssignmentExpression', 'AssignmentPattern', 'AwaitExpression', 'BinaryExpression', 'BlockStatement', 'BreakStatement', 'CallExpression', 'CatchClause', 'ClassBody', 'ClassDeclaration', 'ClassExpression', 'ConditionalExpression', 'ContinueStatement', 'DebuggerStatement', 'DoWhileStatement', 'EmptyStatement', 'ExperimentalRestProperty', 'ExperimentalSpreadProperty', 'ExportAllDeclaration', 'ExportDefaultDeclaration', 'ExportNamedDeclaration', 'ExportSpecifier', 'ExpressionStatement', 'ForInStatement', 'ForOfStatement', 'ForStatement', 'FunctionDeclaration', 'FunctionExpression', 'Identifier', 'IfStatement', 'ImportDeclaration', 'ImportDefaultSpecifier', 'ImportNamespaceSpecifier', 'ImportSpecifier', 'LabeledStatement', 'Literal', 'LogicalExpression', 'MemberExpression', 'MetaProperty', 'MethodDefinition', 'NewExpression', 'ObjectExpression', 'ObjectPattern', 'Program', 'Property', 'RestElement', 'ReturnStatement', 'SequenceExpression', 'SpreadElement', 'Super', 'SwitchCase', 'SwitchStatement', 'TaggedTemplateExpression', 'TemplateElement', 'TemplateLiteral', 'ThisExpression', 'ThrowStatement', 'TryStatement', 'UnaryExpression', 'UpdateExpression', 'VariableDeclaration', 'VariableDeclarator', 'WhileStatement', 'WithStatement', 'YieldExpression', 'VAttribute', 'VDirectiveKey', 'VDocumentFragment', 'VElement', 'VEndTag', 'VExpressionContainer', 'VForExpression', 'VIdentifier', 'VLiteral', 'VOnExpression', 'VStartTag', 'VText'])
  14. const LT_CHAR = /[\r\n\u2028\u2029]/
  15. const LINES = /[^\r\n\u2028\u2029]+(?:$|\r\n|[\r\n\u2028\u2029])/g
  16. const BLOCK_COMMENT_PREFIX = /^\s*\*/
  17. const TRIVIAL_PUNCTUATOR = /^[(){}[\],;]$/
  18. /**
  19. * Normalize options.
  20. * @param {number|"tab"|undefined} type The type of indentation.
  21. * @param {Object} options Other options.
  22. * @param {Object} defaultOptions The default value of options.
  23. * @returns {{indentChar:" "|"\t",indentSize:number,baseIndent:number,attribute:number,closeBracket:number,switchCase:number,alignAttributesVertically:boolean,ignores:string[]}} Normalized options.
  24. */
  25. function parseOptions (type, options, defaultOptions) {
  26. const ret = Object.assign({
  27. indentChar: ' ',
  28. indentSize: 2,
  29. baseIndent: 0,
  30. attribute: 1,
  31. closeBracket: 0,
  32. switchCase: 0,
  33. alignAttributesVertically: true,
  34. ignores: []
  35. }, defaultOptions)
  36. if (Number.isSafeInteger(type)) {
  37. ret.indentSize = type
  38. } else if (type === 'tab') {
  39. ret.indentChar = '\t'
  40. ret.indentSize = 1
  41. }
  42. if (Number.isSafeInteger(options.baseIndent)) {
  43. ret.baseIndent = options.baseIndent
  44. }
  45. if (Number.isSafeInteger(options.attribute)) {
  46. ret.attribute = options.attribute
  47. }
  48. if (Number.isSafeInteger(options.closeBracket)) {
  49. ret.closeBracket = options.closeBracket
  50. }
  51. if (Number.isSafeInteger(options.switchCase)) {
  52. ret.switchCase = options.switchCase
  53. }
  54. if (options.alignAttributesVertically != null) {
  55. ret.alignAttributesVertically = options.alignAttributesVertically
  56. }
  57. if (options.ignores != null) {
  58. ret.ignores = options.ignores
  59. }
  60. return ret
  61. }
  62. /**
  63. * Check whether the given token is an arrow.
  64. * @param {Token} token The token to check.
  65. * @returns {boolean} `true` if the token is an arrow.
  66. */
  67. function isArrow (token) {
  68. return token != null && token.type === 'Punctuator' && token.value === '=>'
  69. }
  70. /**
  71. * Check whether the given token is a left parenthesis.
  72. * @param {Token} token The token to check.
  73. * @returns {boolean} `true` if the token is a left parenthesis.
  74. */
  75. function isLeftParen (token) {
  76. return token != null && token.type === 'Punctuator' && token.value === '('
  77. }
  78. /**
  79. * Check whether the given token is a left parenthesis.
  80. * @param {Token} token The token to check.
  81. * @returns {boolean} `false` if the token is a left parenthesis.
  82. */
  83. function isNotLeftParen (token) {
  84. return token != null && (token.type !== 'Punctuator' || token.value !== '(')
  85. }
  86. /**
  87. * Check whether the given token is a right parenthesis.
  88. * @param {Token} token The token to check.
  89. * @returns {boolean} `true` if the token is a right parenthesis.
  90. */
  91. function isRightParen (token) {
  92. return token != null && token.type === 'Punctuator' && token.value === ')'
  93. }
  94. /**
  95. * Check whether the given token is a right parenthesis.
  96. * @param {Token} token The token to check.
  97. * @returns {boolean} `false` if the token is a right parenthesis.
  98. */
  99. function isNotRightParen (token) {
  100. return token != null && (token.type !== 'Punctuator' || token.value !== ')')
  101. }
  102. /**
  103. * Check whether the given token is a left brace.
  104. * @param {Token} token The token to check.
  105. * @returns {boolean} `true` if the token is a left brace.
  106. */
  107. function isLeftBrace (token) {
  108. return token != null && token.type === 'Punctuator' && token.value === '{'
  109. }
  110. /**
  111. * Check whether the given token is a right brace.
  112. * @param {Token} token The token to check.
  113. * @returns {boolean} `true` if the token is a right brace.
  114. */
  115. function isRightBrace (token) {
  116. return token != null && token.type === 'Punctuator' && token.value === '}'
  117. }
  118. /**
  119. * Check whether the given token is a left bracket.
  120. * @param {Token} token The token to check.
  121. * @returns {boolean} `true` if the token is a left bracket.
  122. */
  123. function isLeftBracket (token) {
  124. return token != null && token.type === 'Punctuator' && token.value === '['
  125. }
  126. /**
  127. * Check whether the given token is a right bracket.
  128. * @param {Token} token The token to check.
  129. * @returns {boolean} `true` if the token is a right bracket.
  130. */
  131. function isRightBracket (token) {
  132. return token != null && token.type === 'Punctuator' && token.value === ']'
  133. }
  134. /**
  135. * Check whether the given token is a semicolon.
  136. * @param {Token} token The token to check.
  137. * @returns {boolean} `true` if the token is a semicolon.
  138. */
  139. function isSemicolon (token) {
  140. return token != null && token.type === 'Punctuator' && token.value === ';'
  141. }
  142. /**
  143. * Check whether the given token is a comma.
  144. * @param {Token} token The token to check.
  145. * @returns {boolean} `true` if the token is a comma.
  146. */
  147. function isComma (token) {
  148. return token != null && token.type === 'Punctuator' && token.value === ','
  149. }
  150. /**
  151. * Check whether the given token is a whitespace.
  152. * @param {Token} token The token to check.
  153. * @returns {boolean} `true` if the token is a whitespace.
  154. */
  155. function isNotWhitespace (token) {
  156. return token != null && token.type !== 'HTMLWhitespace'
  157. }
  158. /**
  159. * Check whether the given token is a comment.
  160. * @param {Token} token The token to check.
  161. * @returns {boolean} `true` if the token is a comment.
  162. */
  163. function isComment (token) {
  164. return token != null && (token.type === 'Block' || token.type === 'Line' || token.type === 'Shebang' || token.type.endsWith('Comment'))
  165. }
  166. /**
  167. * Check whether the given token is a comment.
  168. * @param {Token} token The token to check.
  169. * @returns {boolean} `false` if the token is a comment.
  170. */
  171. function isNotComment (token) {
  172. return token != null && token.type !== 'Block' && token.type !== 'Line' && token.type !== 'Shebang' && !token.type.endsWith('Comment')
  173. }
  174. /**
  175. * Get the last element.
  176. * @param {Array} xs The array to get the last element.
  177. * @returns {any|undefined} The last element or undefined.
  178. */
  179. function last (xs) {
  180. return xs.length === 0 ? undefined : xs[xs.length - 1]
  181. }
  182. /**
  183. * Check whether the node is at the beginning of line.
  184. * @param {Node} node The node to check.
  185. * @param {number} index The index of the node in the nodes.
  186. * @param {Node[]} nodes The array of nodes.
  187. * @returns {boolean} `true` if the node is at the beginning of line.
  188. */
  189. function isBeginningOfLine (node, index, nodes) {
  190. if (node != null) {
  191. for (let i = index - 1; i >= 0; --i) {
  192. const prevNode = nodes[i]
  193. if (prevNode == null) {
  194. continue
  195. }
  196. return node.loc.start.line !== prevNode.loc.end.line
  197. }
  198. }
  199. return false
  200. }
  201. /**
  202. * Check whether a given token is a closing token which triggers unindent.
  203. * @param {Token} token The token to check.
  204. * @returns {boolean} `true` if the token is a closing token.
  205. */
  206. function isClosingToken (token) {
  207. return token != null && (
  208. token.type === 'HTMLEndTagOpen' ||
  209. token.type === 'VExpressionEnd' ||
  210. (
  211. token.type === 'Punctuator' &&
  212. (
  213. token.value === ')' ||
  214. token.value === '}' ||
  215. token.value === ']'
  216. )
  217. )
  218. )
  219. }
  220. /**
  221. * Check whether a given token is trivial or not.
  222. * @param {Token} token The token to check.
  223. * @returns {boolean} `true` if the token is trivial.
  224. */
  225. function isTrivialToken (token) {
  226. return token != null && (
  227. (token.type === 'Punctuator' && TRIVIAL_PUNCTUATOR.test(token.value)) ||
  228. token.type === 'HTMLTagOpen' ||
  229. token.type === 'HTMLEndTagOpen' ||
  230. token.type === 'HTMLTagClose' ||
  231. token.type === 'HTMLSelfClosingTagClose'
  232. )
  233. }
  234. /**
  235. * Creates AST event handlers for html-indent.
  236. *
  237. * @param {RuleContext} context The rule context.
  238. * @param {TokenStore} tokenStore The token store object to get tokens.
  239. * @param {Object} defaultOptions The default value of options.
  240. * @returns {object} AST event handlers.
  241. */
  242. module.exports.defineVisitor = function create (context, tokenStore, defaultOptions) {
  243. const options = parseOptions(context.options[0], context.options[1] || {}, defaultOptions)
  244. const sourceCode = context.getSourceCode()
  245. const offsets = new Map()
  246. /**
  247. * Set offset to the given tokens.
  248. * @param {Token|Token[]} token The token to set.
  249. * @param {number} offset The offset of the tokens.
  250. * @param {Token} baseToken The token of the base offset.
  251. * @param {boolean} [trivial=false] The flag for trivial tokens.
  252. * @returns {void}
  253. */
  254. function setOffset (token, offset, baseToken) {
  255. assert(baseToken != null, "'baseToken' should not be null or undefined.")
  256. if (Array.isArray(token)) {
  257. for (const t of token) {
  258. offsets.set(t, {
  259. baseToken,
  260. offset,
  261. baseline: false,
  262. expectedIndent: undefined
  263. })
  264. }
  265. } else {
  266. offsets.set(token, {
  267. baseToken,
  268. offset,
  269. baseline: false,
  270. expectedIndent: undefined
  271. })
  272. }
  273. }
  274. /**
  275. * Set baseline flag to the given token.
  276. * @param {Token} token The token to set.
  277. * @returns {void}
  278. */
  279. function setBaseline (token, hardTabAdditional) {
  280. const offsetInfo = offsets.get(token)
  281. if (offsetInfo != null) {
  282. offsetInfo.baseline = true
  283. }
  284. }
  285. /**
  286. * Get the first and last tokens of the given node.
  287. * If the node is parenthesized, this gets the outermost parentheses.
  288. * @param {Node} node The node to get.
  289. * @param {number} [borderOffset] The least offset of the first token. Defailt is 0. This value is used to prevent false positive in the following case: `(a) => {}` The parentheses are enclosing the whole parameter part rather than the first parameter, but this offset parameter is needed to distinguish.
  290. * @returns {{firstToken:Token,lastToken:Token}} The gotten tokens.
  291. */
  292. function getFirstAndLastTokens (node, borderOffset) {
  293. borderOffset |= 0
  294. let firstToken = tokenStore.getFirstToken(node)
  295. let lastToken = tokenStore.getLastToken(node)
  296. // Get the outermost left parenthesis if it's parenthesized.
  297. let t, u
  298. while ((t = tokenStore.getTokenBefore(firstToken)) != null && (u = tokenStore.getTokenAfter(lastToken)) != null && isLeftParen(t) && isRightParen(u) && t.range[0] >= borderOffset) {
  299. firstToken = t
  300. lastToken = u
  301. }
  302. return { firstToken, lastToken }
  303. }
  304. /**
  305. * Process the given node list.
  306. * The first node is offsetted from the given left token.
  307. * Rest nodes are adjusted to the first node.
  308. * @param {Node[]} nodeList The node to process.
  309. * @param {Node|null} leftToken The left parenthesis token.
  310. * @param {Node|null} rightToken The right parenthesis token.
  311. * @param {number} offset The offset to set.
  312. * @param {Node} [alignVertically=true] The flag to align vertically. If `false`, this doesn't align vertically even if the first node is not at beginning of line.
  313. * @returns {void}
  314. */
  315. function processNodeList (nodeList, leftToken, rightToken, offset, alignVertically) {
  316. let t
  317. if (nodeList.length >= 1) {
  318. let lastToken = leftToken
  319. const alignTokens = []
  320. for (let i = 0; i < nodeList.length; ++i) {
  321. const node = nodeList[i]
  322. if (node == null) {
  323. // Holes of an array.
  324. continue
  325. }
  326. const elementTokens = getFirstAndLastTokens(node, lastToken != null ? lastToken.range[1] : 0)
  327. // Collect related tokens.
  328. // Commas between this and the previous, and the first token of this node.
  329. if (lastToken != null) {
  330. t = lastToken
  331. while ((t = tokenStore.getTokenAfter(t)) != null && t.range[1] <= elementTokens.firstToken.range[0]) {
  332. alignTokens.push(t)
  333. }
  334. }
  335. alignTokens.push(elementTokens.firstToken)
  336. // Save the last token to find tokens between the next token.
  337. lastToken = elementTokens.lastToken
  338. }
  339. // Check trailing commas.
  340. if (rightToken != null && lastToken != null) {
  341. t = lastToken
  342. while ((t = tokenStore.getTokenAfter(t)) != null && t.range[1] <= rightToken.range[0]) {
  343. alignTokens.push(t)
  344. }
  345. }
  346. // Set offsets.
  347. const baseToken = alignTokens.shift()
  348. if (baseToken != null) {
  349. // Set offset to the first token.
  350. if (leftToken != null) {
  351. setOffset(baseToken, offset, leftToken)
  352. }
  353. // Set baseline.
  354. if (nodeList.some(isBeginningOfLine)) {
  355. setBaseline(baseToken)
  356. }
  357. if (alignVertically === false) {
  358. // Align tokens relatively to the left token.
  359. setOffset(alignTokens, offset, leftToken)
  360. } else {
  361. // Align the rest tokens to the first token.
  362. setOffset(alignTokens, 0, baseToken)
  363. }
  364. }
  365. }
  366. if (rightToken != null) {
  367. setOffset(rightToken, 0, leftToken)
  368. }
  369. }
  370. /**
  371. * Process the given node as body.
  372. * The body node maybe a block statement or an expression node.
  373. * @param {Node} node The body node to process.
  374. * @param {Token} baseToken The base token.
  375. * @returns {void}
  376. */
  377. function processMaybeBlock (node, baseToken) {
  378. const firstToken = getFirstAndLastTokens(node).firstToken
  379. setOffset(firstToken, isLeftBrace(firstToken) ? 0 : 1, baseToken)
  380. }
  381. /**
  382. * Collect prefix tokens of the given property.
  383. * The prefix includes `async`, `get`, `set`, `static`, and `*`.
  384. * @param {Property|MethodDefinition} node The property node to collect prefix tokens.
  385. */
  386. function getPrefixTokens (node) {
  387. const prefixes = []
  388. let token = tokenStore.getFirstToken(node)
  389. while (token != null && token.range[1] <= node.key.range[0]) {
  390. prefixes.push(token)
  391. token = tokenStore.getTokenAfter(token)
  392. }
  393. while (isLeftParen(last(prefixes)) || isLeftBracket(last(prefixes))) {
  394. prefixes.pop()
  395. }
  396. return prefixes
  397. }
  398. /**
  399. * Find the head of chaining nodes.
  400. * @param {Node} node The start node to find the head.
  401. * @returns {Token} The head token of the chain.
  402. */
  403. function getChainHeadToken (node) {
  404. const type = node.type
  405. while (node.parent.type === type) {
  406. node = node.parent
  407. }
  408. return tokenStore.getFirstToken(node)
  409. }
  410. /**
  411. * Check whether a given token is the first token of:
  412. *
  413. * - ExpressionStatement
  414. * - VExpressionContainer
  415. * - A parameter of CallExpression/NewExpression
  416. * - An element of ArrayExpression
  417. * - An expression of SequenceExpression
  418. *
  419. * @param {Token} token The token to check.
  420. * @param {Node} belongingNode The node that the token is belonging to.
  421. * @returns {boolean} `true` if the token is the first token of an element.
  422. */
  423. function isBeginningOfElement (token, belongingNode) {
  424. let node = belongingNode
  425. while (node != null) {
  426. const parent = node.parent
  427. const t = parent && parent.type
  428. if (t != null && (t.endsWith('Statement') || t.endsWith('Declaration'))) {
  429. return parent.range[0] === token.range[0]
  430. }
  431. if (t === 'VExpressionContainer') {
  432. return node.range[0] === token.range[0]
  433. }
  434. if (t === 'CallExpression' || t === 'NewExpression') {
  435. const openParen = tokenStore.getTokenAfter(parent.callee, isNotRightParen)
  436. return parent.arguments.some(param =>
  437. getFirstAndLastTokens(param, openParen.range[1]).firstToken.range[0] === token.range[0]
  438. )
  439. }
  440. if (t === 'ArrayExpression') {
  441. return parent.elements.some(element =>
  442. element != null &&
  443. getFirstAndLastTokens(element).firstToken.range[0] === token.range[0]
  444. )
  445. }
  446. if (t === 'SequenceExpression') {
  447. return parent.expressions.some(expr =>
  448. getFirstAndLastTokens(expr).firstToken.range[0] === token.range[0]
  449. )
  450. }
  451. node = parent
  452. }
  453. return false
  454. }
  455. /**
  456. * Set the base indentation to a given top-level AST node.
  457. * @param {Node} node The node to set.
  458. * @param {number} expectedIndent The number of expected indent.
  459. * @returns {void}
  460. */
  461. function processTopLevelNode (node, expectedIndent) {
  462. const token = tokenStore.getFirstToken(node)
  463. const offsetInfo = offsets.get(token)
  464. if (offsetInfo != null) {
  465. offsetInfo.expectedIndent = expectedIndent
  466. } else {
  467. offsets.set(token, { baseToken: null, offset: 0, baseline: false, expectedIndent })
  468. }
  469. }
  470. /**
  471. * Ignore all tokens of the given node.
  472. * @param {Node} node The node to ignore.
  473. * @returns {void}
  474. */
  475. function ignore (node) {
  476. for (const token of tokenStore.getTokens(node)) {
  477. offsets.delete(token)
  478. }
  479. }
  480. /**
  481. * Define functions to ignore nodes into the given visitor.
  482. * @param {Object} visitor The visitor to define functions to ignore nodes.
  483. * @returns {Object} The visitor.
  484. */
  485. function processIgnores (visitor) {
  486. for (const ignorePattern of options.ignores) {
  487. const key = `${ignorePattern}:exit`
  488. if (visitor.hasOwnProperty(key)) {
  489. const handler = visitor[key]
  490. visitor[key] = function (node) {
  491. const ret = handler.apply(this, arguments)
  492. ignore(node)
  493. return ret
  494. }
  495. } else {
  496. visitor[key] = ignore
  497. }
  498. }
  499. return visitor
  500. }
  501. /**
  502. * Calculate correct indentation of the line of the given tokens.
  503. * @param {Token[]} tokens Tokens which are on the same line.
  504. * @returns {number} Correct indentation. If it failed to calculate then `Number.MAX_SAFE_INTEGER`.
  505. */
  506. function getExpectedIndent (tokens) {
  507. const trivial = isTrivialToken(tokens[0])
  508. let expectedIndent = Number.MAX_SAFE_INTEGER
  509. for (let i = 0; i < tokens.length; ++i) {
  510. const token = tokens[i]
  511. const offsetInfo = offsets.get(token)
  512. // If the first token is not trivial then ignore trivial following tokens.
  513. if (offsetInfo != null && (trivial || !isTrivialToken(token))) {
  514. if (offsetInfo.expectedIndent != null) {
  515. expectedIndent = Math.min(expectedIndent, offsetInfo.expectedIndent)
  516. } else {
  517. const baseOffsetInfo = offsets.get(offsetInfo.baseToken)
  518. if (baseOffsetInfo != null && baseOffsetInfo.expectedIndent != null && (i === 0 || !baseOffsetInfo.baseline)) {
  519. expectedIndent = Math.min(expectedIndent, baseOffsetInfo.expectedIndent + offsetInfo.offset * options.indentSize)
  520. if (baseOffsetInfo.baseline) {
  521. break
  522. }
  523. }
  524. }
  525. }
  526. }
  527. return expectedIndent
  528. }
  529. /**
  530. * Get the text of the indentation part of the line which the given token is on.
  531. * @param {Token} firstToken The first token on a line.
  532. * @returns {string} The text of indentation part.
  533. */
  534. function getIndentText (firstToken) {
  535. const text = sourceCode.text
  536. let i = firstToken.range[0] - 1
  537. while (i >= 0 && !LT_CHAR.test(text[i])) {
  538. i -= 1
  539. }
  540. return text.slice(i + 1, firstToken.range[0])
  541. }
  542. /**
  543. * Define the function which fixes the problem.
  544. * @param {Token} token The token to fix.
  545. * @param {number} actualIndent The number of actual indentaion.
  546. * @param {number} expectedIndent The number of expected indentation.
  547. * @returns {Function} The defined function.
  548. */
  549. function defineFix (token, actualIndent, expectedIndent) {
  550. if (token.type === 'Block' && token.loc.start.line !== token.loc.end.line) {
  551. // Fix indentation in multiline block comments.
  552. const lines = sourceCode.getText(token).match(LINES)
  553. const firstLine = lines.shift()
  554. if (lines.every(l => BLOCK_COMMENT_PREFIX.test(l))) {
  555. return fixer => {
  556. const range = [token.range[0] - actualIndent, token.range[1]]
  557. const indent = options.indentChar.repeat(expectedIndent)
  558. return fixer.replaceTextRange(
  559. range,
  560. `${indent}${firstLine}${lines.map(l => l.replace(BLOCK_COMMENT_PREFIX, `${indent} *`)).join('')}`
  561. )
  562. }
  563. }
  564. }
  565. return fixer => {
  566. const range = [token.range[0] - actualIndent, token.range[0]]
  567. const indent = options.indentChar.repeat(expectedIndent)
  568. return fixer.replaceTextRange(range, indent)
  569. }
  570. }
  571. /**
  572. * Validate the given token with the pre-calculated expected indentation.
  573. * @param {Token} token The token to validate.
  574. * @param {number} expectedIndent The expected indentation.
  575. * @param {number|undefined} optionalExpectedIndent The optional expected indentation.
  576. * @returns {void}
  577. */
  578. function validateCore (token, expectedIndent, optionalExpectedIndent) {
  579. const line = token.loc.start.line
  580. const indentText = getIndentText(token)
  581. // If there is no line terminator after the `<script>` start tag,
  582. // `indentText` contains non-whitespace characters.
  583. // In that case, do nothing in order to prevent removing the `<script>` tag.
  584. if (indentText.trim() !== '') {
  585. return
  586. }
  587. const actualIndent = token.loc.start.column
  588. const unit = (options.indentChar === '\t' ? 'tab' : 'space')
  589. for (let i = 0; i < indentText.length; ++i) {
  590. if (indentText[i] !== options.indentChar) {
  591. context.report({
  592. loc: {
  593. start: { line, column: i },
  594. end: { line, column: i + 1 }
  595. },
  596. message: 'Expected {{expected}} character, but found {{actual}} character.',
  597. data: {
  598. expected: JSON.stringify(options.indentChar),
  599. actual: JSON.stringify(indentText[i])
  600. },
  601. fix: defineFix(token, actualIndent, expectedIndent)
  602. })
  603. return
  604. }
  605. }
  606. if (actualIndent !== expectedIndent && (optionalExpectedIndent === undefined || actualIndent !== optionalExpectedIndent)) {
  607. context.report({
  608. loc: {
  609. start: { line, column: 0 },
  610. end: { line, column: actualIndent }
  611. },
  612. message: 'Expected indentation of {{expectedIndent}} {{unit}}{{expectedIndentPlural}} but found {{actualIndent}} {{unit}}{{actualIndentPlural}}.',
  613. data: {
  614. expectedIndent,
  615. actualIndent,
  616. unit,
  617. expectedIndentPlural: (expectedIndent === 1) ? '' : 's',
  618. actualIndentPlural: (actualIndent === 1) ? '' : 's'
  619. },
  620. fix: defineFix(token, actualIndent, expectedIndent)
  621. })
  622. }
  623. }
  624. /**
  625. * Get the expected indent of comments.
  626. * @param {Token|null} nextToken The next token of comments.
  627. * @param {number|undefined} nextExpectedIndent The expected indent of the next token.
  628. * @param {number|undefined} lastExpectedIndent The expected indent of the last token.
  629. * @returns {{primary:number|undefined,secondary:number|undefined}}
  630. */
  631. function getCommentExpectedIndents (nextToken, nextExpectedIndent, lastExpectedIndent) {
  632. if (typeof lastExpectedIndent === 'number' && isClosingToken(nextToken)) {
  633. if (nextExpectedIndent === lastExpectedIndent) {
  634. // For solo comment. E.g.,
  635. // <div>
  636. // <!-- comment -->
  637. // </div>
  638. return {
  639. primary: nextExpectedIndent + options.indentSize,
  640. secondary: undefined
  641. }
  642. }
  643. // For last comment. E.g.,
  644. // <div>
  645. // <div></div>
  646. // <!-- comment -->
  647. // </div>
  648. return { primary: lastExpectedIndent, secondary: nextExpectedIndent }
  649. }
  650. // Adjust to next normally. E.g.,
  651. // <div>
  652. // <!-- comment -->
  653. // <div></div>
  654. // </div>
  655. return { primary: nextExpectedIndent, secondary: undefined }
  656. }
  657. /**
  658. * Validate indentation of the line that the given tokens are on.
  659. * @param {Token[]} tokens The tokens on the same line to validate.
  660. * @param {Token[]} comments The comments which are on the immediately previous lines of the tokens.
  661. * @param {Token|null} lastToken The last validated token. Comments can adjust to the token.
  662. * @returns {void}
  663. */
  664. function validate (tokens, comments, lastToken) {
  665. // Calculate and save expected indentation.
  666. const firstToken = tokens[0]
  667. const actualIndent = firstToken.loc.start.column
  668. const expectedIndent = getExpectedIndent(tokens)
  669. if (expectedIndent === Number.MAX_SAFE_INTEGER) {
  670. return
  671. }
  672. // Debug log
  673. // console.log('line', firstToken.loc.start.line, '=', { actualIndent, expectedIndent }, 'from:')
  674. // for (const token of tokens) {
  675. // const offsetInfo = offsets.get(token)
  676. // if (offsetInfo == null) {
  677. // console.log(' ', JSON.stringify(sourceCode.getText(token)), 'is unknown.')
  678. // } else if (offsetInfo.expectedIndent != null) {
  679. // console.log(' ', JSON.stringify(sourceCode.getText(token)), 'is fixed at', offsetInfo.expectedIndent, '.')
  680. // } else {
  681. // const baseOffsetInfo = offsets.get(offsetInfo.baseToken)
  682. // console.log(' ', JSON.stringify(sourceCode.getText(token)), 'is', offsetInfo.offset, 'offset from ', JSON.stringify(sourceCode.getText(offsetInfo.baseToken)), '( line:', offsetInfo.baseToken && offsetInfo.baseToken.loc.start.line, ', indent:', baseOffsetInfo && baseOffsetInfo.expectedIndent, ', baseline:', baseOffsetInfo && baseOffsetInfo.baseline, ')')
  683. // }
  684. // }
  685. // Save.
  686. const baseline = new Set()
  687. for (const token of tokens) {
  688. const offsetInfo = offsets.get(token)
  689. if (offsetInfo != null) {
  690. if (offsetInfo.baseline) {
  691. // This is a baseline token, so the expected indent is the column of this token.
  692. if (options.indentChar === ' ') {
  693. offsetInfo.expectedIndent = Math.max(0, token.loc.start.column + expectedIndent - actualIndent)
  694. } else {
  695. // In hard-tabs mode, it cannot align tokens strictly, so use one additional offset.
  696. // But the additional offset isn't needed if it's at the beginning of the line.
  697. offsetInfo.expectedIndent = expectedIndent + (token === tokens[0] ? 0 : 1)
  698. }
  699. baseline.add(token)
  700. } else if (baseline.has(offsetInfo.baseToken)) {
  701. // The base token is a baseline token on this line, so inherit it.
  702. offsetInfo.expectedIndent = offsets.get(offsetInfo.baseToken).expectedIndent
  703. baseline.add(token)
  704. } else {
  705. // Otherwise, set the expected indent of this line.
  706. offsetInfo.expectedIndent = expectedIndent
  707. }
  708. }
  709. }
  710. // Calculate the expected indents for comments.
  711. // It allows the same indent level with the previous line.
  712. const lastOffsetInfo = offsets.get(lastToken)
  713. const lastExpectedIndent = lastOffsetInfo && lastOffsetInfo.expectedIndent
  714. const commentExpectedIndents = getCommentExpectedIndents(firstToken, expectedIndent, lastExpectedIndent)
  715. // Validate.
  716. for (const comment of comments) {
  717. validateCore(comment, commentExpectedIndents.primary, commentExpectedIndents.secondary)
  718. }
  719. validateCore(firstToken, expectedIndent)
  720. }
  721. // ------------------------------------------------------------------------------
  722. // Main
  723. // ------------------------------------------------------------------------------
  724. return processIgnores({
  725. VAttribute (node) {
  726. const keyToken = tokenStore.getFirstToken(node)
  727. const eqToken = tokenStore.getFirstToken(node, 1)
  728. if (eqToken != null) {
  729. setOffset(eqToken, 1, keyToken)
  730. const valueToken = tokenStore.getFirstToken(node, 2)
  731. if (valueToken != null) {
  732. setOffset(valueToken, 1, keyToken)
  733. }
  734. }
  735. },
  736. VElement (node) {
  737. const startTagToken = tokenStore.getFirstToken(node)
  738. const endTagToken = node.endTag && tokenStore.getFirstToken(node.endTag)
  739. if (node.name !== 'pre') {
  740. const childTokens = node.children.map(n => tokenStore.getFirstToken(n))
  741. setOffset(childTokens, 1, startTagToken)
  742. }
  743. setOffset(endTagToken, 0, startTagToken)
  744. },
  745. VEndTag (node) {
  746. const openToken = tokenStore.getFirstToken(node)
  747. const closeToken = tokenStore.getLastToken(node)
  748. if (closeToken.type.endsWith('TagClose')) {
  749. setOffset(closeToken, options.closeBracket, openToken)
  750. }
  751. },
  752. VExpressionContainer (node) {
  753. if (node.expression != null && node.range[0] !== node.expression.range[0]) {
  754. const startQuoteToken = tokenStore.getFirstToken(node)
  755. const endQuoteToken = tokenStore.getLastToken(node)
  756. const childToken = tokenStore.getFirstToken(node.expression)
  757. setOffset(childToken, 1, startQuoteToken)
  758. setOffset(endQuoteToken, 0, startQuoteToken)
  759. }
  760. },
  761. VForExpression (node) {
  762. const firstToken = tokenStore.getFirstToken(node)
  763. const lastOfLeft = last(node.left) || firstToken
  764. const inToken = tokenStore.getTokenAfter(lastOfLeft, isNotRightParen)
  765. const rightToken = tokenStore.getFirstToken(node.right)
  766. if (isLeftParen(firstToken)) {
  767. const rightToken = tokenStore.getTokenAfter(lastOfLeft, isRightParen)
  768. processNodeList(node.left, firstToken, rightToken, 1)
  769. }
  770. setOffset(inToken, 1, firstToken)
  771. setOffset(rightToken, 1, inToken)
  772. },
  773. VOnExpression (node) {
  774. processNodeList(node.body, null, null, 0)
  775. },
  776. VStartTag (node) {
  777. const openToken = tokenStore.getFirstToken(node)
  778. const closeToken = tokenStore.getLastToken(node)
  779. processNodeList(
  780. node.attributes,
  781. openToken,
  782. null,
  783. options.attribute,
  784. options.alignAttributesVertically
  785. )
  786. if (closeToken != null && closeToken.type.endsWith('TagClose')) {
  787. setOffset(closeToken, options.closeBracket, openToken)
  788. }
  789. },
  790. VText (node) {
  791. const tokens = tokenStore.getTokens(node, isNotWhitespace)
  792. const firstTokenInfo = offsets.get(tokenStore.getFirstToken(node))
  793. for (const token of tokens) {
  794. offsets.set(token, firstTokenInfo)
  795. }
  796. },
  797. 'ArrayExpression, ArrayPattern' (node) {
  798. processNodeList(node.elements, tokenStore.getFirstToken(node), tokenStore.getLastToken(node), 1)
  799. },
  800. ArrowFunctionExpression (node) {
  801. const firstToken = tokenStore.getFirstToken(node)
  802. const secondToken = tokenStore.getTokenAfter(firstToken)
  803. const leftToken = node.async ? secondToken : firstToken
  804. const arrowToken = tokenStore.getTokenBefore(node.body, isArrow)
  805. if (node.async) {
  806. setOffset(secondToken, 1, firstToken)
  807. }
  808. if (isLeftParen(leftToken)) {
  809. const rightToken = tokenStore.getTokenAfter(last(node.params) || leftToken, isRightParen)
  810. processNodeList(node.params, leftToken, rightToken, 1)
  811. }
  812. setOffset(arrowToken, 1, firstToken)
  813. processMaybeBlock(node.body, firstToken)
  814. },
  815. 'AssignmentExpression, AssignmentPattern, BinaryExpression, LogicalExpression' (node) {
  816. const leftToken = getChainHeadToken(node)
  817. const opToken = tokenStore.getTokenAfter(node.left, isNotRightParen)
  818. const rightToken = tokenStore.getTokenAfter(opToken)
  819. const prevToken = tokenStore.getTokenBefore(leftToken)
  820. const shouldIndent = (
  821. prevToken == null ||
  822. prevToken.loc.end.line === leftToken.loc.start.line ||
  823. isBeginningOfElement(leftToken, node)
  824. )
  825. setOffset([opToken, rightToken], shouldIndent ? 1 : 0, leftToken)
  826. },
  827. 'AwaitExpression, RestElement, SpreadElement, UnaryExpression' (node) {
  828. const firstToken = tokenStore.getFirstToken(node)
  829. const nextToken = tokenStore.getTokenAfter(firstToken)
  830. setOffset(nextToken, 1, firstToken)
  831. },
  832. 'BlockStatement, ClassBody' (node) {
  833. processNodeList(node.body, tokenStore.getFirstToken(node), tokenStore.getLastToken(node), 1)
  834. },
  835. 'BreakStatement, ContinueStatement, ReturnStatement, ThrowStatement' (node) {
  836. if (node.argument != null || node.label != null) {
  837. const firstToken = tokenStore.getFirstToken(node)
  838. const nextToken = tokenStore.getTokenAfter(firstToken)
  839. setOffset(nextToken, 1, firstToken)
  840. }
  841. },
  842. CallExpression (node) {
  843. const firstToken = tokenStore.getFirstToken(node)
  844. const rightToken = tokenStore.getLastToken(node)
  845. const leftToken = tokenStore.getTokenAfter(node.callee, isLeftParen)
  846. setOffset(leftToken, 1, firstToken)
  847. processNodeList(node.arguments, leftToken, rightToken, 1)
  848. },
  849. CatchClause (node) {
  850. const firstToken = tokenStore.getFirstToken(node)
  851. const bodyToken = tokenStore.getFirstToken(node.body)
  852. if (node.param != null) {
  853. const leftToken = tokenStore.getTokenAfter(firstToken)
  854. const rightToken = tokenStore.getTokenAfter(node.param)
  855. setOffset(leftToken, 1, firstToken)
  856. processNodeList([node.param], leftToken, rightToken, 1)
  857. }
  858. setOffset(bodyToken, 0, firstToken)
  859. },
  860. 'ClassDeclaration, ClassExpression' (node) {
  861. const firstToken = tokenStore.getFirstToken(node)
  862. const bodyToken = tokenStore.getFirstToken(node.body)
  863. if (node.id != null) {
  864. setOffset(tokenStore.getFirstToken(node.id), 1, firstToken)
  865. }
  866. if (node.superClass != null) {
  867. const extendsToken = tokenStore.getTokenAfter(node.id || firstToken)
  868. const superClassToken = tokenStore.getTokenAfter(extendsToken)
  869. setOffset(extendsToken, 1, firstToken)
  870. setOffset(superClassToken, 1, extendsToken)
  871. }
  872. setOffset(bodyToken, 0, firstToken)
  873. },
  874. ConditionalExpression (node) {
  875. const firstToken = tokenStore.getFirstToken(node)
  876. const questionToken = tokenStore.getTokenAfter(node.test, isNotRightParen)
  877. const consequentToken = tokenStore.getTokenAfter(questionToken)
  878. const colonToken = tokenStore.getTokenAfter(node.consequent, isNotRightParen)
  879. const alternateToken = tokenStore.getTokenAfter(colonToken)
  880. const isFlat = (node.test.loc.end.line === node.consequent.loc.start.line)
  881. if (isFlat) {
  882. setOffset([questionToken, consequentToken, colonToken, alternateToken], 0, firstToken)
  883. } else {
  884. setOffset([questionToken, colonToken], 1, firstToken)
  885. setOffset([consequentToken, alternateToken], 1, questionToken)
  886. }
  887. },
  888. DoWhileStatement (node) {
  889. const doToken = tokenStore.getFirstToken(node)
  890. const whileToken = tokenStore.getTokenAfter(node.body, isNotRightParen)
  891. const leftToken = tokenStore.getTokenAfter(whileToken)
  892. const testToken = tokenStore.getTokenAfter(leftToken)
  893. const lastToken = tokenStore.getLastToken(node)
  894. const rightToken = isSemicolon(lastToken) ? tokenStore.getTokenBefore(lastToken) : lastToken
  895. processMaybeBlock(node.body, doToken)
  896. setOffset(whileToken, 0, doToken)
  897. setOffset(leftToken, 1, whileToken)
  898. setOffset(testToken, 1, leftToken)
  899. setOffset(rightToken, 0, leftToken)
  900. },
  901. ExportAllDeclaration (node) {
  902. const tokens = tokenStore.getTokens(node)
  903. const firstToken = tokens.shift()
  904. if (isSemicolon(last(tokens))) {
  905. tokens.pop()
  906. }
  907. setOffset(tokens, 1, firstToken)
  908. },
  909. ExportDefaultDeclaration (node) {
  910. const exportToken = tokenStore.getFirstToken(node)
  911. const defaultToken = tokenStore.getFirstToken(node, 1)
  912. const declarationToken = getFirstAndLastTokens(node.declaration).firstToken
  913. setOffset([defaultToken, declarationToken], 1, exportToken)
  914. },
  915. ExportNamedDeclaration (node) {
  916. const exportToken = tokenStore.getFirstToken(node)
  917. if (node.declaration) {
  918. // export var foo = 1;
  919. const declarationToken = tokenStore.getFirstToken(node, 1)
  920. setOffset(declarationToken, 1, exportToken)
  921. } else {
  922. // export {foo, bar}; or export {foo, bar} from "mod";
  923. const leftParenToken = tokenStore.getFirstToken(node, 1)
  924. const rightParenToken = tokenStore.getLastToken(node, isRightBrace)
  925. setOffset(leftParenToken, 0, exportToken)
  926. processNodeList(node.specifiers, leftParenToken, rightParenToken, 1)
  927. const maybeFromToken = tokenStore.getTokenAfter(rightParenToken)
  928. if (maybeFromToken != null && sourceCode.getText(maybeFromToken) === 'from') {
  929. const fromToken = maybeFromToken
  930. const nameToken = tokenStore.getTokenAfter(fromToken)
  931. setOffset([fromToken, nameToken], 1, exportToken)
  932. }
  933. }
  934. },
  935. ExportSpecifier (node) {
  936. const tokens = tokenStore.getTokens(node)
  937. const firstToken = tokens.shift()
  938. setOffset(tokens, 1, firstToken)
  939. },
  940. 'ForInStatement, ForOfStatement' (node) {
  941. const forToken = tokenStore.getFirstToken(node)
  942. const leftParenToken = tokenStore.getTokenAfter(forToken)
  943. const leftToken = tokenStore.getTokenAfter(leftParenToken)
  944. const inToken = tokenStore.getTokenAfter(leftToken, isNotRightParen)
  945. const rightToken = tokenStore.getTokenAfter(inToken)
  946. const rightParenToken = tokenStore.getTokenBefore(node.body, isNotLeftParen)
  947. setOffset(leftParenToken, 1, forToken)
  948. setOffset(leftToken, 1, leftParenToken)
  949. setOffset(inToken, 1, leftToken)
  950. setOffset(rightToken, 1, leftToken)
  951. setOffset(rightParenToken, 0, leftParenToken)
  952. processMaybeBlock(node.body, forToken)
  953. },
  954. ForStatement (node) {
  955. const forToken = tokenStore.getFirstToken(node)
  956. const leftParenToken = tokenStore.getTokenAfter(forToken)
  957. const rightParenToken = tokenStore.getTokenBefore(node.body, isNotLeftParen)
  958. setOffset(leftParenToken, 1, forToken)
  959. processNodeList([node.init, node.test, node.update], leftParenToken, rightParenToken, 1)
  960. setOffset(rightParenToken, 0, leftParenToken)
  961. processMaybeBlock(node.body, forToken)
  962. },
  963. 'FunctionDeclaration, FunctionExpression' (node) {
  964. const firstToken = tokenStore.getFirstToken(node)
  965. if (isLeftParen(firstToken)) {
  966. // Methods.
  967. const leftToken = firstToken
  968. const rightToken = tokenStore.getTokenAfter(last(node.params) || leftToken, isRightParen)
  969. const bodyToken = tokenStore.getFirstToken(node.body)
  970. processNodeList(node.params, leftToken, rightToken, 1)
  971. setOffset(bodyToken, 0, tokenStore.getFirstToken(node.parent))
  972. } else {
  973. // Normal functions.
  974. const functionToken = node.async ? tokenStore.getTokenAfter(firstToken) : firstToken
  975. const starToken = node.generator ? tokenStore.getTokenAfter(functionToken) : null
  976. const idToken = node.id && tokenStore.getFirstToken(node.id)
  977. const leftToken = tokenStore.getTokenAfter(idToken || starToken || functionToken)
  978. const rightToken = tokenStore.getTokenAfter(last(node.params) || leftToken, isRightParen)
  979. const bodyToken = tokenStore.getFirstToken(node.body)
  980. if (node.async) {
  981. setOffset(functionToken, 0, firstToken)
  982. }
  983. if (node.generator) {
  984. setOffset(starToken, 1, firstToken)
  985. }
  986. if (node.id != null) {
  987. setOffset(idToken, 1, firstToken)
  988. }
  989. setOffset(leftToken, 1, firstToken)
  990. processNodeList(node.params, leftToken, rightToken, 1)
  991. setOffset(bodyToken, 0, firstToken)
  992. }
  993. },
  994. IfStatement (node) {
  995. const ifToken = tokenStore.getFirstToken(node)
  996. const ifLeftParenToken = tokenStore.getTokenAfter(ifToken)
  997. const ifRightParenToken = tokenStore.getTokenBefore(node.consequent, isRightParen)
  998. setOffset(ifLeftParenToken, 1, ifToken)
  999. setOffset(ifRightParenToken, 0, ifLeftParenToken)
  1000. processMaybeBlock(node.consequent, ifToken)
  1001. if (node.alternate != null) {
  1002. const elseToken = tokenStore.getTokenAfter(node.consequent, isNotRightParen)
  1003. setOffset(elseToken, 0, ifToken)
  1004. processMaybeBlock(node.alternate, elseToken)
  1005. }
  1006. },
  1007. ImportDeclaration (node) {
  1008. const firstSpecifier = node.specifiers[0]
  1009. const secondSpecifier = node.specifiers[1]
  1010. const importToken = tokenStore.getFirstToken(node)
  1011. const hasSemi = tokenStore.getLastToken(node).value === ';'
  1012. const tokens = [] // tokens to one indent
  1013. if (!firstSpecifier) {
  1014. // There are 2 patterns:
  1015. // import "foo"
  1016. // import {} from "foo"
  1017. const secondToken = tokenStore.getFirstToken(node, 1)
  1018. if (isLeftBrace(secondToken)) {
  1019. setOffset(
  1020. [secondToken, tokenStore.getTokenAfter(secondToken)],
  1021. 0,
  1022. importToken
  1023. )
  1024. tokens.push(
  1025. tokenStore.getLastToken(node, hasSemi ? 2 : 1), // from
  1026. tokenStore.getLastToken(node, hasSemi ? 1 : 0) // "foo"
  1027. )
  1028. } else {
  1029. tokens.push(tokenStore.getLastToken(node, hasSemi ? 1 : 0))
  1030. }
  1031. } else if (firstSpecifier.type === 'ImportDefaultSpecifier') {
  1032. if (secondSpecifier && secondSpecifier.type === 'ImportNamespaceSpecifier') {
  1033. // There is a pattern:
  1034. // import Foo, * as foo from "foo"
  1035. tokens.push(
  1036. tokenStore.getFirstToken(firstSpecifier), // Foo
  1037. tokenStore.getTokenAfter(firstSpecifier), // comma
  1038. tokenStore.getFirstToken(secondSpecifier), // *
  1039. tokenStore.getLastToken(node, hasSemi ? 2 : 1), // from
  1040. tokenStore.getLastToken(node, hasSemi ? 1 : 0) // "foo"
  1041. )
  1042. } else {
  1043. // There are 3 patterns:
  1044. // import Foo from "foo"
  1045. // import Foo, {} from "foo"
  1046. // import Foo, {a} from "foo"
  1047. const idToken = tokenStore.getFirstToken(firstSpecifier)
  1048. const nextToken = tokenStore.getTokenAfter(firstSpecifier)
  1049. if (isComma(nextToken)) {
  1050. const leftBrace = tokenStore.getTokenAfter(nextToken)
  1051. const rightBrace = tokenStore.getLastToken(node, hasSemi ? 3 : 2)
  1052. setOffset([idToken, nextToken], 1, importToken)
  1053. setOffset(leftBrace, 0, idToken)
  1054. processNodeList(node.specifiers.slice(1), leftBrace, rightBrace, 1)
  1055. tokens.push(
  1056. tokenStore.getLastToken(node, hasSemi ? 2 : 1), // from
  1057. tokenStore.getLastToken(node, hasSemi ? 1 : 0) // "foo"
  1058. )
  1059. } else {
  1060. tokens.push(
  1061. idToken,
  1062. nextToken, // from
  1063. tokenStore.getTokenAfter(nextToken) // "foo"
  1064. )
  1065. }
  1066. }
  1067. } else if (firstSpecifier.type === 'ImportNamespaceSpecifier') {
  1068. // There is a pattern:
  1069. // import * as foo from "foo"
  1070. tokens.push(
  1071. tokenStore.getFirstToken(firstSpecifier), // *
  1072. tokenStore.getLastToken(node, hasSemi ? 2 : 1), // from
  1073. tokenStore.getLastToken(node, hasSemi ? 1 : 0) // "foo"
  1074. )
  1075. } else {
  1076. // There is a pattern:
  1077. // import {a} from "foo"
  1078. const leftBrace = tokenStore.getFirstToken(node, 1)
  1079. const rightBrace = tokenStore.getLastToken(node, hasSemi ? 3 : 2)
  1080. setOffset(leftBrace, 0, importToken)
  1081. processNodeList(node.specifiers, leftBrace, rightBrace, 1)
  1082. tokens.push(
  1083. tokenStore.getLastToken(node, hasSemi ? 2 : 1), // from
  1084. tokenStore.getLastToken(node, hasSemi ? 1 : 0) // "foo"
  1085. )
  1086. }
  1087. setOffset(tokens, 1, importToken)
  1088. },
  1089. ImportSpecifier (node) {
  1090. if (node.local.range[0] !== node.imported.range[0]) {
  1091. const tokens = tokenStore.getTokens(node)
  1092. const firstToken = tokens.shift()
  1093. setOffset(tokens, 1, firstToken)
  1094. }
  1095. },
  1096. ImportNamespaceSpecifier (node) {
  1097. const tokens = tokenStore.getTokens(node)
  1098. const firstToken = tokens.shift()
  1099. setOffset(tokens, 1, firstToken)
  1100. },
  1101. LabeledStatement (node) {
  1102. const labelToken = tokenStore.getFirstToken(node)
  1103. const colonToken = tokenStore.getTokenAfter(labelToken)
  1104. const bodyToken = tokenStore.getTokenAfter(colonToken)
  1105. setOffset([colonToken, bodyToken], 1, labelToken)
  1106. },
  1107. 'MemberExpression, MetaProperty' (node) {
  1108. const objectToken = tokenStore.getFirstToken(node)
  1109. if (node.computed) {
  1110. const leftBracketToken = tokenStore.getTokenBefore(node.property, isLeftBracket)
  1111. const propertyToken = tokenStore.getTokenAfter(leftBracketToken)
  1112. const rightBracketToken = tokenStore.getTokenAfter(node.property, isRightBracket)
  1113. setOffset(leftBracketToken, 1, objectToken)
  1114. setOffset(propertyToken, 1, leftBracketToken)
  1115. setOffset(rightBracketToken, 0, leftBracketToken)
  1116. } else {
  1117. const dotToken = tokenStore.getTokenBefore(node.property)
  1118. const propertyToken = tokenStore.getTokenAfter(dotToken)
  1119. setOffset([dotToken, propertyToken], 1, objectToken)
  1120. }
  1121. },
  1122. 'MethodDefinition, Property' (node) {
  1123. const isMethod = (node.type === 'MethodDefinition' || node.method === true)
  1124. const prefixTokens = getPrefixTokens(node)
  1125. const hasPrefix = prefixTokens.length >= 1
  1126. for (let i = 1; i < prefixTokens.length; ++i) {
  1127. setOffset(prefixTokens[i], 0, prefixTokens[i - 1])
  1128. }
  1129. let lastKeyToken = null
  1130. if (node.computed) {
  1131. const keyLeftToken = tokenStore.getFirstToken(node, isLeftBracket)
  1132. const keyToken = tokenStore.getTokenAfter(keyLeftToken)
  1133. const keyRightToken = lastKeyToken = tokenStore.getTokenAfter(node.key, isRightBracket)
  1134. if (hasPrefix) {
  1135. setOffset(keyLeftToken, 0, last(prefixTokens))
  1136. }
  1137. setOffset(keyToken, 1, keyLeftToken)
  1138. setOffset(keyRightToken, 0, keyLeftToken)
  1139. } else {
  1140. const idToken = lastKeyToken = tokenStore.getFirstToken(node.key)
  1141. if (hasPrefix) {
  1142. setOffset(idToken, 0, last(prefixTokens))
  1143. }
  1144. }
  1145. if (isMethod) {
  1146. const leftParenToken = tokenStore.getTokenAfter(lastKeyToken)
  1147. setOffset(leftParenToken, 1, lastKeyToken)
  1148. } else if (!node.shorthand) {
  1149. const colonToken = tokenStore.getTokenAfter(lastKeyToken)
  1150. const valueToken = tokenStore.getTokenAfter(colonToken)
  1151. setOffset([colonToken, valueToken], 1, lastKeyToken)
  1152. }
  1153. },
  1154. NewExpression (node) {
  1155. const newToken = tokenStore.getFirstToken(node)
  1156. const calleeToken = tokenStore.getTokenAfter(newToken)
  1157. const rightToken = tokenStore.getLastToken(node)
  1158. const leftToken = isRightParen(rightToken)
  1159. ? tokenStore.getFirstTokenBetween(node.callee, rightToken, isLeftParen)
  1160. : null
  1161. setOffset(calleeToken, 1, newToken)
  1162. if (leftToken != null) {
  1163. setOffset(leftToken, 1, calleeToken)
  1164. processNodeList(node.arguments, leftToken, rightToken, 1)
  1165. }
  1166. },
  1167. 'ObjectExpression, ObjectPattern' (node) {
  1168. processNodeList(node.properties, tokenStore.getFirstToken(node), tokenStore.getLastToken(node), 1)
  1169. },
  1170. SequenceExpression (node) {
  1171. processNodeList(node.expressions, null, null, 0)
  1172. },
  1173. SwitchCase (node) {
  1174. const caseToken = tokenStore.getFirstToken(node)
  1175. if (node.test != null) {
  1176. const testToken = tokenStore.getTokenAfter(caseToken)
  1177. const colonToken = tokenStore.getTokenAfter(node.test, isNotRightParen)
  1178. setOffset([testToken, colonToken], 1, caseToken)
  1179. } else {
  1180. const colonToken = tokenStore.getTokenAfter(caseToken)
  1181. setOffset(colonToken, 1, caseToken)
  1182. }
  1183. if (node.consequent.length === 1 && node.consequent[0].type === 'BlockStatement') {
  1184. setOffset(tokenStore.getFirstToken(node.consequent[0]), 0, caseToken)
  1185. } else if (node.consequent.length >= 1) {
  1186. setOffset(tokenStore.getFirstToken(node.consequent[0]), 1, caseToken)
  1187. processNodeList(node.consequent, null, null, 0)
  1188. }
  1189. },
  1190. SwitchStatement (node) {
  1191. const switchToken = tokenStore.getFirstToken(node)
  1192. const leftParenToken = tokenStore.getTokenAfter(switchToken)
  1193. const discriminantToken = tokenStore.getTokenAfter(leftParenToken)
  1194. const leftBraceToken = tokenStore.getTokenAfter(node.discriminant, isLeftBrace)
  1195. const rightParenToken = tokenStore.getTokenBefore(leftBraceToken)
  1196. const rightBraceToken = tokenStore.getLastToken(node)
  1197. setOffset(leftParenToken, 1, switchToken)
  1198. setOffset(discriminantToken, 1, leftParenToken)
  1199. setOffset(rightParenToken, 0, leftParenToken)
  1200. setOffset(leftBraceToken, 0, switchToken)
  1201. processNodeList(node.cases, leftBraceToken, rightBraceToken, options.switchCase)
  1202. },
  1203. TaggedTemplateExpression (node) {
  1204. const tagTokens = getFirstAndLastTokens(node.tag, node.range[0])
  1205. const quasiToken = tokenStore.getTokenAfter(tagTokens.lastToken)
  1206. setOffset(quasiToken, 1, tagTokens.firstToken)
  1207. },
  1208. TemplateLiteral (node) {
  1209. const firstToken = tokenStore.getFirstToken(node)
  1210. const quasiTokens = node.quasis.slice(1).map(n => tokenStore.getFirstToken(n))
  1211. const expressionToken = node.quasis.slice(0, -1).map(n => tokenStore.getTokenAfter(n))
  1212. setOffset(quasiTokens, 0, firstToken)
  1213. setOffset(expressionToken, 1, firstToken)
  1214. },
  1215. TryStatement (node) {
  1216. const tryToken = tokenStore.getFirstToken(node)
  1217. const tryBlockToken = tokenStore.getFirstToken(node.block)
  1218. setOffset(tryBlockToken, 0, tryToken)
  1219. if (node.handler != null) {
  1220. const catchToken = tokenStore.getFirstToken(node.handler)
  1221. setOffset(catchToken, 0, tryToken)
  1222. }
  1223. if (node.finalizer != null) {
  1224. const finallyToken = tokenStore.getTokenBefore(node.finalizer)
  1225. const finallyBlockToken = tokenStore.getFirstToken(node.finalizer)
  1226. setOffset([finallyToken, finallyBlockToken], 0, tryToken)
  1227. }
  1228. },
  1229. UpdateExpression (node) {
  1230. const firstToken = tokenStore.getFirstToken(node)
  1231. const nextToken = tokenStore.getTokenAfter(firstToken)
  1232. setOffset(nextToken, 1, firstToken)
  1233. },
  1234. VariableDeclaration (node) {
  1235. processNodeList(node.declarations, tokenStore.getFirstToken(node), null, 1)
  1236. },
  1237. VariableDeclarator (node) {
  1238. if (node.init != null) {
  1239. const idToken = tokenStore.getFirstToken(node)
  1240. const eqToken = tokenStore.getTokenAfter(node.id)
  1241. const initToken = tokenStore.getTokenAfter(eqToken)
  1242. setOffset([eqToken, initToken], 1, idToken)
  1243. }
  1244. },
  1245. 'WhileStatement, WithStatement' (node) {
  1246. const firstToken = tokenStore.getFirstToken(node)
  1247. const leftParenToken = tokenStore.getTokenAfter(firstToken)
  1248. const rightParenToken = tokenStore.getTokenBefore(node.body, isRightParen)
  1249. setOffset(leftParenToken, 1, firstToken)
  1250. setOffset(rightParenToken, 0, leftParenToken)
  1251. processMaybeBlock(node.body, firstToken)
  1252. },
  1253. YieldExpression (node) {
  1254. if (node.argument != null) {
  1255. const yieldToken = tokenStore.getFirstToken(node)
  1256. setOffset(tokenStore.getTokenAfter(yieldToken), 1, yieldToken)
  1257. if (node.delegate) {
  1258. setOffset(tokenStore.getTokenAfter(yieldToken, 1), 1, yieldToken)
  1259. }
  1260. }
  1261. },
  1262. // Process semicolons.
  1263. ':statement' (node) {
  1264. const firstToken = tokenStore.getFirstToken(node)
  1265. const lastToken = tokenStore.getLastToken(node)
  1266. if (isSemicolon(lastToken) && firstToken !== lastToken) {
  1267. setOffset(lastToken, 0, firstToken)
  1268. }
  1269. // Set to the semicolon of the previous token for semicolon-free style.
  1270. // E.g.,
  1271. // foo
  1272. // ;[1,2,3].forEach(f)
  1273. const info = offsets.get(firstToken)
  1274. const prevToken = tokenStore.getTokenBefore(firstToken)
  1275. if (info != null && isSemicolon(prevToken) && prevToken.loc.end.line === firstToken.loc.start.line) {
  1276. offsets.set(prevToken, info)
  1277. }
  1278. },
  1279. // Process parentheses.
  1280. // `:expression` does not match with MetaProperty and TemplateLiteral as a bug: https://github.com/estools/esquery/pull/59
  1281. ':expression, MetaProperty, TemplateLiteral' (node) {
  1282. let leftToken = tokenStore.getTokenBefore(node)
  1283. let rightToken = tokenStore.getTokenAfter(node)
  1284. let firstToken = tokenStore.getFirstToken(node)
  1285. while (isLeftParen(leftToken) && isRightParen(rightToken)) {
  1286. setOffset(firstToken, 1, leftToken)
  1287. setOffset(rightToken, 0, leftToken)
  1288. firstToken = leftToken
  1289. leftToken = tokenStore.getTokenBefore(leftToken)
  1290. rightToken = tokenStore.getTokenAfter(rightToken)
  1291. }
  1292. },
  1293. // Ignore tokens of unknown nodes.
  1294. '*:exit' (node) {
  1295. if (!KNOWN_NODES.has(node.type)) {
  1296. ignore(node)
  1297. }
  1298. },
  1299. // Top-level process.
  1300. Program (node) {
  1301. const firstToken = node.tokens[0]
  1302. const isScriptTag = (
  1303. firstToken != null &&
  1304. firstToken.type === 'Punctuator' &&
  1305. firstToken.value === '<script>'
  1306. )
  1307. const baseIndent =
  1308. isScriptTag ? (options.indentSize * options.baseIndent) : 0
  1309. for (const statement of node.body) {
  1310. processTopLevelNode(statement, baseIndent)
  1311. }
  1312. },
  1313. "VElement[parent.type!='VElement']" (node) {
  1314. processTopLevelNode(node, 0)
  1315. },
  1316. // Do validation.
  1317. ":matches(Program, VElement[parent.type!='VElement']):exit" (node) {
  1318. let comments = []
  1319. let tokensOnSameLine = []
  1320. let isBesideMultilineToken = false
  1321. let lastValidatedToken = null
  1322. // Validate indentation of tokens.
  1323. for (const token of tokenStore.getTokens(node, { includeComments: true, filter: isNotWhitespace })) {
  1324. if (tokensOnSameLine.length === 0 || tokensOnSameLine[0].loc.start.line === token.loc.start.line) {
  1325. // This is on the same line (or the first token).
  1326. tokensOnSameLine.push(token)
  1327. } else if (tokensOnSameLine.every(isComment)) {
  1328. // New line is detected, but the all tokens of the previous line are comment.
  1329. // Comment lines are adjusted to the next code line.
  1330. comments.push(tokensOnSameLine[0])
  1331. isBesideMultilineToken = last(tokensOnSameLine).loc.end.line === token.loc.start.line
  1332. tokensOnSameLine = [token]
  1333. } else {
  1334. // New line is detected, so validate the tokens.
  1335. if (!isBesideMultilineToken) {
  1336. validate(tokensOnSameLine, comments, lastValidatedToken)
  1337. lastValidatedToken = tokensOnSameLine[0]
  1338. }
  1339. isBesideMultilineToken = last(tokensOnSameLine).loc.end.line === token.loc.start.line
  1340. tokensOnSameLine = [token]
  1341. comments = []
  1342. }
  1343. }
  1344. if (tokensOnSameLine.length >= 1 && tokensOnSameLine.some(isNotComment)) {
  1345. validate(tokensOnSameLine, comments, lastValidatedToken)
  1346. }
  1347. }
  1348. })
  1349. }