|
| 1 | +/** |
| 2 | + * @author Yosuke Ota |
| 3 | + * See LICENSE file in root directory for full license. |
| 4 | + */ |
| 5 | +'use strict' |
| 6 | + |
| 7 | +// ------------------------------------------------------------------------------ |
| 8 | +// Requirements |
| 9 | +// ------------------------------------------------------------------------------ |
| 10 | + |
| 11 | +const utils = require('../utils') |
| 12 | + |
| 13 | +// ------------------------------------------------------------------------------ |
| 14 | +// Helpers |
| 15 | +// ------------------------------------------------------------------------------ |
| 16 | + |
| 17 | +function isSinglelineElement (element) { |
| 18 | + return element.loc.start.line === element.endTag.loc.start.line |
| 19 | +} |
| 20 | + |
| 21 | +function parseOptions (options) { |
| 22 | + return Object.assign({ |
| 23 | + 'ignores': ['pre', 'textarea'], |
| 24 | + 'ignoreWhenNoAttributes': true |
| 25 | + }, options) |
| 26 | +} |
| 27 | + |
| 28 | +/** |
| 29 | + * Check whether the given element is empty or not. |
| 30 | + * This ignores whitespaces, doesn't ignore comments. |
| 31 | + * @param {VElement} node The element node to check. |
| 32 | + * @param {SourceCode} sourceCode The source code object of the current context. |
| 33 | + * @returns {boolean} `true` if the element is empty. |
| 34 | + */ |
| 35 | +function isEmpty (node, sourceCode) { |
| 36 | + const start = node.startTag.range[1] |
| 37 | + const end = node.endTag.range[0] |
| 38 | + return sourceCode.text.slice(start, end).trim() === '' |
| 39 | +} |
| 40 | + |
| 41 | +// ------------------------------------------------------------------------------ |
| 42 | +// Rule Definition |
| 43 | +// ------------------------------------------------------------------------------ |
| 44 | + |
| 45 | +module.exports = { |
| 46 | + meta: { |
| 47 | + docs: { |
| 48 | + description: 'require a line break before and after the contents of a singleline element', |
| 49 | + category: undefined, |
| 50 | + url: 'https://github.com/vuejs/eslint-plugin-vue/blob/v5.0.0-beta.2/docs/rules/singleline-html-element-content-newline.md' |
| 51 | + }, |
| 52 | + fixable: 'whitespace', |
| 53 | + schema: [{ |
| 54 | + type: 'object', |
| 55 | + properties: { |
| 56 | + 'ignoreWhenNoAttributes': { |
| 57 | + type: 'boolean' |
| 58 | + }, |
| 59 | + 'ignores': { |
| 60 | + type: 'array', |
| 61 | + items: { type: 'string' }, |
| 62 | + uniqueItems: true, |
| 63 | + additionalItems: false |
| 64 | + } |
| 65 | + }, |
| 66 | + additionalProperties: false |
| 67 | + }], |
| 68 | + messages: { |
| 69 | + unexpectedAfterClosingBracket: 'Expected 1 line break after opening tag (`<{{name}}>`), but no line breaks found.', |
| 70 | + unexpectedBeforeOpeningBracket: 'Expected 1 line break before closing tag (`</{{name}}>`), but no line breaks found.' |
| 71 | + } |
| 72 | + }, |
| 73 | + |
| 74 | + create (context) { |
| 75 | + const options = parseOptions(context.options[0]) |
| 76 | + const ignores = options.ignores |
| 77 | + const ignoreWhenNoAttributes = options.ignoreWhenNoAttributes |
| 78 | + const template = context.parserServices.getTemplateBodyTokenStore && context.parserServices.getTemplateBodyTokenStore() |
| 79 | + const sourceCode = context.getSourceCode() |
| 80 | + |
| 81 | + let inIgnoreElement |
| 82 | + |
| 83 | + return utils.defineTemplateBodyVisitor(context, { |
| 84 | + 'VElement' (node) { |
| 85 | + if (inIgnoreElement) { |
| 86 | + return |
| 87 | + } |
| 88 | + if (ignores.indexOf(node.name) >= 0) { |
| 89 | + // ignore element name |
| 90 | + inIgnoreElement = node |
| 91 | + return |
| 92 | + } |
| 93 | + if (node.startTag.selfClosing || !node.endTag) { |
| 94 | + // self closing |
| 95 | + return |
| 96 | + } |
| 97 | + |
| 98 | + if (!isSinglelineElement(node)) { |
| 99 | + return |
| 100 | + } |
| 101 | + if (ignoreWhenNoAttributes && node.startTag.attributes.length === 0) { |
| 102 | + return |
| 103 | + } |
| 104 | + |
| 105 | + const getTokenOption = { includeComments: true, filter: (token) => token.type !== 'HTMLWhitespace' } |
| 106 | + const contentFirst = template.getTokenAfter(node.startTag, getTokenOption) |
| 107 | + const contentLast = template.getTokenBefore(node.endTag, getTokenOption) |
| 108 | + |
| 109 | + context.report({ |
| 110 | + node: template.getLastToken(node.startTag), |
| 111 | + loc: { |
| 112 | + start: node.startTag.loc.end, |
| 113 | + end: contentFirst.loc.start |
| 114 | + }, |
| 115 | + messageId: 'unexpectedAfterClosingBracket', |
| 116 | + data: { |
| 117 | + name: node.name |
| 118 | + }, |
| 119 | + fix (fixer) { |
| 120 | + const range = [node.startTag.range[1], contentFirst.range[0]] |
| 121 | + return fixer.replaceTextRange(range, '\n') |
| 122 | + } |
| 123 | + }) |
| 124 | + |
| 125 | + if (isEmpty(node, sourceCode)) { |
| 126 | + return |
| 127 | + } |
| 128 | + |
| 129 | + context.report({ |
| 130 | + node: template.getFirstToken(node.endTag), |
| 131 | + loc: { |
| 132 | + start: contentLast.loc.end, |
| 133 | + end: node.endTag.loc.start |
| 134 | + }, |
| 135 | + messageId: 'unexpectedBeforeOpeningBracket', |
| 136 | + data: { |
| 137 | + name: node.name |
| 138 | + }, |
| 139 | + fix (fixer) { |
| 140 | + const range = [contentLast.range[1], node.endTag.range[0]] |
| 141 | + return fixer.replaceTextRange(range, '\n') |
| 142 | + } |
| 143 | + }) |
| 144 | + }, |
| 145 | + 'VElement:exit' (node) { |
| 146 | + if (inIgnoreElement === node) { |
| 147 | + inIgnoreElement = null |
| 148 | + } |
| 149 | + } |
| 150 | + }) |
| 151 | + } |
| 152 | +} |
0 commit comments