Skip to content
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.

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

Add vue/no-invalid-attribute-name rule #1851

Merged
merged 22 commits into from May 17, 2022
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/rules/README.md
Expand Up @@ -326,6 +326,7 @@ For example:
| [vue/no-duplicate-attr-inheritance](./no-duplicate-attr-inheritance.md) | enforce `inheritAttrs` to be set to `false` when using `v-bind="$attrs"` | |
| [vue/no-empty-component-block](./no-empty-component-block.md) | disallow the `<template>` `<script>` `<style>` block to be empty | |
| [vue/no-expose-after-await](./no-expose-after-await.md) | disallow asynchronously registered `expose` | |
| [vue/no-invalid-attribute-name](./no-invalid-attribute-name.md) | require valid attribute names | |
| [vue/no-invalid-model-keys](./no-invalid-model-keys.md) | require valid keys in model option | |
| [vue/no-multiple-objects-in-class](./no-multiple-objects-in-class.md) | disallow to pass multiple objects into array to class | |
| [vue/no-potential-component-option-typo](./no-potential-component-option-typo.md) | disallow a potential typo in your component property | :bulb: |
Expand Down
43 changes: 43 additions & 0 deletions docs/rules/no-invalid-attribute-name.md
@@ -0,0 +1,43 @@
---
pageClass: rule-details
sidebarDepth: 0
title: vue/no-invalid-attribute-name
description: require valid attribute names
---
# vue/no-invalid-attribute-name

> require valid attribute names

- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> ***This rule has not been released yet.*** </badge>

## :book: Rule Details

This rule detects invalid HTML attributes.

<eslint-code-block :rules="{'vue/no-invalid-attribute-name': ['error']}">

```vue
<template>
<!-- ✓ GOOD -->
<p foo.bar></p>
<p foo-bar></p>
<p _foo.bar></p>
<p :foo-bar></p>

<!-- ✗ BAD -->
<p 0abc></p>
<p -def></p>
<p !ghi></p>
</template>
```

</eslint-code-block>

## :wrench: Options

Nothing.

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-invalid-attribute-name.js)
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-invalid-attribute-name.js)
1 change: 1 addition & 0 deletions lib/index.js
Expand Up @@ -93,6 +93,7 @@ module.exports = {
'no-export-in-script-setup': require('./rules/no-export-in-script-setup'),
'no-expose-after-await': require('./rules/no-expose-after-await'),
'no-extra-parens': require('./rules/no-extra-parens'),
'no-invalid-attribute-name': require('./rules/no-invalid-attribute-name'),
'no-invalid-model-keys': require('./rules/no-invalid-model-keys'),
'no-irregular-whitespace': require('./rules/no-irregular-whitespace'),
'no-lifecycle-after-await': require('./rules/no-lifecycle-after-await'),
Expand Down
49 changes: 49 additions & 0 deletions lib/rules/no-invalid-attribute-name.js
@@ -0,0 +1,49 @@
/**
* @author Doug Wade <douglas.b.wade@gmail.com>
* See LICENSE file in root directory for full license.
*/
'use strict'

const utils = require('../utils')
const xnv = require('xml-name-validator')
doug-wade marked this conversation as resolved.
Show resolved Hide resolved

module.exports = {
meta: {
type: 'problem',
docs: {
description: 'require valid attribute names',
categories: undefined,
url: 'https://eslint.vuejs.org/rules/no-invalid-attribute-name.html'
},
fixable: null,
schema: [],
messages: {
unexpected: 'Attribute name {{name}} is not valid.'
}
},
/** @param {RuleContext} context */
create(context) {
/**
* @param {string | VIdentifier} key
* @return {string}
*/
const getName = (key) => (typeof key === 'string' ? key : key.name)

return utils.defineTemplateBodyVisitor(context, {
/** @param {VDirective | VAttribute} node */
VAttribute(node) {
doug-wade marked this conversation as resolved.
Show resolved Hide resolved
const name = getName(node.key.name)
doug-wade marked this conversation as resolved.
Show resolved Hide resolved

if (!xnv.name(name)) {
context.report({
doug-wade marked this conversation as resolved.
Show resolved Hide resolved
node,
messageId: 'unexpected',
data: {
name
}
})
}
}
})
}
}
3 changes: 2 additions & 1 deletion package.json
Expand Up @@ -59,7 +59,8 @@
"nth-check": "^2.0.1",
"postcss-selector-parser": "^6.0.9",
"semver": "^7.3.5",
"vue-eslint-parser": "^8.0.1"
"vue-eslint-parser": "^8.0.1",
"xml-name-validator": "^4.0.0"
},
"devDependencies": {
"@types/eslint": "^7.28.1",
Expand Down
78 changes: 78 additions & 0 deletions tests/lib/rules/no-invalid-attribute-name.js
@@ -0,0 +1,78 @@
/**
* @author *****your name*****
* See LICENSE file in root directory for full license.
*/
'use strict'

const RuleTester = require('eslint').RuleTester
const rule = require('../../../lib/rules/no-invalid-attribute-name')

const tester = new RuleTester({
parser: require.resolve('vue-eslint-parser'),
parserOptions: {
ecmaVersion: 2020,
sourceType: 'module'
}
})

tester.run('no-invalid-attribute-name', rule, {
valid: [
{
filename: 'test.vue',
code: '<template><p foo /></template>'
},
{
filename: 'test.vue',
code: `<template><p foo="bar" /></template>`
},
{
filename: 'test.vue',
code: `<template><p foo-bar /></template>`
},
{
filename: 'test.vue',
code: `<template><p _foo-bar /></template>`
},
{
filename: 'test.vue',
code: `<template><p :foo-bar /></template>`
},
{
filename: 'test.vue',
code: `<template><p foo.bar /></template>`
},
{
filename: 'test.vue',
code: `<template><p quux-.9 /></template>`
}
],
invalid: [
{
filename: 'test.vue',
code: `<template><p 0abc /></template>`,
errors: [
{
message: 'Attribute name 0abc is not valid.'
doug-wade marked this conversation as resolved.
Show resolved Hide resolved
}
]
},
{
filename: 'test.vue',
code: `<template><p -def></template>`,
errors: [
{
message: 'Attribute name -def is not valid.'
}
]
},
{
filename: 'test.vue',
code: `<template><p !ghi /></template>`,
errors: [
{
message: 'Attribute name !ghi is not valid.'
}
]
}
doug-wade marked this conversation as resolved.
Show resolved Hide resolved
]
})