[eslint] Migrate rules to TypeScript

Bug: 397586315
Change-Id: I889070caf10daab07644d9ad84efddb91bb38e9b
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6436651
Commit-Queue: Nikolay Vitkov <nvitkov@chromium.org>
Reviewed-by: Benedikt Meurer <bmeurer@chromium.org>
Auto-Submit: Nikolay Vitkov <nvitkov@chromium.org>
Commit-Queue: Benedikt Meurer <bmeurer@chromium.org>

Author: Lightning00Blade

scripts/eslint_rules/lib/check-enumerated-histograms.js

@@ -0,0 +1,42 @@
+// Copyright 2020 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import {createRule} from './tsUtils.ts';
+
+export default createRule({
+  name: 'check-enumerated-histograms',
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'check arguments when recording enumerated histograms',
+      category: 'Possible Errors',
+    },
+    fixable: 'code',
+    messages: {
+      invalidArgument:
+          'When calling \'recordEnumeratedHistogram\' the third argument should be of the form \'SomeEnum.MAX_VALUE\'.',
+    },
+    schema: [],  // no options
+  },
+  defaultOptions: [],
+  create: function(context) {
+    return {
+      CallExpression(node) {
+        if (node.callee.type === 'MemberExpression' && node.callee.object.type === 'Identifier' &&
+            node.callee.object.name === 'InspectorFrontendHostInstance' && node.callee.property.type === 'Identifier' &&
+            node.callee.property.name === 'recordEnumeratedHistogram') {
+          const argumentNode = node.arguments[2];
+
+          if (argumentNode.type !== 'MemberExpression' || argumentNode.property.type !== 'Identifier' ||
+              argumentNode.property.name !== 'MAX_VALUE') {
+            context.report({
+              node,
+              messageId: 'invalidArgument',
+            });
+          }
+        }
+      },
+    };
+  },
+});

scripts/eslint_rules/lib/check-enumerated-histograms.ts

@@ -2,16 +2,16 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-/**
- * @fileoverview Rule to check license headers
- * @author Tim van der Lippe
- */
-'use strict';
+import type {TSESTree} from '@typescript-eslint/utils';
+import * as path from 'path';
 
