fix: include meta.docs.url for all rules

jest-community · Feb 9, 2018 · 824c2a3 · 824c2a3
1 parent 5e5ceba
commit 824c2a3
Show file tree

Hide file tree

Showing 12 changed files with 345 additions and 270 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -17,6 +17,7 @@ module.exports = {
   },
   rules: {
     strict: 'error',
+    'eslint-plugin/require-meta-docs-url': 'error',
     'prettier/prettier': 'error',
   },
   overrides: [

diff --git a/rules/__tests__/no_large_snapshots.test.js b/rules/__tests__/no_large_snapshots.test.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const noLargeSnapshots = require('../no_large_snapshots');
+const noLargeSnapshots = require('../no_large_snapshots').create;
 
 // was not able to use https://eslint.org/docs/developer-guide/nodejs-api#ruletester for these because there is no way to configure RuleTester to run non .js files
 describe('no-large-snapshots', () => {

diff --git a/rules/no_disabled_tests.js b/rules/no_disabled_tests.js
@@ -17,77 +17,85 @@ function getName(node) {
   return null;
 }
 
-module.exports = context => {
-  let suiteDepth = 0;
-  let testDepth = 0;
+module.exports = {
+  meta: {
+    docs: {
+      url:
+        'https://github.com/jest-community/eslint-plugin-jest/blob/master/docs/rules/no-disabled-tests.md',
+    },
+  },
+  create(context) {
+    let suiteDepth = 0;
+    let testDepth = 0;
 
-  return {
-    CallExpression: node => {
-      const functionName = getName(node.callee);
+    return {
+      CallExpression: node => {
+        const functionName = getName(node.callee);
 
-      switch (functionName) {
-        case 'describe':
-          suiteDepth++;
-          break;
+        switch (functionName) {
+          case 'describe':
+            suiteDepth++;
+            break;
 
-        case 'describe.skip':
-          context.report({ message: 'Skipped test suite', node });
-          break;
+          case 'describe.skip':
+            context.report({ message: 'Skipped test suite', node });
+            break;
 
-        case 'it':
-        case 'test':
-          testDepth++;
-          if (node.arguments.length < 2) {
-            context.report({
-              message: 'Test is missing function argument',
-              node,
-            });
-          }
-          break;
+          case 'it':
+          case 'test':
+            testDepth++;
+            if (node.arguments.length < 2) {
+              context.report({
+                message: 'Test is missing function argument',
+                node,
+              });
+            }
+            break;
 
-        case 'it.skip':
-        case 'test.skip':
-          context.report({ message: 'Skipped test', node });
-          break;
+          case 'it.skip':
+          case 'test.skip':
+            context.report({ message: 'Skipped test', node });
+            break;
 
-        case 'pending':
-          if (testDepth > 0) {
-            context.report({
-              message: 'Call to pending() within test',
-              node,
-            });
-          } else if (suiteDepth > 0) {
-            context.report({
-              message: 'Call to pending() within test suite',
-              node,
-            });
-          }
-          break;
+          case 'pending':
+            if (testDepth > 0) {
+              context.report({
+                message: 'Call to pending() within test',
+                node,
+              });
+            } else if (suiteDepth > 0) {
+              context.report({
+                message: 'Call to pending() within test suite',
+                node,
+              });
+            }
+            break;
 
-        case 'xdescribe':
-          context.report({ message: 'Disabled test suite', node });
-          break;
+          case 'xdescribe':
+            context.report({ message: 'Disabled test suite', node });
+            break;
 
-        case 'xit':
-        case 'xtest':
-          context.report({ message: 'Disabled test', node });
-          break;
-      }
-    },
+          case 'xit':
+          case 'xtest':
+            context.report({ message: 'Disabled test', node });
+            break;
+        }
+      },
 
-    'CallExpression:exit': node => {
-      const functionName = getName(node.callee);
+      'CallExpression:exit': node => {
+        const functionName = getName(node.callee);
 
-      switch (functionName) {
-        case 'describe':
-          suiteDepth--;
-          break;
+        switch (functionName) {
+          case 'describe':
+            suiteDepth--;
+            break;
 
-        case 'it':
-        case 'test':
-          testDepth--;
-          break;
-      }
-    },
-  };
+          case 'it':
+          case 'test':
+            testDepth--;
+            break;
+        }
+      },
+    };
+  },
 };
diff --git a/rules/no_focused_tests.js b/rules/no_focused_tests.js
@@ -17,30 +17,38 @@ const isPropertyNamedOnly = property =>
 const isCallToTestOnlyFunction = callee =>
   matchesTestFunction(callee.object) && isPropertyNamedOnly(callee.property);
 
-module.exports = context => ({
-  CallExpression(node) {
-    const callee = node.callee;
-    if (!callee) {
-      return;
-    }
-
-    if (
-      callee.type === 'MemberExpression' &&
-      isCallToTestOnlyFunction(callee)
-    ) {
-      context.report({
-        message: 'Unexpected focused test.',
-        node: callee.property,
-      });
-      return;
-    }
-
-    if (callee.type === 'Identifier' && isCallToFocusedTestFunction(callee)) {
-      context.report({
-        message: 'Unexpected focused test.',
-        node: callee,
-      });
-      return;
-    }
+module.exports = {
+  meta: {
+    docs: {
+      url:
+        'https://github.com/jest-community/eslint-plugin-jest/blob/master/docs/rules/no-focused-tests.md',
+    },
   },
-});
+  create: context => ({
+    CallExpression(node) {
+      const callee = node.callee;
+      if (!callee) {
+        return;
+      }
+
+      if (
+        callee.type === 'MemberExpression' &&
+        isCallToTestOnlyFunction(callee)
+      ) {
+        context.report({
+          message: 'Unexpected focused test.',
+          node: callee.property,
+        });
+        return;
+      }
+
+      if (callee.type === 'Identifier' && isCallToFocusedTestFunction(callee)) {
+        context.report({
+          message: 'Unexpected focused test.',
+          node: callee,
+        });
+        return;
+      }
+    },
+  }),
+};
diff --git a/rules/no_identical_title.js b/rules/no_identical_title.js
@@ -70,26 +70,39 @@ const handleTestSuiteTitles = (context, titles, node, title) => {
 const isFirstArgLiteral = node =>
   node.arguments && node.arguments[0] && node.arguments[0].type === 'Literal';
 
-module.exports = context => {
-  const contexts = [newDescribeContext()];
-  return {
-    CallExpression(node) {
-      const currentLayer = contexts[contexts.length - 1];
-      if (isDescribe(node)) {
-        contexts.push(newDescribeContext());
-      }
-      if (!isFirstArgLiteral(node)) {
-        return;
-      }
-
-      const title = node.arguments[0].value;
-      handleTestCaseTitles(context, currentLayer.testTitles, node, title);
-      handleTestSuiteTitles(context, currentLayer.describeTitles, node, title);
-    },
-    'CallExpression:exit'(node) {
-      if (isDescribe(node)) {
-        contexts.pop();
-      }
+module.exports = {
+  meta: {
+    docs: {
+      url:
+        'https://github.com/jest-community/eslint-plugin-jest/blob/master/docs/rules/no-identical-title.md',
     },
-  };
+  },
+  create(context) {
+    const contexts = [newDescribeContext()];
+    return {
+      CallExpression(node) {
+        const currentLayer = contexts[contexts.length - 1];
+        if (isDescribe(node)) {
+          contexts.push(newDescribeContext());
+        }
+        if (!isFirstArgLiteral(node)) {
+          return;
+        }
+
+        const title = node.arguments[0].value;
+        handleTestCaseTitles(context, currentLayer.testTitles, node, title);
+        handleTestSuiteTitles(
+          context,
+          currentLayer.describeTitles,
+          node,
+          title
+        );
+      },
+      'CallExpression:exit'(node) {
+        if (isDescribe(node)) {
+          contexts.pop();
+        }
+      },
+    };
+  },
 };
diff --git a/rules/no_large_snapshots.js b/rules/no_large_snapshots.js
@@ -1,26 +1,35 @@
 'use strict';
 
-module.exports = context => {
-  if (context.getFilename().endsWith('.snap')) {
-    const lineLimit = (context.options[0] && context.options[0].maxSize) || 50;
+module.exports = {
+  meta: {
+    docs: {
+      url:
+        'https://github.com/jest-community/eslint-plugin-jest/blob/master/docs/rules/no-large-snapshots.md',
+    },
+  },
+  create(context) {
+    if (context.getFilename().endsWith('.snap')) {
+      const lineLimit =
+        (context.options[0] && context.options[0].maxSize) || 50;
 
-    return {
-      ExpressionStatement: node => {
-        const startLine = node.loc.start.line;
-        const endLine = node.loc.end.line;
-        const lineCount = endLine - startLine;
+      return {
+        ExpressionStatement: node => {
+          const startLine = node.loc.start.line;
+          const endLine = node.loc.end.line;
+          const lineCount = endLine - startLine;
 
-        if (lineCount > lineLimit) {
-          context.report({
-            message:
-              'Expected Jest snapshot to be smaller than {{ lineLimit }} lines but was {{ lineCount }} lines long',
-            data: { lineLimit, lineCount },
-            node,
-          });
-        }
-      },
-    };
-  }
+          if (lineCount > lineLimit) {
+            context.report({
+              message:
+                'Expected Jest snapshot to be smaller than {{ lineLimit }} lines but was {{ lineCount }} lines long',
+              data: { lineLimit, lineCount },
+              node,
+            });
+          }
+        },
+      };
+    }
 
-  return {};
+    return {};
+  },
 };
diff --git a/rules/prefer_expect_assertions.js b/rules/prefer_expect_assertions.js
@@ -60,22 +60,30 @@ const reportMsg = (context, node) => {
   });
 };
 
-module.exports = context => {
-  return {
-    CallExpression(node) {
-      if (isTestOrItFunction(node)) {
-        const testFuncBody = getTestFunctionBody(node);
-        if (testFuncBody) {
-          if (!isFirstLineExprStmt(testFuncBody)) {
-            reportMsg(context, node);
-          } else {
-            const testFuncFirstLine = getFunctionFirstLine(testFuncBody);
-            if (!isExpectAssertionsOrHasAssertionsCall(testFuncFirstLine)) {
+module.exports = {
+  meta: {
+    docs: {
+      url:
+        'https://github.com/jest-community/eslint-plugin-jest/blob/master/docs/rules/prefer-expect-assertions.md',
+    },
+  },
+  create(context) {
+    return {
+      CallExpression(node) {
+        if (isTestOrItFunction(node)) {
+          const testFuncBody = getTestFunctionBody(node);
+          if (testFuncBody) {
+            if (!isFirstLineExprStmt(testFuncBody)) {
               reportMsg(context, node);
+            } else {
+              const testFuncFirstLine = getFunctionFirstLine(testFuncBody);
+              if (!isExpectAssertionsOrHasAssertionsCall(testFuncFirstLine)) {
+                reportMsg(context, node);
+              }
             }
           }
         }
-      }
-    },
-  };
+      },
+    };
+  },
 };