Skip to content

Commit e42491f

Browse files
armano2mysticatea
armano2
authored and
mysticatea
committed
Chore: Improve tests for name-property-casing & improve documentation (#115)
1 parent b8d11de commit e42491f

29 files changed

+122
-49
lines changed

‎lib/rules/html-end-tags.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for html-end-tags.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/html-no-self-closing.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for html-no-self-closing.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/html-quotes.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for html-quotes.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
const sourceCode = context.getSourceCode()

‎lib/rules/no-confusing-v-for-v-if.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ function isUsingIterationVar (vIf) {
3434
* Creates AST event handlers for no-confusing-v-for-v-if.
3535
*
3636
* @param {RuleContext} context - The rule context.
37-
* @returns {object} AST event handlers.
37+
* @returns {Object} AST event handlers.
3838
*/
3939
function create (context) {
4040
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-duplicate-attributes.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ function getName (attribute) {
3434
* Creates AST event handlers for no-duplicate-attributes.
3535
*
3636
* @param {RuleContext} context - The rule context.
37-
* @returns {object} AST event handlers.
37+
* @returns {Object} AST event handlers.
3838
*/
3939
function create (context) {
4040
const names = new Set()

‎lib/rules/no-invalid-template-root.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-invalid-template-root.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
const sourceCode = context.getSourceCode()

‎lib/rules/no-invalid-v-bind.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ const VALID_MODIFIERS = new Set(['prop', 'camel', 'sync'])
2121
* Creates AST event handlers for no-invalid-v-bind.
2222
*
2323
* @param {RuleContext} context - The rule context.
24-
* @returns {object} AST event handlers.
24+
* @returns {Object} AST event handlers.
2525
*/
2626
function create (context) {
2727
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-invalid-v-cloak.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-invalid-v-cloak.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-invalid-v-else-if.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-invalid-v-else-if.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-invalid-v-else.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-invalid-v-else.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-invalid-v-for.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ function checkKey (context, vFor, element) {
7474
* Creates AST event handlers for no-invalid-v-for.
7575
*
7676
* @param {RuleContext} context - The rule context.
77-
* @returns {object} AST event handlers.
77+
* @returns {Object} AST event handlers.
7878
*/
7979
function create (context) {
8080
const sourceCode = context.getSourceCode()

‎lib/rules/no-invalid-v-html.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-invalid-v-html.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-invalid-v-if.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-invalid-v-if.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-invalid-v-model.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ function getVariable (name, leafNode) {
7777
* Creates AST event handlers for no-invalid-v-model.
7878
*
7979
* @param {RuleContext} context - The rule context.
80-
* @returns {object} AST event handlers.
80+
* @returns {Object} AST event handlers.
8181
*/
8282
function create (context) {
8383
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-invalid-v-on.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ const VERB_MODIFIERS = new Set([
2828
* Creates AST event handlers for no-invalid-v-on.
2929
*
3030
* @param {RuleContext} context - The rule context.
31-
* @returns {object} AST event handlers.
31+
* @returns {Object} AST event handlers.
3232
*/
3333
function create (context) {
3434
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-invalid-v-once.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-invalid-v-once.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-invalid-v-pre.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-invalid-v-pre.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-invalid-v-show.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-invalid-v-show.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-invalid-v-text.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-invalid-v-text.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-parsing-error.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ const DEFAULT_OPTIONS = Object.freeze(Object.assign(Object.create(null), {
5454
* Creates AST event handlers for no-parsing-error.
5555
*
5656
* @param {RuleContext} context - The rule context.
57-
* @returns {object} AST event handlers.
57+
* @returns {Object} AST event handlers.
5858
*/
5959
function create (context) {
6060
const options = Object.assign({}, DEFAULT_OPTIONS, context.options[0] || {})

‎lib/rules/no-template-key.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-template-key.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/no-textarea-mustache.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for no-textarea-mustache.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/require-component-is.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for require-component-is.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/require-v-for-key.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ function checkKey (context, element) {
4040
* Creates AST event handlers for require-v-for-key.
4141
*
4242
* @param {RuleContext} context - The rule context.
43-
* @returns {object} AST event handlers.
43+
* @returns {Object} AST event handlers.
4444
*/
4545
function create (context) {
4646
utils.registerTemplateBodyVisitor(context, {

‎lib/rules/v-bind-style.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for v-bind-style.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
const shorthand = context.options[0] !== 'longform'

‎lib/rules/v-on-style.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const utils = require('../utils')
1919
* Creates AST event handlers for v-on-style.
2020
*
2121
* @param {RuleContext} context - The rule context.
22-
* @returns {object} AST event handlers.
22+
* @returns {Object} AST event handlers.
2323
*/
2424
function create (context) {
2525
const shorthand = context.options[0] !== 'longform'

‎lib/utils/casing.js

+20
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,23 @@ const assert = require('assert')
22

33
const invalidChars = /[^a-zA-Z0-9:]+/g
44

5+
/**
6+
* Convert text to kebab-case
7+
* @param {string} str Text to be converted
8+
* @return {string}
9+
*/
510
function kebabCase (str) {
611
return str
712
.replace(/([a-z])([A-Z])/g, match => match[0] + '-' + match[1])
813
.replace(invalidChars, '-')
914
.toLowerCase()
1015
}
1116

17+
/**
18+
* Convert text to camelCase
19+
* @param {string} str Text to be converted
20+
* @return {string} Converted string
21+
*/
1222
function camelCase (str) {
1323
return str
1424
.replace(/(?:^\w|[A-Z]|\b\w)/g, (letter, index) => (
@@ -17,6 +27,11 @@ function camelCase (str) {
1727
.replace(invalidChars, '')
1828
}
1929

30+
/**
31+
* Convert text to PascalCase
32+
* @param {string} str Text to be converted
33+
* @return {string} Converted string
34+
*/
2035
function pascalCase (str) {
2136
return str
2237
.replace(/(?:^\w|[A-Z]|\b\w)/g, (letter, index) => letter.toUpperCase())
@@ -36,6 +51,11 @@ module.exports = {
3651
'PascalCase'
3752
],
3853

54+
/**
55+
* Return case converter
56+
* @param {string} name type of converter to return ('camelCase', 'kebab-case', 'PascalCase')
57+
* @return {kebabCase|camelCase|pascalCase}
58+
*/
3959
getConverter (name) {
4060
assert(typeof name === 'string')
4161

‎lib/utils/index.js

+26-12
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ module.exports = {
2525
* this generates a warning.
2626
*
2727
* @param {RuleContext} context The rule context to use parser services.
28-
* @param {object} visitor The visitor.
29-
* @returns {void}
28+
* @param {Object} visitor The visitor.
3029
*/
3130
registerTemplateBodyVisitor (context, visitor) {
3231
if (context.parserServices.registerTemplateBodyVisitor == null) {
@@ -175,11 +174,11 @@ module.exports = {
175174
)
176175
},
177176

178-
/**
179-
* Check whether the previous sibling element has `if` or `else-if` directive.
180-
* @param {ASTNode} node The element node to check.
181-
* @returns {boolean} `true` if the previous sibling element has `if` or `else-if` directive.
182-
*/
177+
/**
178+
* Check whether the previous sibling element has `if` or `else-if` directive.
179+
* @param {ASTNode} node The element node to check.
180+
* @returns {boolean} `true` if the previous sibling element has `if` or `else-if` directive.
181+
*/
183182
prevElementHasIf (node) {
184183
assert(node && node.type === 'VElement')
185184

@@ -193,11 +192,11 @@ module.exports = {
193192
)
194193
},
195194

196-
/**
197-
* Check whether the given node is a custom component or not.
198-
* @param {ASTNode} node The start tag node to check.
199-
* @returns {boolean} `true` if the node is a custom component.
200-
*/
195+
/**
196+
* Check whether the given node is a custom component or not.
197+
* @param {ASTNode} node The start tag node to check.
198+
* @returns {boolean} `true` if the node is a custom component.
199+
*/
201200
isCustomComponent (node) {
202201
assert(node && node.type === 'VElement')
203202

@@ -404,13 +403,23 @@ module.exports = {
404403
node.arguments[0].type === 'ObjectExpression'
405404
},
406405

406+
/**
407+
* Check if current file is a Vue instance or component and call callback
408+
* @param {RuleContext} context The ESLint rule context object.
409+
* @param {Function} cb Callback function
410+
*/
407411
executeOnVue (context, cb) {
408412
return Object.assign(
409413
this.executeOnVueComponent(context, cb),
410414
this.executeOnVueInstance(context, cb)
411415
)
412416
},
413417

418+
/**
419+
* Check if current file is a Vue instance (new Vue) and call callback
420+
* @param {RuleContext} context The ESLint rule context object.
421+
* @param {Function} cb Callback function
422+
*/
414423
executeOnVueInstance (context, cb) {
415424
const _this = this
416425

@@ -423,6 +432,11 @@ module.exports = {
423432
}
424433
},
425434

435+
/**
436+
* Check if current file is a Vue component and call callback
437+
* @param {RuleContext} context The ESLint rule context object.
438+
* @param {Function} cb Callback function
439+
*/
426440
executeOnVueComponent (context, cb) {
427441
const filePath = context.getFilename()
428442
const _this = this

0 commit comments

Comments
 (0)