chore(no-test-prefixes): migrate to TS (#328)

jest-community · Jul 22, 2019 · ee81058 · ee81058
1 parent e938636
commit ee81058
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 8 deletions.
diff --git a/src/rules/__tests__/no-test-prefixes.test.js → src/rules/__tests__/no-test-prefixes.test.ts b/src/rules/__tests__/no-test-prefixes.test.js → src/rules/__tests__/no-test-prefixes.test.ts
@@ -1,7 +1,7 @@
-import { RuleTester } from 'eslint';
+import { TSESLint } from '@typescript-eslint/experimental-utils';
 import rule from '../no-test-prefixes';
 
-const ruleTester = new RuleTester();
+const ruleTester = new TSESLint.RuleTester();
 
 ruleTester.run('no-test-prefixes', rule, {
   valid: [
@@ -15,6 +15,7 @@ ruleTester.run('no-test-prefixes', rule, {
     'it.skip("foo", function () {})',
     'test.skip("foo", function () {})',
     'foo()',
+    '[1,2,3].forEach()',
   ],
   invalid: [
     {

diff --git a/src/rules/no-test-prefixes.js → src/rules/no-test-prefixes.ts b/src/rules/no-test-prefixes.js → src/rules/no-test-prefixes.ts
@@ -1,22 +1,27 @@
-import { getDocsUrl, getNodeName, isDescribe, isTestCase } from './util';
+import { createRule, getNodeName, isDescribe, isTestCase } from './tsUtils';
 
-export default {
+export default createRule({
+  name: __filename,
   meta: {
     docs: {
-      url: getDocsUrl(__filename),
+      category: 'Best Practices',
+      description: 'Use `.only` and `.skip` over `f` and `x`',
+      recommended: 'error',
     },
     messages: {
       usePreferredName: 'Use "{{ preferredNodeName }}" instead',
     },
     fixable: 'code',
     schema: [],
+    type: 'suggestion',
   },
+  defaultOptions: [],
   create(context) {
     return {
       CallExpression(node) {
         const nodeName = getNodeName(node.callee);
 
-        if (!isDescribe(node) && !isTestCase(node)) return;
+        if (!nodeName || (!isDescribe(node) && !isTestCase(node))) return;
 
         const preferredNodeName = getPreferredNodeName(nodeName);
 
@@ -33,9 +38,9 @@ export default {
       },
     };
   },
-};
+});
 
-function getPreferredNodeName(nodeName) {
+function getPreferredNodeName(nodeName: string) {
   const firstChar = nodeName.charAt(0);
 
   if (firstChar === 'f') {