deduplicate and document new rules.

README.md

@@ -110,11 +110,8 @@ Inspired by [this talk](https://www.youtube.com/watch?v=PSGEjv3Tqo0).
 
 | Name  | Description | Default Configuration |
 | ------------- | ------------- | ------------- |
-| no-classes | Forbids use of classes. | 'no-classes': 0 |
-| no-deletes | Forbids use of delete. | 'no-deletes': 2 |
 | no-exceptions | Forbids throwing and catching errors. | 'no-exceptions': 2 |
 | no-exports | Forbids use of export keyword.  | 'no-exports': 0 |
-| no-fors | Forbids use for, for-in, for of statements. | 'no-fors': 2 |
 | no-function-expressions | Forbids use function expressions. | 'no-function-expressions': 0 |
 | no-ifs | Forbids use of if statements. | 'no-ifs': 2 |
 | no-imports | Forbids use of import keyword. | 'no-imports': 0 |
@@ -124,10 +121,9 @@ Inspired by [this talk](https://www.youtube.com/watch?v=PSGEjv3Tqo0).
 | no-reassigns | Forbids reassigning variables. | 'no-reassigns': 2 |
 | no-switches | Forbids use of switch statement. | 'no-switches': 2 |
 | no-this | Forbids use of this. | 'no-this': 2 |
-| no-typeof | Forbids typeof operator. | 'no-typeofs': 2 |
+| no-typeofs | Forbids typeof operator. | 'no-typeofs': 2 |
 | no-undefined | Forbids use of undefined. | 'no-undefined': 0 |
 | no-variable-declaration | Forbids declaring variables. | 'no-variable-declaration': 0 |
-| no-whiles | Forbids use while, do-while statements. | 'no-whiles': 2 |
 | must-return | Every branch of every function should have a return statement. | 'must-return': 2 |
 | explicit-return | Stricter version of must-return: every function should have a top level return statement. | 'explicit-return': 2 |
 

rules/explicit-return.js

@@ -1,4 +1,4 @@
-module.exports = function (context) {
+const create = function (context) {
   const functions = [];
   function enterFunction(node) {
     return functions.push(node);
@@ -27,3 +27,14 @@ module.exports = function (context) {
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description:
+        'Stricter version of must-return: every function should have a top level return statement.',
+      recommended: 'off'
+    }
+  }
+};

rules/must-return.js

@@ -79,7 +79,7 @@ function isSimpleArrow(node) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
-module.exports = function (context) {
+const create = function (context) {
   const treatUndefinedAsUnspecified = false;
   let funcInfo = null;
 
@@ -187,3 +187,13 @@ module.exports = function (context) {
     'ArrowFunctionExpression:exit': checkLastSegment
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Every branch of every function should have a return statement.',
+      recommended: 'off'
+    }
+  }
+};

rules/no-exceptions.js

@@ -1,4 +1,4 @@
-module.exports = function (context) {
+const create = function (context) {
   return [
     'ThrowStatement',
     'TryStatement',
@@ -10,3 +10,13 @@ module.exports = function (context) {
     return acc;
   }, {});
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids throwing and catching errors.',
+      recommended: 'off'
+    }
+  }
+};

rules/no-exports.js

@@ -1,4 +1,4 @@
-module.exports = function (context) {
+const create = function (context) {
   return [
     'ExportNamedDeclaration',
     'ExportDefaultDeclaration',
@@ -10,3 +10,13 @@ module.exports = function (context) {
     return acc;
   }, {});
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids use of export keyword',
+      recommended: 'off'
+    }
+  }
+};

rules/no-function-expressions.js

@@ -1,7 +1,17 @@
-module.exports = function (context) {
+const create = function (context) {
   return {
     FunctionExpression(node) {
       return context.report(node, 'Unexpected function expression, use fat arrow expression instead');
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids the use of function expressions, consider: prefer-arrow-callback',
+      recommended: 'off'
+    }
+  }
+};

rules/no-ifs.js

@@ -1,7 +1,17 @@
-module.exports = function (context) {
+const create = function (context) {
   return {
     IfStatement(node) {
       return context.report(node, 'Unexpected if statement, use ternary expression instead');
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids the use of `if` statements, in favour of ternary expressions',
+      recommended: 'off'
+    }
+  }
+};

rules/no-imports.js

@@ -1,7 +1,17 @@
-module.exports = function (context) {
+const create = function (context) {
   return {
     ImportDeclaration(node) {
       return context.report(node, 'Unexpected import statement, use CJS require function instead');
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids the use of the `import` keyword, in favour of CommonJS',
+      recommended: 'off'
+    }
+  }
+};

rules/no-instanceofs.js

@@ -1,4 +1,4 @@
-module.exports = function (context) {
+const create = function (context) {
   return {
     UnaryExpression(node) {
       return node.operator === 'instanceof' ?
@@ -7,3 +7,13 @@ module.exports = function (context) {
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids the use of the `instanceof` operator',
+      recommended: 'off'
+    }
+  }
+};

rules/no-new.js

@@ -1,7 +1,17 @@
-module.exports = function (context) {
+const create = function (context) {
   return {
     NewExpression(node) {
       context.report(node, 'Unexpected "new" expression');
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids the use of the `new` keyword',
+      recommended: 'off'
+    }
+  }
+};

rules/no-nulls.js

@@ -1,7 +1,17 @@
-module.exports = function (context) {
+const create = function (context) {
   return {
     Null(node) {
-      return context.report(node, 'Unexpected null, use undefined instead');
+      return context.report(node, 'Unexpected null, use an Option/Maybe Monad instead');
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids the use of `null`.',
+      recommended: 'off'
+    }
+  }
+};

rules/no-reassigns.js

@@ -1,4 +1,4 @@
-module.exports = function (context) {
+const create = function (context) {
   return {
     AssignmentExpression(node) {
       return node.left && node.left.type === 'MemberExpression' && node.left.property && node.left.property.name === 'exports' ?
@@ -7,3 +7,13 @@ module.exports = function (context) {
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids reassigning variables',
+      recommended: 'off'
+    }
+  }
+};

rules/no-switches.js

@@ -1,7 +1,17 @@
-module.exports = function (context) {
+const create = function (context) {
   return {
     SwitchStatement(node) {
       return context.report(node, 'Unexpected switch statement, use pattern matching library instead');
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids the use of the `switch` statement',
+      recommended: 'off'
+    }
+  }
+};

rules/no-typeofs.js

@@ -1,4 +1,4 @@
-module.exports = function (context) {
+const create = function (context) {
   return {
     UnaryExpression(node) {
       return node.operator === 'typeof' ?
@@ -7,3 +7,13 @@ module.exports = function (context) {
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids the typeof operator',
+      recommended: 'off'
+    }
+  }
+};

rules/no-undefined.js

@@ -1,9 +1,19 @@
-module.exports = function (context) {
+const create = function (context) {
   return {
     Identifier(node) {
       return node.value === 'undefined' ?
-        context.report(node, 'Unexpected undefined, use null instead') :
+        context.report(node, 'Unexpected undefined, use an Option/Maybe Monad instead') :
         undefined;
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids the use of `undefined`.',
+      recommended: 'off'
+    }
+  }
+};

rules/no-variable-declarations.js

@@ -1,4 +1,4 @@
-module.exports = function (context) {
+const create = function (context) {
   return {
     VariableDeclaration(node) {
       return ['var', 'let'].indexOf(node.kind) === -1 ?
@@ -7,3 +7,13 @@ module.exports = function (context) {
     }
   };
 };
+
+module.exports = {
+  create,
+  meta: {
+    docs: {
+      description: 'Forbids variable declarations, no `var` or `let`.',
+      recommended: 'off'
+    }
+  }
+};