Improve tests for name-property-casing & improve documentation

armano2 · armano2 · commit 31a1bf904e90 · 2017-07-31T21:29:18.000+02:00
diff --git a/lib/rules/html-end-tags.js b/lib/rules/html-end-tags.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for html-end-tags.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/html-no-self-closing.js b/lib/rules/html-no-self-closing.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for html-no-self-closing.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/html-quotes.js b/lib/rules/html-quotes.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for html-quotes.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   const sourceCode = context.getSourceCode()
diff --git a/lib/rules/name-property-casing.js b/lib/rules/name-property-casing.js
@@ -21,11 +21,11 @@ function create (context) {
 
   return utils.executeOnVue(context, (obj) => {
     const node = obj.properties
-      .filter(item => (
+      .find(item => (
         item.type === 'Property' &&
         item.key.name === 'name' &&
         item.value.type === 'Literal'
-      ))[0]
+      ))
 
     if (!node) return
 
diff --git a/lib/rules/no-confusing-v-for-v-if.js b/lib/rules/no-confusing-v-for-v-if.js
@@ -34,7 +34,7 @@ function isUsingIterationVar (vIf) {
  * Creates AST event handlers for no-confusing-v-for-v-if.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-duplicate-attributes.js b/lib/rules/no-duplicate-attributes.js
@@ -34,7 +34,7 @@ function getName (attribute) {
  * Creates AST event handlers for no-duplicate-attributes.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   const names = new Set()
diff --git a/lib/rules/no-invalid-template-root.js b/lib/rules/no-invalid-template-root.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-invalid-template-root.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   const sourceCode = context.getSourceCode()
diff --git a/lib/rules/no-invalid-v-bind.js b/lib/rules/no-invalid-v-bind.js
@@ -21,7 +21,7 @@ const VALID_MODIFIERS = new Set(['prop', 'camel', 'sync'])
  * Creates AST event handlers for no-invalid-v-bind.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-invalid-v-cloak.js b/lib/rules/no-invalid-v-cloak.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-invalid-v-cloak.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-invalid-v-else-if.js b/lib/rules/no-invalid-v-else-if.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-invalid-v-else-if.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-invalid-v-else.js b/lib/rules/no-invalid-v-else.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-invalid-v-else.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-invalid-v-for.js b/lib/rules/no-invalid-v-for.js
@@ -66,7 +66,7 @@ function checkKey (context, vFor, element) {
  * Creates AST event handlers for no-invalid-v-for.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   const sourceCode = context.getSourceCode()
diff --git a/lib/rules/no-invalid-v-html.js b/lib/rules/no-invalid-v-html.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-invalid-v-html.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-invalid-v-if.js b/lib/rules/no-invalid-v-if.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-invalid-v-if.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-invalid-v-model.js b/lib/rules/no-invalid-v-model.js
@@ -77,7 +77,7 @@ function getVariable (name, leafNode) {
  * Creates AST event handlers for no-invalid-v-model.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-invalid-v-on.js b/lib/rules/no-invalid-v-on.js
@@ -28,7 +28,7 @@ const VERB_MODIFIERS = new Set([
  * Creates AST event handlers for no-invalid-v-on.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-invalid-v-once.js b/lib/rules/no-invalid-v-once.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-invalid-v-once.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-invalid-v-pre.js b/lib/rules/no-invalid-v-pre.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-invalid-v-pre.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-invalid-v-show.js b/lib/rules/no-invalid-v-show.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-invalid-v-show.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-invalid-v-text.js b/lib/rules/no-invalid-v-text.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-invalid-v-text.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-parsing-error.js b/lib/rules/no-parsing-error.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-parsing-error.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-template-key.js b/lib/rules/no-template-key.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-template-key.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/no-textarea-mustache.js b/lib/rules/no-textarea-mustache.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for no-textarea-mustache.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/require-component-is.js b/lib/rules/require-component-is.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for require-component-is.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/require-v-for-key.js b/lib/rules/require-v-for-key.js
@@ -36,7 +36,7 @@ function checkKey (context, element) {
  * Creates AST event handlers for require-v-for-key.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   utils.registerTemplateBodyVisitor(context, {
diff --git a/lib/rules/v-bind-style.js b/lib/rules/v-bind-style.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for v-bind-style.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   const shorthand = context.options[0] !== 'longform'
diff --git a/lib/rules/v-on-style.js b/lib/rules/v-on-style.js
@@ -19,7 +19,7 @@ const utils = require('../utils')
  * Creates AST event handlers for v-on-style.
  *
  * @param {RuleContext} context - The rule context.
- * @returns {object} AST event handlers.
+ * @returns {Object} AST event handlers.
  */
 function create (context) {
   const shorthand = context.options[0] !== 'longform'
diff --git a/lib/utils/casing.js b/lib/utils/casing.js
@@ -2,13 +2,23 @@ const assert = require('assert')
 
 const invalidChars = /[^a-zA-Z0-9:]+/g
 
+/**
+ * Convert text to kebab-case
+ * @param {string} str Text to be converted
+ * @return {string}
+ */
 function kebabCase (str) {
   return str
     .replace(/([a-z])([A-Z])/g, match => match[0] + '-' + match[1])
     .replace(invalidChars, '-')
     .toLowerCase()
 }
 
+/**
+ * Convert text to camelCase
+ * @param {string} str Text to be converted
+ * @return {string} Converted string
+ */
 function camelCase (str) {
   return str
     .replace(/(?:^\w|[A-Z]|\b\w)/g, (letter, index) => (
@@ -17,6 +27,11 @@ function camelCase (str) {
     .replace(invalidChars, '')
 }
 
+/**
+ * Convert text to PascalCase
+ * @param {string} str Text to be converted
+ * @return {string} Converted string
+ */
 function pascalCase (str) {
   return str
     .replace(/(?:^\w|[A-Z]|\b\w)/g, (letter, index) => letter.toUpperCase())
@@ -36,6 +51,11 @@ module.exports = {
     'PascalCase'
   ],
 
+  /**
+   * Return case converter
+   * @param {string} name type of converter to return ('camelCase', 'kebab-case', 'PascalCase')
+   * @return {kebabCase|camelCase|pascalCase}
+   */
   getConverter (name) {
     assert(typeof name === 'string')
 
diff --git a/lib/utils/index.js b/lib/utils/index.js
diff --git a/tests/lib/rules/name-property-casing.js b/tests/lib/rules/name-property-casing.js

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ const utils = require('../utils')`
`19`	`19`	`* Creates AST event handlers for html-end-tags.`
`20`	`20`	`*`
`21`	`21`	`* @param {RuleContext} context - The rule context.`
`22`		`- * @returns {object} AST event handlers.`
	`22`	`+ * @returns {Object} AST event handlers.`
`23`	`23`	`*/`
`24`	`24`	`function create (context) {`
`25`	`25`	`utils.registerTemplateBodyVisitor(context, {`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ function isUsingIterationVar (vIf) {`
`34`	`34`	`* Creates AST event handlers for no-confusing-v-for-v-if.`
`35`	`35`	`*`
`36`	`36`	`* @param {RuleContext} context - The rule context.`
`37`		`- * @returns {object} AST event handlers.`
	`37`	`+ * @returns {Object} AST event handlers.`
`38`	`38`	`*/`
`39`	`39`	`function create (context) {`
`40`	`40`	`utils.registerTemplateBodyVisitor(context, {`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ function getName (attribute) {`
`34`	`34`	`* Creates AST event handlers for no-duplicate-attributes.`
`35`	`35`	`*`
`36`	`36`	`* @param {RuleContext} context - The rule context.`
`37`		`- * @returns {object} AST event handlers.`
	`37`	`+ * @returns {Object} AST event handlers.`
`38`	`38`	`*/`
`39`	`39`	`function create (context) {`
`40`	`40`	`const names = new Set()`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ const VALID_MODIFIERS = new Set(['prop', 'camel', 'sync'])`
`21`	`21`	`* Creates AST event handlers for no-invalid-v-bind.`
`22`	`22`	`*`
`23`	`23`	`* @param {RuleContext} context - The rule context.`
`24`		`- * @returns {object} AST event handlers.`
	`24`	`+ * @returns {Object} AST event handlers.`
`25`	`25`	`*/`
`26`	`26`	`function create (context) {`
`27`	`27`	`utils.registerTemplateBodyVisitor(context, {`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ function checkKey (context, vFor, element) {`
`66`	`66`	`* Creates AST event handlers for no-invalid-v-for.`
`67`	`67`	`*`
`68`	`68`	`* @param {RuleContext} context - The rule context.`
`69`		`- * @returns {object} AST event handlers.`
	`69`	`+ * @returns {Object} AST event handlers.`
`70`	`70`	`*/`
`71`	`71`	`function create (context) {`
`72`	`72`	`const sourceCode = context.getSourceCode()`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ function getVariable (name, leafNode) {`
`77`	`77`	`* Creates AST event handlers for no-invalid-v-model.`
`78`	`78`	`*`
`79`	`79`	`* @param {RuleContext} context - The rule context.`
`80`		`- * @returns {object} AST event handlers.`
	`80`	`+ * @returns {Object} AST event handlers.`
`81`	`81`	`*/`
`82`	`82`	`function create (context) {`
`83`	`83`	`utils.registerTemplateBodyVisitor(context, {`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ const VERB_MODIFIERS = new Set([`
`28`	`28`	`* Creates AST event handlers for no-invalid-v-on.`
`29`	`29`	`*`
`30`	`30`	`* @param {RuleContext} context - The rule context.`
`31`		`- * @returns {object} AST event handlers.`
	`31`	`+ * @returns {Object} AST event handlers.`
`32`	`32`	`*/`
`33`	`33`	`function create (context) {`
`34`	`34`	`utils.registerTemplateBodyVisitor(context, {`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ function checkKey (context, element) {`
`36`	`36`	`* Creates AST event handlers for require-v-for-key.`
`37`	`37`	`*`
`38`	`38`	`* @param {RuleContext} context - The rule context.`
`39`		`- * @returns {object} AST event handlers.`
	`39`	`+ * @returns {Object} AST event handlers.`
`40`	`40`	`*/`
`41`	`41`	`function create (context) {`
`42`	`42`	`utils.registerTemplateBodyVisitor(context, {`