chore: migrate no-commented-out-tests

src/rules/__tests__/no-commented-out-tests.test.js → src/rules/__tests__/no-commented-out-tests.test.ts

@@ -1,7 +1,8 @@
-import { RuleTester } from 'eslint';
+import { TSESLint } from '@typescript-eslint/experimental-utils';
 import rule from '../no-commented-out-tests';
 
-const ruleTester = new RuleTester({
+const ruleTester = new TSESLint.RuleTester({
+  parser: '@typescript-eslint/parser',
   parserOptions: {
     sourceType: 'module',
   },
@@ -24,6 +25,7 @@ ruleTester.run('no-commented-out-tests', rule, {
     'testSomething()',
     '// latest(dates)',
     '// TODO: unify with Git implementation from Shipit (?)',
+    '#!/usr/bin/env node',
     [
       'import { pending } from "actions"',
       '',
@@ -141,8 +143,8 @@ ruleTester.run('no-commented-out-tests', rule, {
     {
       code: `
       foo()
-      /* 
-      describe("has title but no callback", () => {}) 
+      /*
+      describe("has title but no callback", () => {})
       */
       bar()`,
       errors: [{ messageId: 'commentedTests', column: 7, line: 3 }],

src/rules/no-commented-out-tests.ts

@@ -0,0 +1,45 @@
+import { TSESTree } from '@typescript-eslint/experimental-utils';
+import { createRule } from './tsUtils';
+
+function hasTests(node: TSESTree.Comment) {
+  return /^\s*(x|f)?(test|it|describe)(\.\w+|\[['"]\w+['"]\])?\s*\(/m.test(
+    node.value,
+  );
+}
+
+export default createRule({
+  name: __filename,
+  meta: {
+    docs: {
+      category: 'Best Practices',
+      description:
+        "This rule raises a warning about commented out tests. It's similar to no-disabled-tests rule.",
+      recommended: false,
+    },
+    messages: {
+      commentedTests: 'Some tests seem to be commented',
+    },
+    schema: [],
+    type: 'suggestion',
+  } as const,
+  defaultOptions: [],
+  create(context) {
+    const sourceCode = context.getSourceCode();
+
+    function checkNode(node: TSESTree.Comment) {
+      if (!hasTests(node)) {
+        return;
+      }
+
+      context.report({ messageId: 'commentedTests', node });
+    }
+
+    return {
+      Program() {
+        const comments = sourceCode.getAllComments();
+
+        comments.forEach(checkNode);
+      },
+    };
+  },
+});