Merge pull request #29 from chadhietala/add-docs

Adding documentation for rules

Author: chadhietala

lib/rules/linkedin/no-unguarded-document.js

@@ -1,15 +1,31 @@
+/**
+ * @fileOverview Disallow the use of unguarded document references.
+ * @author Steve Calvert
+ */
+'use strict';
+
 const { get } = require('../../utils/get');
 const { isBrowser, isEnvironmentBrowser, getEnvironmentImportBinding } = require('../../utils/linkedin/bpr');
 const { isInActions, isInteractive } = require('../../utils/interactive');
 const { collectObjectPatternBindings } = require('../../utils/destructed-binding');
 
 const MESSAGE = 'Do not use unguarded document references. Please see the following guide for more infromation: http://github.com/chadhietala/ember-best-practices/files/guides/no-unguarded-document.md';
 
+/**
+ * Determines if the current node is a document reference.
+ * @param {ASTNode} node The identifier node.
+ * @returns {Boolean} Returns true if a document reference is found, else false.
+ */
 function isDocumentReference(node) {
   return get(node, 'callee.object.name') === 'document';
 }
 
 module.exports = {
+  docs: {
+    description: 'Disallow the use of unguarded document references',
+    category: 'Best Practices',
+    recommended: false
+  },
   meta: {
     message: MESSAGE
   },

lib/rules/linkedin/no-unguarded-window.js

@@ -1,15 +1,31 @@
+/**
+ * @fileOverview Disallow the use of unguarded window references.
+ * @author Steve Calvert
+ */
+'use strict';
+
 const { get } = require('../../utils/get');
 const { isBrowser, isEnvironmentBrowser, getEnvironmentImportBinding } = require('../../utils/linkedin/bpr');
 const { isInActions, isInteractive } = require('../../utils/interactive');
 const { collectObjectPatternBindings } = require('../../utils/destructed-binding');
 
 const MESSAGE = 'Do not use unguarded window references. Please see the following guide for more infromation: http://github.com/chadhietala/ember-best-practices/files/guides/no-unguarded-window.md';
 
+/**
+ * Determines if the current node is a window reference.
+ * @param {ASTNode} node The identifier node.
+ * @returns {Boolean} Returns true if a window reference is found, else false.
+ */
 function isWindowReference(node) {
   return get(node, 'object.name') === 'window';
 }
 
 module.exports = {
+  docs: {
+    description: 'Disallow the use of unguarded document references',
+    category: 'Best Practices',
+    recommended: false
+  },
   meta: {
     message: MESSAGE
   },