192 lines
5.4 KiB
JavaScript
192 lines
5.4 KiB
JavaScript
|
/**
|
||
|
* @fileoverview Define the number of attributes allows per line
|
||
|
* @author Filipa Lacerda
|
||
|
*/
|
||
|
'use strict'
|
||
|
|
||
|
// ------------------------------------------------------------------------------
|
||
|
// Rule Definition
|
||
|
// ------------------------------------------------------------------------------
|
||
|
const utils = require('../utils')
|
||
|
|
||
|
module.exports = {
|
||
|
meta: {
|
||
|
type: 'layout',
|
||
|
docs: {
|
||
|
description: 'enforce the maximum number of attributes per line',
|
||
|
category: 'strongly-recommended',
|
||
|
url: 'https://eslint.vuejs.org/rules/max-attributes-per-line.html'
|
||
|
},
|
||
|
fixable: 'whitespace', // or "code" or "whitespace"
|
||
|
schema: [
|
||
|
{
|
||
|
type: 'object',
|
||
|
properties: {
|
||
|
singleline: {
|
||
|
anyOf: [
|
||
|
{
|
||
|
type: 'number',
|
||
|
minimum: 1
|
||
|
},
|
||
|
{
|
||
|
type: 'object',
|
||
|
properties: {
|
||
|
max: {
|
||
|
type: 'number',
|
||
|
minimum: 1
|
||
|
}
|
||
|
},
|
||
|
additionalProperties: false
|
||
|
}
|
||
|
]
|
||
|
},
|
||
|
multiline: {
|
||
|
anyOf: [
|
||
|
{
|
||
|
type: 'number',
|
||
|
minimum: 1
|
||
|
},
|
||
|
{
|
||
|
type: 'object',
|
||
|
properties: {
|
||
|
max: {
|
||
|
type: 'number',
|
||
|
minimum: 1
|
||
|
},
|
||
|
allowFirstLine: {
|
||
|
type: 'boolean'
|
||
|
}
|
||
|
},
|
||
|
additionalProperties: false
|
||
|
}
|
||
|
]
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
]
|
||
|
},
|
||
|
|
||
|
create: function (context) {
|
||
|
const configuration = parseOptions(context.options[0])
|
||
|
const multilineMaximum = configuration.multiline
|
||
|
const singlelinemMaximum = configuration.singleline
|
||
|
const canHaveFirstLine = configuration.allowFirstLine
|
||
|
const template = context.parserServices.getTemplateBodyTokenStore && context.parserServices.getTemplateBodyTokenStore()
|
||
|
|
||
|
return utils.defineTemplateBodyVisitor(context, {
|
||
|
'VStartTag' (node) {
|
||
|
const numberOfAttributes = node.attributes.length
|
||
|
|
||
|
if (!numberOfAttributes) return
|
||
|
|
||
|
if (utils.isSingleLine(node) && numberOfAttributes > singlelinemMaximum) {
|
||
|
showErrors(node.attributes.slice(singlelinemMaximum))
|
||
|
}
|
||
|
|
||
|
if (!utils.isSingleLine(node)) {
|
||
|
if (!canHaveFirstLine && node.attributes[0].loc.start.line === node.loc.start.line) {
|
||
|
showErrors([node.attributes[0]])
|
||
|
}
|
||
|
|
||
|
groupAttrsByLine(node.attributes)
|
||
|
.filter(attrs => attrs.length > multilineMaximum)
|
||
|
.forEach(attrs => showErrors(attrs.splice(multilineMaximum)))
|
||
|
}
|
||
|
}
|
||
|
})
|
||
|
|
||
|
// ----------------------------------------------------------------------
|
||
|
// Helpers
|
||
|
// ----------------------------------------------------------------------
|
||
|
function parseOptions (options) {
|
||
|
const defaults = {
|
||
|
singleline: 1,
|
||
|
multiline: 1,
|
||
|
allowFirstLine: false
|
||
|
}
|
||
|
|
||
|
if (options) {
|
||
|
if (typeof options.singleline === 'number') {
|
||
|
defaults.singleline = options.singleline
|
||
|
} else if (options.singleline && options.singleline.max) {
|
||
|
defaults.singleline = options.singleline.max
|
||
|
}
|
||
|
|
||
|
if (options.multiline) {
|
||
|
if (typeof options.multiline === 'number') {
|
||
|
defaults.multiline = options.multiline
|
||
|
} else if (typeof options.multiline === 'object') {
|
||
|
if (options.multiline.max) {
|
||
|
defaults.multiline = options.multiline.max
|
||
|
}
|
||
|
|
||
|
if (options.multiline.allowFirstLine) {
|
||
|
defaults.allowFirstLine = options.multiline.allowFirstLine
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
|
||
|
return defaults
|
||
|
}
|
||
|
|
||
|
function getPropData (prop) {
|
||
|
let propType = 'Attribute'
|
||
|
let propName = prop.key.name
|
||
|
|
||
|
if (utils.isBindingAttribute(prop)) {
|
||
|
propType = 'Binding'
|
||
|
propName = prop.key.raw.argument
|
||
|
} else if (utils.isEventAttribute(prop)) {
|
||
|
propType = 'Event'
|
||
|
propName = prop.key.raw.argument
|
||
|
} else if (prop.directive) {
|
||
|
propType = 'Directive'
|
||
|
}
|
||
|
|
||
|
return { propType, propName }
|
||
|
}
|
||
|
|
||
|
function showErrors (attributes) {
|
||
|
attributes.forEach((prop, i) => {
|
||
|
const fix = (fixer) => {
|
||
|
if (i !== 0) return null
|
||
|
|
||
|
// Find the closest token before the current prop
|
||
|
// that is not a white space
|
||
|
const prevToken = template.getTokenBefore(prop, {
|
||
|
filter: (token) => token.type !== 'HTMLWhitespace'
|
||
|
})
|
||
|
|
||
|
const range = [prevToken.range[1], prop.range[0]]
|
||
|
|
||
|
return fixer.replaceTextRange(range, '\n')
|
||
|
}
|
||
|
|
||
|
context.report({
|
||
|
node: prop,
|
||
|
loc: prop.loc,
|
||
|
message: '{{propType}} "{{propName}}" should be on a new line.',
|
||
|
data: getPropData(prop),
|
||
|
fix
|
||
|
})
|
||
|
})
|
||
|
}
|
||
|
|
||
|
function groupAttrsByLine (attributes) {
|
||
|
const propsPerLine = [[attributes[0]]]
|
||
|
|
||
|
attributes.reduce((previous, current) => {
|
||
|
if (previous.loc.end.line === current.loc.start.line) {
|
||
|
propsPerLine[propsPerLine.length - 1].push(current)
|
||
|
} else {
|
||
|
propsPerLine.push([current])
|
||
|
}
|
||
|
return current
|
||
|
})
|
||
|
|
||
|
return propsPerLine
|
||
|
}
|
||
|
}
|
||
|
}
|