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

New: Add vue/name-property-required rule #945

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
44 changes: 44 additions & 0 deletions lib/rules/name-property-required.js
@@ -0,0 +1,44 @@
/**
* @fileoverview Require a name property in Vue components
* @author LukeeeeBennett
*/
'use strict'

const utils = require('../utils')

function isNameProperty (node) {
return node.type === 'Property' && node.key.name === 'name'
armano2 marked this conversation as resolved.
Show resolved Hide resolved
}

function hasTruthyLiteralValue (node) {
return node.value.type === 'Literal' && node.value.value
armano2 marked this conversation as resolved.
Show resolved Hide resolved
}

module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'require a name property in Vue components',
category: undefined,
url: 'https://eslint.vuejs.org/rules/name-property-required.html'
},
fixable: null,
schema: []
},

create (context) {
return utils.executeOnVue(context, component => {
const isValid = component.properties.some(property => {
return isNameProperty(property) &&
hasTruthyLiteralValue(property)
})

if (isValid) return

context.report({
node: component,
message: 'Required name property is undefined.'
})
})
}
}
96 changes: 96 additions & 0 deletions tests/lib/rules/name-property-required.js
@@ -0,0 +1,96 @@
/**
* @fileoverview Require a name property in Vue components
* @author LukeeeeBennett
*/
'use strict'

const rule = require('../../../lib/rules/name-property-required')
const RuleTester = require('eslint').RuleTester

const parserOptions = {
ecmaVersion: 2018,
sourceType: 'module'
}

const ruleTester = new RuleTester()
ruleTester.run('name-property-required', rule, {

valid: [
{
filename: 'ValidComponent.vue',
code: `
export default {
name: 'IssaName'
}
`,
parserOptions
}
armano2 marked this conversation as resolved.
Show resolved Hide resolved
],

invalid: [
{
filename: 'InvalidComponent.vue',
code: `
export default {
}
`,
parserOptions,
errors: [{
message: 'Required name property is undefined.',
type: 'ObjectExpression'
}]
},
{
filename: 'InvalidComponent.vue',
code: `
export default {
nameNot: 'IssaNameNot'
}
`,
parserOptions,
errors: [{
message: 'Required name property is undefined.',
type: 'ObjectExpression'
}]
},
{
filename: 'InvalidComponent.vue',
code: `
export default {
name: ''
}
`,
parserOptions,
errors: [{
message: 'Required name property is undefined.',
type: 'ObjectExpression'
}]
},
{
filename: 'InvalidComponent.vue',
code: `
export default {
name: undefined
}
`,
parserOptions,
errors: [{
message: 'Required name property is undefined.',
type: 'ObjectExpression'
}]
},
{
filename: 'InvalidComponent.vue',
code: `
export default {
name: null
}
`,
parserOptions,
errors: [{
message: 'Required name property is undefined.',
type: 'ObjectExpression'
}]
}
]
})