Skip to content

Add same order support on multiple types of attributes. #471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 30, 2018
Merged

Add same order support on multiple types of attributes. #471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/rules/attributes-order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,16 @@ Specify custom order of attribute groups
:+1: Examples of **correct** code with custom order`:

```html
<!-- 'vue/attributes-order': [2, { order: ['LIST_RENDERING', 'CONDITIONALS', 'RENDER_MODIFIERS', 'GLOBAL', 'UNIQUE', 'TWO_WAY_BINDING', 'OTHER_DIRECTIVES', 'OTHER_ATTR', 'EVENTS', 'CONTENT', 'DEFINITION'] }] -->
<!-- 'vue/attributes-order': [2, { order: ['DEFINITION', 'LIST_RENDERING', 'CONDITIONALS', 'RENDER_MODIFIERS', 'GLOBAL', 'UNIQUE', ['BINDING', 'OTHER_ATTR'], 'EVENTS', 'CONTENT'] }] -->
<div
is="header"
prop-one="prop"
:prop-two="prop">
</div>
```

```html
<!-- 'vue/attributes-order': [2, { order: ['LIST_RENDERING', 'CONDITIONALS', 'RENDER_MODIFIERS', 'GLOBAL', 'UNIQUE', 'BINDING', 'OTHER_ATTR', 'EVENTS', 'CONTENT', 'DEFINITION'] }] -->
<div
prop-one="prop"
prop-two="prop"
Expand Down
25 changes: 15 additions & 10 deletions lib/rules/attributes-order.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,11 @@ function getAttributeType (name, isDirective) {
}
}
}
function getPosition (attribute, attributeOrder) {
let attributeType
if (attribute.directive && attribute.key.name === 'bind') {
attributeType = getAttributeType(attribute.key.argument, false)
} else {
attributeType = getAttributeType(attribute.key.name, attribute.directive)
}
return attributeOrder.indexOf(attributeType)
function getPosition (attribute, attributePosition) {
const attributeType = attribute.directive && attribute.key.name === 'bind'
? getAttributeType(attribute.key.argument, false)
: getAttributeType(attribute.key.name, attribute.directive)
return attributePosition.hasOwnProperty(attributeType) ? attributePosition[attributeType] : -1
}

function create (context) {
Expand All @@ -54,6 +51,14 @@ function create (context) {
if (context.options[0] && context.options[0].order) {
attributeOrder = context.options[0].order
}
const attributePosition = {}
attributeOrder.forEach((item, i) => {
if (item instanceof Array) {
item.forEach((attr) => {
attributePosition[attr] = i
})
} else attributePosition[item] = i
})
let currentPosition
let previousNode

Expand Down Expand Up @@ -101,8 +106,8 @@ function create (context) {
previousNode = null
},
'VAttribute' (node) {
if ((currentPosition === -1) || (currentPosition <= getPosition(node, attributeOrder))) {
currentPosition = getPosition(node, attributeOrder)
if ((currentPosition === -1) || (currentPosition <= getPosition(node, attributePosition))) {
currentPosition = getPosition(node, attributePosition)
previousNode = node
} else {
reportIssue(node, previousNode)
Expand Down
69 changes: 69 additions & 0 deletions tests/lib/rules/attributes-order.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,33 @@ tester.run('attributes-order', rule, {
'OTHER_DIRECTIVES'
]
}]
},
{
filename: 'test.vue',
code:
`<template>
<div
v-if="!visible"
class="content"
:class="className"
v-text="textContent"
>
</div>
</template>`,
options: [
{ order:
[
'CONDITIONALS',
'LIST_RENDERING',
'RENDER_MODIFIERS',
'DEFINITION',
'EVENTS',
'UNIQUE',
['BINDING', 'OTHER_ATTR'],
'CONTENT',
'GLOBAL'
]
}]
}
],

Expand Down Expand Up @@ -515,6 +542,48 @@ tester.run('attributes-order', rule, {
nodeType: 'VIdentifier'
}
]
},
{
code:
`<template>
<div
class="content"
v-if="!visible"
:class="className"
v-text="textContent"
>
</div>
</template>`,
options: [
{ order:
[
'CONDITIONALS',
'LIST_RENDERING',
'RENDER_MODIFIERS',
'DEFINITION',
'EVENTS',
'UNIQUE',
['BINDING', 'OTHER_ATTR'],
'CONTENT',
'GLOBAL'
]
}],
output:
`<template>
<div
v-if="!visible"
class="content"
:class="className"
v-text="textContent"
>
</div>
</template>`,
errors: [
{
message: 'Attribute "v-if" should go before "class".',
nodeType: 'VIdentifier'
}
]
}
]
})