|
| 1 | +/** |
| 2 | + * @fileoverview Require or disallow padding lines between blocks |
| 3 | + * @author Yosuke Ota |
| 4 | + */ |
| 5 | +'use strict' |
| 6 | +const utils = require('../utils') |
| 7 | + |
| 8 | +/** |
| 9 | + * Split the source code into multiple lines based on the line delimiters. |
| 10 | + * @param {string} text Source code as a string. |
| 11 | + * @returns {string[]} Array of source code lines. |
| 12 | + */ |
| 13 | +function splitLines (text) { |
| 14 | + return text.split(/\r\n|[\r\n\u2028\u2029]/gu) |
| 15 | +} |
| 16 | + |
| 17 | +/** |
| 18 | + * Check and report blocks for `never` configuration. |
| 19 | + * This autofix removes blank lines between the given 2 blocks. |
| 20 | + * @param {RuleContext} context The rule context to report. |
| 21 | + * @param {VElement} prevBlock The previous block to check. |
| 22 | + * @param {VElement} nextBlock The next block to check. |
| 23 | + * @param {Token[]} betweenTokens The array of tokens between blocks. |
| 24 | + * @returns {void} |
| 25 | + * @private |
| 26 | + */ |
| 27 | +function verifyForNever (context, prevBlock, nextBlock, betweenTokens) { |
| 28 | + if (prevBlock.loc.end.line === nextBlock.loc.start.line) { |
| 29 | + // same line |
| 30 | + return |
| 31 | + } |
| 32 | + const tokenOrNodes = [...betweenTokens, nextBlock] |
| 33 | + let prev = prevBlock |
| 34 | + const paddingLines = [] |
| 35 | + for (const tokenOrNode of tokenOrNodes) { |
| 36 | + const numOfLineBreaks = tokenOrNode.loc.start.line - prev.loc.end.line |
| 37 | + if (numOfLineBreaks > 1) { |
| 38 | + paddingLines.push([prev, tokenOrNode]) |
| 39 | + } |
| 40 | + prev = tokenOrNode |
| 41 | + } |
| 42 | + if (!paddingLines.length) { |
| 43 | + return |
| 44 | + } |
| 45 | + |
| 46 | + context.report({ |
| 47 | + node: nextBlock, |
| 48 | + messageId: 'never', |
| 49 | + fix (fixer) { |
| 50 | + return paddingLines.map(([prevToken, nextToken]) => { |
| 51 | + const start = prevToken.range[1] |
| 52 | + const end = nextToken.range[0] |
| 53 | + const paddingText = context.getSourceCode().text |
| 54 | + .slice(start, end) |
| 55 | + const lastSpaces = splitLines(paddingText).pop() |
| 56 | + return fixer.replaceTextRange([start, end], '\n' + lastSpaces) |
| 57 | + }) |
| 58 | + } |
| 59 | + }) |
| 60 | +} |
| 61 | + |
| 62 | +/** |
| 63 | + * Check and report blocks for `always` configuration. |
| 64 | + * This autofix inserts a blank line between the given 2 blocks. |
| 65 | + * @param {RuleContext} context The rule context to report. |
| 66 | + * @param {VElement} prevBlock The previous block to check. |
| 67 | + * @param {VElement} nextBlock The next block to check. |
| 68 | + * @param {Token[]} betweenTokens The array of tokens between blocks. |
| 69 | + * @returns {void} |
| 70 | + * @private |
| 71 | + */ |
| 72 | +function verifyForAlways (context, prevBlock, nextBlock, betweenTokens) { |
| 73 | + const tokenOrNodes = [...betweenTokens, nextBlock] |
| 74 | + let prev = prevBlock |
| 75 | + let linebreak |
| 76 | + for (const tokenOrNode of tokenOrNodes) { |
| 77 | + const numOfLineBreaks = tokenOrNode.loc.start.line - prev.loc.end.line |
| 78 | + if (numOfLineBreaks > 1) { |
| 79 | + // Already padded. |
| 80 | + return |
| 81 | + } |
| 82 | + if (!linebreak && numOfLineBreaks > 0) { |
| 83 | + linebreak = prev |
| 84 | + } |
| 85 | + prev = tokenOrNode |
| 86 | + } |
| 87 | + |
| 88 | + context.report({ |
| 89 | + node: nextBlock, |
| 90 | + messageId: 'always', |
| 91 | + fix (fixer) { |
| 92 | + if (linebreak) { |
| 93 | + return fixer.insertTextAfter(linebreak, '\n') |
| 94 | + } |
| 95 | + return fixer.insertTextAfter(prevBlock, '\n\n') |
| 96 | + } |
| 97 | + }) |
| 98 | +} |
| 99 | + |
| 100 | +/** |
| 101 | + * Types of blank lines. |
| 102 | + * `never` and `always` are defined. |
| 103 | + * Those have `verify` method to check and report statements. |
| 104 | + * @private |
| 105 | + */ |
| 106 | +const PaddingTypes = { |
| 107 | + never: { verify: verifyForNever }, |
| 108 | + always: { verify: verifyForAlways } |
| 109 | +} |
| 110 | + |
| 111 | +// ------------------------------------------------------------------------------ |
| 112 | +// Rule Definition |
| 113 | +// ------------------------------------------------------------------------------ |
| 114 | + |
| 115 | +module.exports = { |
| 116 | + meta: { |
| 117 | + type: 'layout', |
| 118 | + docs: { |
| 119 | + description: 'require or disallow padding lines between blocks', |
| 120 | + category: undefined, |
| 121 | + url: 'https://eslint.vuejs.org/rules/padding-line-between-blocks.html' |
| 122 | + }, |
| 123 | + fixable: 'whitespace', |
| 124 | + schema: [ |
| 125 | + { |
| 126 | + enum: Object.keys(PaddingTypes) |
| 127 | + } |
| 128 | + ], |
| 129 | + messages: { |
| 130 | + never: 'Unexpected blank line before this block.', |
| 131 | + always: 'Expected blank line before this block.' |
| 132 | + } |
| 133 | + }, |
| 134 | + create (context) { |
| 135 | + const paddingType = PaddingTypes[context.options[0] || 'always'] |
| 136 | + const documentFragment = context.parserServices.getDocumentFragment && context.parserServices.getDocumentFragment() |
| 137 | + |
| 138 | + let tokens |
| 139 | + function getTopLevelHTMLElements () { |
| 140 | + if (documentFragment) { |
| 141 | + return documentFragment.children.filter(e => e.type === 'VElement') |
| 142 | + } |
| 143 | + return [] |
| 144 | + } |
| 145 | + |
| 146 | + function getTokenAndCommentsBetween (prev, next) { |
| 147 | + // When there is no <template>, tokenStore.getTokensBetween cannot be used. |
| 148 | + if (!tokens) { |
| 149 | + tokens = [ |
| 150 | + ...documentFragment.tokens |
| 151 | + .filter(token => token.type !== 'HTMLWhitespace'), |
| 152 | + ...documentFragment.comments |
| 153 | + ].sort((a, b) => a.range[0] > b.range[0] ? 1 : a.range[0] < b.range[0] ? -1 : 0) |
| 154 | + } |
| 155 | + |
| 156 | + let token = tokens.shift() |
| 157 | + |
| 158 | + const results = [] |
| 159 | + while (token) { |
| 160 | + if (prev.range[1] <= token.range[0]) { |
| 161 | + if (next.range[0] <= token.range[0]) { |
| 162 | + tokens.unshift(token) |
| 163 | + break |
| 164 | + } else { |
| 165 | + results.push(token) |
| 166 | + } |
| 167 | + } |
| 168 | + token = tokens.shift() |
| 169 | + } |
| 170 | + |
| 171 | + return results |
| 172 | + } |
| 173 | + |
| 174 | + return utils.defineTemplateBodyVisitor( |
| 175 | + context, |
| 176 | + {}, |
| 177 | + { |
| 178 | + Program (node) { |
| 179 | + if (utils.hasInvalidEOF(node)) { |
| 180 | + return |
| 181 | + } |
| 182 | + const elements = [...getTopLevelHTMLElements()] |
| 183 | + |
| 184 | + let prev = elements.shift() |
| 185 | + for (const element of elements) { |
| 186 | + const betweenTokens = getTokenAndCommentsBetween(prev, element) |
| 187 | + paddingType.verify(context, prev, element, betweenTokens) |
| 188 | + prev = element |
| 189 | + } |
| 190 | + } |
| 191 | + } |
| 192 | + ) |
| 193 | + } |
| 194 | +} |
0 commit comments