Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
⭐️New: Add
vue/component-tags-order
rule
- Loading branch information
Showing
5 changed files
with
398 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
--- | ||
pageClass: rule-details | ||
sidebarDepth: 0 | ||
title: vue/component-tags-order | ||
description: enforce order of component top-level elements | ||
--- | ||
# vue/component-tags-order | ||
> enforce order of component top-level elements | ||
## :book: Rule Details | ||
|
||
This rule warns about the order of the `<script>`, `<template>` & `<style>` tags. | ||
|
||
## :wrench: Options | ||
|
||
```json | ||
{ | ||
"vue/component-tags-order": ["error", { | ||
"order": ["script", "template", "style"] | ||
}] | ||
} | ||
``` | ||
|
||
- `order` (`string[]`) ... The order of top-level element names. default `["script", "template", "style"]`. | ||
|
||
### `{ "order": ["script", "template", "style"] }` (default) | ||
|
||
<eslint-code-block :rules="{'vue/component-tags-order': ['error']}"> | ||
|
||
```vue | ||
<!-- ✓ GOOD --> | ||
<script>/* ... */</script> | ||
<template>...</template> | ||
<style>/* ... */</style> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
<eslint-code-block :rules="{'vue/component-tags-order': ['error']}"> | ||
|
||
```vue | ||
<!-- ✗ BAD --> | ||
<style>/* ... */</style> | ||
<script>/* ... */</script> | ||
<template>...</template> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
### `{ "order": ["template", "script", "style"] }` | ||
|
||
<eslint-code-block :rules="{'vue/component-tags-order': ['error', { 'order': ['template', 'script', 'style'] }]}"> | ||
|
||
```vue | ||
<!-- ✓ GOOD --> | ||
<template>...</template> | ||
<script>/* ... */</script> | ||
<style>/* ... */</style> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
### `{ "order": ["docs", "template", "script", "style"] }` | ||
|
||
<eslint-code-block :rules="{'vue/component-tags-order': ['error', { 'order': ['docs', 'template', 'script', 'style'] }]}"> | ||
|
||
```vue | ||
<!-- ✓ GOOD --> | ||
<docs> documents </docs> | ||
<template>...</template> | ||
<script>/* ... */</script> | ||
<style>/* ... */</style> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
<eslint-code-block :rules="{'vue/component-tags-order': ['error', { 'order': ['docs', 'template', 'script', 'style'] }]}"> | ||
|
||
```vue | ||
<!-- ✗ BAD --> | ||
<template>...</template> | ||
<script>/* ... */</script> | ||
<docs> documents </docs> | ||
<style>/* ... */</style> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
## :books: Further reading | ||
|
||
- [Style guide - Single-file component top-level element order](https://vuejs.org/v2/style-guide/#Single-file-component-top-level-element-order-recommended) | ||
|
||
## :mag: Implementation | ||
|
||
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/component-tags-order.js) | ||
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/component-tags-order.js) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
/** | ||
* @author Yosuke Ota | ||
* issue https://github.com/vuejs/eslint-plugin-vue/issues/140 | ||
*/ | ||
'use strict' | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Requirements | ||
// ------------------------------------------------------------------------------ | ||
|
||
const utils = require('../utils') | ||
|
||
const DEFAULT_ORDER = Object.freeze(['script', 'template', 'style']) | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Rule Definition | ||
// ------------------------------------------------------------------------------ | ||
|
||
module.exports = { | ||
meta: { | ||
type: 'suggestion', | ||
docs: { | ||
description: 'enforce order of component top-level elements', | ||
category: undefined, | ||
url: 'https://eslint.vuejs.org/rules/component-tags-order.html' | ||
}, | ||
fixable: null, | ||
schema: { | ||
type: 'array', | ||
properties: { | ||
order: { | ||
type: 'array' | ||
} | ||
} | ||
}, | ||
messages: { | ||
unexpected: 'The <{{name}}> should be above the <{{firstUnorderedName}}> on line {{line}}.' | ||
} | ||
}, | ||
create (context) { | ||
const order = (context.options[0] && context.options[0].order) || DEFAULT_ORDER | ||
|
||
function getTopLevelHTMLElements (node) { | ||
const templateBody = node.templateBody | ||
if (templateBody) { | ||
const document = templateBody.parent | ||
return document.children | ||
} | ||
return [] | ||
} | ||
|
||
function report (element, firstUnorderedElement) { | ||
context.report({ | ||
node: element, | ||
loc: element.loc, | ||
messageId: 'unexpected', | ||
data: { | ||
name: element.name, | ||
firstUnorderedName: firstUnorderedElement.name, | ||
line: firstUnorderedElement.loc.start.line | ||
} | ||
}) | ||
} | ||
|
||
return utils.defineTemplateBodyVisitor( | ||
context, | ||
{}, | ||
{ | ||
Program (node) { | ||
if (utils.hasInvalidEOF(node)) { | ||
return | ||
} | ||
const elements = getTopLevelHTMLElements(node) | ||
|
||
elements.forEach((element, index) => { | ||
const expectedIndex = order.indexOf(element.name) | ||
if (expectedIndex < 0) { | ||
return | ||
} | ||
const firstUnordered = elements | ||
.slice(0, index) | ||
.filter(e => expectedIndex < order.indexOf(e.name)) | ||
.sort( | ||
(e1, e2) => order.indexOf(e1.name) - order.indexOf(e2.name) | ||
)[0] | ||
if (firstUnordered) { | ||
report(element, firstUnordered) | ||
} | ||
}) | ||
} | ||
} | ||
) | ||
} | ||
} |
Oops, something went wrong.