-const path = require('path');
+import {createRule} from './tsUtils.ts';
 
 const FRONT_END_FOLDER = path.join(
-    __filename,
+    // If we want to fix this we need to change to .mts or use a package.json
+    // with type : module
+    // @ts-expect-error we don't build the file to CJS
+    import.meta.filename,
     '..',
     '..',
     '..',
@@ -111,14 +111,10 @@ const OTHER_LICENSE_HEADERS = [
   'ui/Widget.js',
 ];
 
-// ------------------------------------------------------------------------------
-// Rule Definition
-// ------------------------------------------------------------------------------
-
 /**
- * Check each linecomment that should (combined) result in the LINE_LICENSE_HEADER.
+ * Check each line comment that should (combined) result in the LINE_LICENSE_HEADER.
  */
-function isMissingLineCommentLicense(comments) {
+function isMissingLineCommentLicense(comments: TSESTree.Comment[]) {
   for (let i = 0; i < LINE_REGEXES.length; i++) {
     if (!comments[i] || !LINE_REGEXES[i].test(comments[i].value)) {
       return true;
@@ -131,39 +127,36 @@ function isMissingLineCommentLicense(comments) {
 /**
  * We match the whole block comment, including potential leading asterisks of the jsdoc.
  */
-function isMissingBlockLineCommentLicense(licenseText) {
+function isMissingBlockLineCommentLicense(licenseText: string) {
   return !BLOCK_REGEX.test(licenseText);
 }
 
-/**
- * @type {import('eslint').Rule.RuleModule}
- */
-module.exports = {
+export default createRule({
+  name: 'check-license-header',
   meta: {
     type: 'problem',
-
     docs: {
       description: 'check license headers',
       category: 'Possible Errors',
     },
     fixable: 'code',
-    schema: [], // no options
+    schema: [],  // no options
+    messages: {
+      missingLicense: 'Missing license header',
+      incorrectLineLicense: 'Incorrect line license header',
+      incorrectBlockLicense: 'Incorrect block license header',
+    },
   },
-  create: function (context) {
+  defaultOptions: [],
+  create: function(context) {
     const sourceCode = context.sourceCode ?? context.getSourceCode();
     const filename = context.filename ?? context.getFilename();
     const fileName = filename;
     // Fix windows paths for exemptions
-    const relativePath = path
-      .relative(FRONT_END_FOLDER, fileName)
-      .replace(/\\/g, '/');
-
-    if (
-      relativePath.startsWith('third_party') ||
-      fileName.endsWith('TestRunner.js') ||
-      EXCLUDED_FILES.includes(relativePath) ||
-      OTHER_LICENSE_HEADERS.includes(relativePath)
-    ) {
+    const relativePath = path.relative(FRONT_END_FOLDER, fileName).replace(/\\/g, '/');
+
+    if (relativePath.startsWith('third_party') || fileName.endsWith('TestRunner.js') ||
+        EXCLUDED_FILES.includes(relativePath) || OTHER_LICENSE_HEADERS.includes(relativePath)) {
       return {};
     }
 
@@ -180,7 +173,7 @@ module.exports = {
             (comments.length === 1 && comments[0].type === 'Shebang')) {
           context.report({
             node,
-            message: 'Missing license header',
+            messageId: 'missingLicense',
             fix(fixer) {
               return fixer.insertTextBefore(node, LICENSE_HEADER_ADDITION);
             },
@@ -202,30 +195,28 @@ module.exports = {
           if (isMissingLineCommentLicense(commentsToCheck)) {
             context.report({
               node,
-              message: 'Incorrect line license header',
+              messageId: 'incorrectLineLicense',
               fix(fixer) {
                 return fixer.insertTextBefore(
-                  firstCommentToCheck,
-                  LICENSE_HEADER_ADDITION,
+                    firstCommentToCheck,
+                    LICENSE_HEADER_ADDITION,
                 );
               },
             });
           }
-        } else if (
-          isMissingBlockLineCommentLicense(firstCommentToCheck.value)
-        ) {
+        } else if (isMissingBlockLineCommentLicense(firstCommentToCheck.value)) {
           context.report({
             node,
-            message: 'Incorrect block license header',
+            messageId: 'incorrectBlockLicense',
             fix(fixer) {
               return fixer.insertTextBefore(
-                firstCommentToCheck,
-                LICENSE_HEADER_ADDITION,
+                  firstCommentToCheck,
+                  LICENSE_HEADER_ADDITION,
               );
             },
           });
         }
       },
     };
   },
-};
+});

scripts/eslint_rules/lib/check-license-header.js renamed to scripts/eslint_rules/lib/check-license-header.ts

@@ -2,37 +2,29 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-/**
- * @fileoverview Rule to check test definitions
- * @author Tim van der Lippe
- */
-'use strict';
+import type {TSESTree} from '@typescript-eslint/types';
 
-const TEST_NAME_REGEX = /^\[crbug.com\/\d+\]/;
+import {createRule} from './tsUtils.ts';
 
-// ------------------------------------------------------------------------------
-// Rule Definition
-// ------------------------------------------------------------------------------
+const TEST_NAME_REGEX = /^\[crbug.com\/\d+\]/;
 
-function getTextValue(node) {
+function getTextValue(node: TSESTree.Node): string|undefined {
   if (node.type === 'Literal') {
-    return node.value;
+    return node.value?.toString();
   }
   if (node.type === 'TemplateLiteral') {
     if (node.quasis.length === 0) {
-      return undefined;
+      return;
     }
     return node.quasis[0].value.cooked;
   }
+  return;
 }
 
-/**
- * @type {import('eslint').Rule.RuleModule}
- */
-module.exports = {
+export default createRule({
+  name: 'check-test-definitions',
   meta: {
     type: 'problem',
-
     docs: {
       description: 'check test implementations',
       category: 'Possible Errors',
@@ -42,11 +34,12 @@ module.exports = {
           'Skipped tests must have a CRBug included in the description: `it.skip(\'[crbug.com/BUGID]: testname\', async() => {})',
       extraBugId:
           'Non-skipped tests cannot include a CRBug tag at the beginning of the description: `it.skip(\'testname (crbug.com/BUGID)\', async() => {})',
-      comment: 'A skipped test must have an attached comment with an explanation written before the test'
+      comment: 'A skipped test must have an attached comment with an explanation written before the test',
     },
     fixable: 'code',
-    schema: []  // no options
+    schema: [],  // no options
   },
+  defaultOptions: [],
   create: function(context) {
     const sourceCode = context.sourceCode ?? context.getSourceCode();
     return {
@@ -57,7 +50,7 @@ module.exports = {
 
         if ((node.object.name === 'it' || node.object.name === 'describe' || node.object.name === 'itScreenshot') &&
             (node.property.name === 'skip' || node.property.name === 'skipOnPlatforms') &&
-            node.parent.type === 'CallExpression') {
+            node.parent?.type === 'CallExpression') {
           const testNameNode = node.property.name === 'skip' ? node.parent.arguments[0] : node.parent.arguments[1];
 
           if (!testNameNode) {
@@ -81,7 +74,7 @@ module.exports = {
         }
       },
 
-      CallExpression(node) {
+      CallExpression(node: TSESTree.CallExpression) {
         if (node.callee.type === 'Identifier' && node.callee.name === 'it' && node.arguments[0]) {
           const textValue = getTextValue(node.arguments[0]);
 
@@ -92,7 +85,7 @@ module.exports = {
             });
           }
         }
-      }
+      },
     };
-  }
-};
+  },
+});