Document methods in use-v-on-exact

Author: michalsnik

lib/rules/use-v-on-exact.js

@@ -26,8 +26,8 @@ const KEY_ALIASES = new Set(keyAliases)
 /**
  * Finds and returns all keys for event directives
  *
- * @param {Array} attributes Element attributes
- * @returns {Array}
+ * @param {array} attributes Element attributes
+ * @returns {array[object]} [{ name, node, modifiers }]
  */
 function getEventDirectives (attributes) {
   return attributes
@@ -42,6 +42,12 @@ function getEventDirectives (attributes) {
     }))
 }
 
+/**
+ * Checks whether given modifier is KEY
+ *
+ * @param {string} modifier
+ * @returns {boolean}
+ */
 function isKeyModifier (modifier) {
   return (
     KEY_MODIFIERS.has(modifier) ||
@@ -54,10 +60,24 @@ function isKeyModifier (modifier) {
   )
 }
 
+/**
+ * Checks whether given any of provided modifiers
+ * has KEY modifier
+ *
+ * @param {array} modifiers
+ * @returns {boolean}
+ */
 function hasKeyModifier (modifiers) {
   return modifiers.some(isKeyModifier)
 }
 
+/**
+ * Groups all events in object,
+ * with keys represinting each event name
+ *
+ * @param {array} events
+ * @returns {object} { click: [], keypress: [] }
+ */
 function groupEvents (events) {
   return events.reduce((acc, event) => {
     if (acc[event.name]) {
@@ -70,10 +90,24 @@ function groupEvents (events) {
   }, {})
 }
 
+/**
+ * Creates alphabetically sorted string with key modifiers
+ *
+ * @param {array[string]} modifiers
+ * @returns {string} e.g. "alt,ctrl,del,shift"
+ */
 function getKeyModifiersString (modifiers) {
   return modifiers.filter(isKeyModifier).sort().join(',')
 }
 
+/**
+ * Compares two events based on their modifiers
+ * to detect possible event leakeage
+ *
+ * @param {object} baseEvent
+ * @param {object} event
+ * @returns {boolean}
+ */
 function hasConflictedModifiers (baseEvent, event) {
   if (
     event.node === baseEvent.node ||
@@ -90,6 +124,12 @@ function hasConflictedModifiers (baseEvent, event) {
   )
 }
 
+/**
+ * Searches for events that might conflict with each other
+ *
+ * @param {array} events
+ * @returns {array} conflicted events, without duplicates
+ */
 function findConflictedEvents (events) {
   return events.reduce((acc, event) => {
     return [