You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

108 lines
3.0 KiB

/**
* @fileoverview This rule warns about the usage of extra whitespaces between attributes
* @author Armano
*/
'use strict'
const path = require('path')
/**
* @param {RuleContext} context
* @param {Token} node
*/
const isProperty = (context, node) => {
const sourceCode = context.getSourceCode()
return node.type === 'Punctuator' && sourceCode.getText(node) === ':'
}
module.exports = {
meta: {
type: 'layout',
docs: {
description: 'disallow multiple spaces',
categories: ['vue3-strongly-recommended', 'vue2-strongly-recommended'],
url: 'https://eslint.vuejs.org/rules/no-multi-spaces.html'
},
fixable: 'whitespace',
schema: [
{
type: 'object',
properties: {
ignoreProperties: {
type: 'boolean'
}
},
additionalProperties: false
}
],
messages: {
multipleSpaces: "Multiple spaces found before '{{displayValue}}'.",
useLatestParser:
'Use the latest vue-eslint-parser. See also https://eslint.vuejs.org/user-guide/#what-is-the-use-the-latest-vue-eslint-parser-error.'
}
},
/**
* @param {RuleContext} context - The rule context.
* @returns {RuleListener} AST event handlers.
*/
create(context) {
const options = context.options[0] || {}
const ignoreProperties = options.ignoreProperties === true
return {
Program(node) {
const sourceCode = context.getSourceCode()
if (sourceCode.parserServices.getTemplateBodyTokenStore == null) {
const filename = context.getFilename()
if (path.extname(filename) === '.vue') {
context.report({
loc: { line: 1, column: 0 },
messageId: 'useLatestParser'
})
}
return
}
if (!node.templateBody) {
return
}
const tokenStore = sourceCode.parserServices.getTemplateBodyTokenStore()
const tokens = tokenStore.getTokens(node.templateBody, {
includeComments: true
})
let prevToken = /** @type {Token} */ (tokens.shift())
for (const token of tokens) {
const spaces = token.range[0] - prevToken.range[1]
const shouldIgnore =
ignoreProperties &&
(isProperty(context, token) || isProperty(context, prevToken))
if (
spaces > 1 &&
token.loc.start.line === prevToken.loc.start.line &&
!shouldIgnore
) {
context.report({
node: token,
loc: {
start: prevToken.loc.end,
end: token.loc.start
},
messageId: 'multipleSpaces',
fix: (fixer) =>
fixer.replaceTextRange(
[prevToken.range[1], token.range[0]],
' '
),
data: {
displayValue: sourceCode.getText(token)
}
})
}
prevToken = token
}
}
}
}
}