chrome-devtools-frontend 1.0.1402249 → 1.0.1418433

package/scripts/eslint_rules/lib/prefer-url-string.js

@@ -0,0 +1,95 @@
+// Copyright 2025 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.
+'use strict';
+
+/**
+ * @fileoverview Prefer `urlString` helper over sprinkling casts to
+ * `UrlString` across the codebase..
+ */
+
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'suggestion',
+
+    docs: {
+      description: 'Prefer `urlString` helper over manual casts to `UrlString` branded type.',
+      category: 'Best Practices',
+    },
+    messages: {
+      useUrlString: 'Use `urlString` helper instead of explicitly casting strings to the `UrlString` branded type',
+    },
+    fixable: 'code',
+    schema: [], // no options
+  },
+  create: function (context) {
+    let lastImportNode = null;
+    let importTypeStarAsPlatformNode = null;
+
+    function isImportTypeStarAsPlatform(node) {
+      return node.importKind === 'type' &&
+             node.specifiers.length === 1 &&
+             node.specifiers[0].type === 'ImportNamespaceSpecifier' &&
+             node.specifiers[0].local.type === 'Identifier' &&
+             node.specifiers[0].local.name === 'Platform';
+    }
+
+    function isPlatformDevToolsPathUrlString(node) {
+      return node.type === 'TSTypeReference' &&
+             node.typeName.type === 'TSQualifiedName' &&
+             node.typeName.left.type === 'TSQualifiedName' &&
+             node.typeName.left.left.type === 'Identifier' &&
+             node.typeName.left.left.name === 'Platform' &&
+             node.typeName.left.right.type === 'Identifier' &&
+             node.typeName.left.right.name === 'DevToolsPath' &&
+             node.typeName.right.type === 'Identifier' &&
+             node.typeName.right.name === 'UrlString';
+    }
+
+    function reportError(node) {
+      context.report({
+        node,
+        messageId: 'useUrlString',
+        fix(fixer) {
+          const {sourceCode} = context;
+          const urlText = node.expression.type === 'Literal' ?
+              String(node.expression.value).replace('$', '\\$').replace('`', '\\`') :
+              `\${${sourceCode.getText(node.expression)}}`;
+          const nodeText = `urlString\`${urlText}\``;
+          const result = [fixer.replaceText(node, nodeText)];
+          if (lastImportNode !== null) {
+            // Define the shorthand
+            result.push(fixer.insertTextAfter(lastImportNode, '\n\nconst {urlString} = Platform.DevToolsPath;'));
+            lastImportNode = null;
+          }
+          if (importTypeStarAsPlatformNode) {
+            const importStarAsPlatformText =
+                sourceCode.getText(importTypeStarAsPlatformNode).replace(/import\s+type/, 'import');
+            result.push(fixer.replaceText(importTypeStarAsPlatformNode, importStarAsPlatformText));
+            importTypeStarAsPlatformNode = null;
+          }
+          return result;
+        }
+      });
+    }
+
+    return {
+      ImportDeclaration(node) {
+        lastImportNode = node;
+        if (isImportTypeStarAsPlatform(node)) {
+          importTypeStarAsPlatformNode = node;
+        }
+      },
+      TSAsExpression(node) {
+        if (isPlatformDevToolsPathUrlString(node.typeAnnotation)) {
+          reportError(node);
+        }
+      },
+    };
+  },
+};

package/scripts/eslint_rules/lib/screenshot-assertion-in-it-screenshot.js

@@ -3,6 +3,9 @@
 // found in the LICENSE file.
 
 'use strict';
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

package/scripts/eslint_rules/lib/set-data-type-reference.js

@@ -4,6 +4,9 @@
 
 'use strict';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

package/scripts/eslint_rules/lib/single-screenshot-assertion-per-test.js

@@ -3,6 +3,9 @@
 // found in the LICENSE file.
 
 'use strict';
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

package/scripts/eslint_rules/lib/static-custom-event-names.js

@@ -3,6 +3,9 @@
 // found in the LICENSE file.
 
 'use strict';
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

package/scripts/eslint_rules/lib/trace-engine-test-timeouts.js

@@ -7,6 +7,9 @@
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

package/scripts/eslint_rules/lib/utils.js

@@ -7,19 +7,19 @@
 
 /**
  * @param taggedTemplateExpressionNode - a TaggedTemplateExpression node from the AST of the parsed code.
- * @returns {boolean} - `true` if the code matches LitHtml.html`` or html``, and false otherwise.
+ * @returns {boolean} - `true` if the code matches Lit.html`` or html``, and false otherwise.
  */
 function isLitHtmlTemplateCall(taggedTemplateExpressionNode) {
   if (taggedTemplateExpressionNode.type !== 'TaggedTemplateExpression') {
     throw new Error('Node of type other than TaggedTemplateExpression passed to isLitHtmlTemplateCall.');
   }
-  // Match LitHtml.html``
+  // Match Lit.html``
   const {tag} = taggedTemplateExpressionNode;
   if (!tag) {
     return false;
   }
-  // Match LitHtml.html``
-  const isLitHtmlDotHtmlCall = tag.object?.name === 'LitHtml' && tag.property?.name === 'html';
+  // Match Lit.html``
+  const isLitHtmlDotHtmlCall = tag.object?.name === 'Lit' && tag.property?.name === 'html';
   // Match html`` (and guess that it's Lit)
   const isDestructuredHtmlCall = tag.type === 'Identifier' && tag.name === 'html';
 
@@ -28,7 +28,7 @@ function isLitHtmlTemplateCall(taggedTemplateExpressionNode) {
 
 /**
  * @param callExpressionNode - a CallExpression node from the AST of the parsed code.
- * @returns {boolean} - `true` if the code matches LitHtml.render() or render(), and false otherwise.
+ * @returns {boolean} - `true` if the code matches Lit.render() or render(), and false otherwise.
  */
 function isLitHtmlRenderCall(callExpressionNode) {
   if (callExpressionNode.type !== 'CallExpression') {
@@ -37,12 +37,12 @@ function isLitHtmlRenderCall(callExpressionNode) {
 
   const {callee} = callExpressionNode;
   const isDestructuredRenderCall = callee.type === 'Identifier' && callee.name === 'render';
-  const isLitHtmlDotRenderCall = callee.object?.name === 'LitHtml' && callee.property?.name === 'render';
+  const isLitHtmlDotRenderCall = callee.object?.name === 'Lit' && callee.property?.name === 'render';
 
   return isDestructuredRenderCall || isLitHtmlDotRenderCall;
 }
 
 module.exports = {
-  isLitHtmlTemplateCall,
-  isLitHtmlRenderCall
+  isLitHtmlRenderCall,
+  isLitHtmlTemplateCall
 };

package/scripts/eslint_rules/tests/canvas-context-tracking.test.js

@@ -3,9 +3,8 @@
 // found in the LICENSE file.
 
 const rule = require('../lib/canvas-context-tracking.js');
-const ruleTester = new (require('eslint').RuleTester)({
-  parserOptions: {ecmaVersion: 9, sourceType: 'module'},
-});
+
+const {ruleTester} = require('./utils/utils.js');
 
 ruleTester.run('canvas-context-tracking-test', rule, {
   valid: [
@@ -60,7 +59,7 @@ ruleTester.run('canvas-context-tracking-test', rule, {
   context.restore();
 }`,
       filename: 'perf_ui/flamechart.js',
-    }
+    },
   ],
 
   invalid: [
@@ -81,7 +80,10 @@ ruleTester.run('canvas-context-tracking-test', rule, {
   context.save();
 }`,
       filename: 'perf_ui/flamechart.js',
-      errors: [{messageId: 'uselessRestore'}, {messageId: 'saveNotRestored'}],
+      errors: [
+        {messageId: 'uselessRestore'},
+        {messageId: 'saveNotRestored'},
+      ],
     },
     {
       code: `function renderCanvas() {
@@ -118,5 +120,5 @@ ruleTester.run('canvas-context-tracking-test', rule, {
       filename: 'perf_ui/flamechart.js',
       errors: [{messageId: 'saveNotRestored'}],
     },
-  ]
+  ],
 });

package/scripts/eslint_rules/tests/check-css-import.test.js

@@ -4,9 +4,8 @@
 'use strict';
 
 const rule = require('../lib/check-css-import.js');
-const ruleTester = new (require('eslint').RuleTester)({
-  parserOptions: {ecmaVersion: 9, sourceType: 'module'},
-});
+
+const {ruleTester} = require('./utils/utils.js');
 
 ruleTester.run('check-css-import', rule, {
   valid: [
@@ -14,10 +13,6 @@ ruleTester.run('check-css-import', rule, {
       code: 'import styles from \'./check_css_import_test_file.css.js\';',
       filename: 'scripts/eslint_rules/tests/file.ts',
     },
-    {
-      code: 'import styles from \'./check_css_import_test_file.css.legacy.js\';',
-      filename: 'scripts/eslint_rules/tests/file.ts',
-    },
     {
       code: 'import styles from \'../../../scripts/eslint_rules/tests/check_css_import_test_file.css.js\';',
       filename: 'front_end/ui/components/file.ts',
@@ -29,25 +24,21 @@ ruleTester.run('check-css-import', rule, {
       // Files that do not exist are caught
       code: 'import styles from \'styles.css.js\';',
       filename: 'front_end/ui/components/component/file.ts',
-      errors: [{
-        message: 'File styles.css does not exist. Check you are importing the correct file.',
-      }],
-    },
-    {
-      // Files that do not exist are caught
-      code: 'import styles from \'styles.css.legacy.js\';',
-      filename: 'front_end/ui/components/component/file.ts',
-      errors: [{
-        message: 'File styles.css does not exist. Check you are importing the correct file.',
-      }],
+      errors: [
+        {
+          message: 'File styles.css does not exist. Check you are importing the correct file.',
+        },
+      ],
     },
     {
       // Filename typos are caught
       code: 'import styles from \'../../../scripts/eslint_rules/test/check_css_import_tests_file.css.js\';',
       filename: 'front_end/ui/components/icon_button/file.ts',
-      errors: [{
-        message: 'File check_css_import_tests_file.css does not exist. Check you are importing the correct file.',
-      }],
+      errors: [
+        {
+          message: 'File check_css_import_tests_file.css does not exist. Check you are importing the correct file.',
+        },
+      ],
     },
   ],
 });

package/scripts/eslint_rules/tests/check-enumerated-histograms.test.js

@@ -4,10 +4,8 @@
 'use strict';
 
 const rule = require('../lib/check-enumerated-histograms.js');
-const ruleTester = new (require('eslint').RuleTester)({
-  parserOptions: {ecmaVersion: 9, sourceType: 'module'},
-  parser: require.resolve('@typescript-eslint/parser'),
-});
+
+const {ruleTester} = require('./utils/utils.js');
 
 ruleTester.run('check-enumerated-histograms', rule, {
   valid: [
@@ -18,15 +16,19 @@ ruleTester.run('check-enumerated-histograms', rule, {
     {
       code:
           'InspectorFrontendHostInstance.recordEnumeratedHistogram(EnumeratedHistogram.IssueCreated, issueCreated, IssueCreated.MAX_VALUE);',
-      filename: 'front_end/components/test.ts'
-    }
+      filename: 'front_end/components/test.ts',
+    },
+  ],
+  invalid: [
+    {
+      code: 'InspectorFrontendHostInstance.recordEnumeratedHistogram(\'someparam\', 1, 5);',
+      filename: 'front_end/components/test.ts',
+      errors: [
+        {
+          message:
+              'When calling \'recordEnumeratedHistogram\' the third argument should be of the form \'SomeEnum.MAX_VALUE\'.',
+        },
+      ],
+    },
   ],
-  invalid: [{
-    code: 'InspectorFrontendHostInstance.recordEnumeratedHistogram(\'someparam\', 1, 5);',
-    filename: 'front_end/components/test.ts',
-    errors: [{
-      message:
-          'When calling \'recordEnumeratedHistogram\' the third argument should be of the form \'SomeEnum.MAX_VALUE\'.'
-    }],
-  }]
 });

package/scripts/eslint_rules/tests/check-license-header.test.js

@@ -4,10 +4,8 @@
 'use strict';
 
 const rule = require('../lib/check-license-header.js');
-const ruleTester = new (require('eslint').RuleTester)({
-  parserOptions: {ecmaVersion: 9, sourceType: 'module'},
-  parser: require.resolve('@typescript-eslint/parser'),
-});
+
+const {ruleTester} = require('./utils/utils.js');
 
 const CURRENT_YEAR = new Date().getFullYear();
 
@@ -109,8 +107,8 @@ import * as Common from '../common/common.js';
 
 function main() {}
 main()
-`
-    }
+`,
+    },
   ],
 
   invalid: [
@@ -156,7 +154,7 @@ import * as Action from './Action.js';
 // Copyright 2019 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.
 
-(async function() {})();`
+(async function() {})();`,
     },
     {
       code: `
@@ -266,7 +264,7 @@ main()
 
 function main() {}
 main()
-`
+`,
     },
     {
       filename: 'scripts/test_runner.js',
@@ -290,7 +288,7 @@ main()
 // found in the LICENSE file.
 function main() {}
 main()
-`
-    }
-  ]
+`,
+    },
+  ],
 });

package/scripts/eslint_rules/tests/check-test-definitions.test.js

@@ -4,9 +4,8 @@
 'use strict';
 
 const rule = require('../lib/check-test-definitions.js');
-const ruleTester = new (require('eslint').RuleTester)({
-  parserOptions: {ecmaVersion: 9, sourceType: 'module'},
-});
+
+const {ruleTester} = require('./utils/utils.js');
 
 ruleTester.run('check-test-definitions', rule, {
   valid: [
@@ -151,7 +150,10 @@ ruleTester.run('check-test-definitions', rule, {
       });
       `,
       filename: 'test/e2e/folder/file.ts',
-      errors: [{message: rule.meta.messages.missingBugId}, {message: rule.meta.messages.comment}],
+      errors: [
+        {message: rule.meta.messages.missingBugId},
+        {message: rule.meta.messages.comment},
+      ],
     },
     {
       code: `import {describe, it} from '../../shared/mocha-extensions.js';
@@ -161,7 +163,10 @@ ruleTester.run('check-test-definitions', rule, {
       });
       `,
       filename: 'test/e2e/folder/file.ts',
-      errors: [{message: rule.meta.messages.missingBugId}, {message: rule.meta.messages.comment}],
+      errors: [
+        {message: rule.meta.messages.missingBugId},
+        {message: rule.meta.messages.comment},
+      ],
     },
-  ]
+  ],
 });

package/scripts/eslint_rules/tests/check-was-shown-methods.test.js

@@ -4,10 +4,8 @@
 'use strict';
 
 const rule = require('../lib/check-was-shown-methods.js');
-const ruleTester = new (require('eslint').RuleTester)({
-  parserOptions: {ecmaVersion: 9, sourceType: 'module'},
-  parser: require.resolve('@typescript-eslint/parser'),
-});
+
+const {ruleTester} = require('./utils/utils.js');
 
 const EXPECTED_ERROR_MESSAGE = 'Please make sure the first call in wasShown is to super.wasShown().';
 
@@ -54,14 +52,14 @@ ruleTester.run('check-was-shown-methods', rule, {
         }
       }
       `,
-      filename: 'front_end/components/test.ts'
+      filename: 'front_end/components/test.ts',
     },
     {
       code: `
       export class CharacterIdMap<T> {
       }
       `,
-      filename: 'front_end/components/test.ts'
+      filename: 'front_end/components/test.ts',
     },
   ],
   invalid: [
@@ -76,7 +74,7 @@ ruleTester.run('check-was-shown-methods', rule, {
       }
       `,
       filename: 'front_end/components/test.ts',
-      errors: [{message: EXPECTED_ERROR_MESSAGE}]
+      errors: [{message: EXPECTED_ERROR_MESSAGE}],
     },
     {
       code: `
@@ -90,7 +88,7 @@ ruleTester.run('check-was-shown-methods', rule, {
       }
       `,
       filename: 'front_end/components/test.ts',
-      errors: [{message: EXPECTED_ERROR_MESSAGE}]
+      errors: [{message: EXPECTED_ERROR_MESSAGE}],
     },
     {
       code: `
@@ -102,7 +100,7 @@ ruleTester.run('check-was-shown-methods', rule, {
       }
       `,
       filename: 'front_end/components/test.ts',
-      errors: [{message: EXPECTED_ERROR_MESSAGE}]
-    }
-  ]
+      errors: [{message: EXPECTED_ERROR_MESSAGE}],
+    },
+  ],
 });

package/scripts/eslint_rules/tests/enforce-bound-render-for-schedule-render.test.js

@@ -4,10 +4,8 @@
 'use strict';
 
 const rule = require('../lib/enforce-bound-render-for-schedule-render.js');
-const ruleTester = new (require('eslint').RuleTester)({
-  parserOptions: {ecmaVersion: 9, sourceType: 'module'},
-  parser: require.resolve('@typescript-eslint/parser'),
-});
+
+const {ruleTester} = require('./utils/utils.js');
 
 ruleTester.run('enforce-bound-render-for-schedule-render', rule, {
   valid: [
@@ -68,7 +66,11 @@ ruleTester.run('enforce-bound-render-for-schedule-render', rule, {
         #render() {}
       }`,
       filename: 'front_end/components/test.ts',
-      errors: [{message: 'Bind `render` method of `scheduleRender` to `this` in components'}],
+      errors: [
+        {
+          message: 'Bind `render` method of `scheduleRender` to `this` in components',
+        },
+      ],
     },
-  ]
+  ],
 });

package/scripts/eslint_rules/tests/enforce-custom-event-names.test.js

@@ -4,10 +4,8 @@
 'use strict';
 
 const rule = require('../lib/enforce-custom-event-names.js');
-const ruleTester = new (require('eslint').RuleTester)({
-  parserOptions: {ecmaVersion: 9, sourceType: 'module'},
-  parser: require.resolve('@typescript-eslint/parser'),
-});
+
+const {ruleTester} = require('./utils/utils.js');
 
 ruleTester.run('enforce-custom-event-names', rule, {
   valid: [
@@ -71,7 +69,7 @@ export class ConstructedEvent extends Event {
         }
       }`,
       filename: 'front_end/common/Importing.js',
-      errors: [{messageId: 'invalidEventName'}]
+      errors: [{messageId: 'invalidEventName'}],
     },
     {
       code: `export class NodeSelectedEvent extends Event {
@@ -80,7 +78,7 @@ export class ConstructedEvent extends Event {
         }
       }`,
       filename: 'front_end/common/Importing.js',
-      errors: [{messageId: 'invalidEventName'}]
+      errors: [{messageId: 'invalidEventName'}],
     },
     {
       code: `export class NodeSelectedEvent extends Event {
@@ -90,7 +88,7 @@ export class ConstructedEvent extends Event {
         }
       }`,
       filename: 'front_end/common/Importing.js',
-      errors: [{messageId: 'invalidEventNameReference'}]
+      errors: [{messageId: 'invalidEventNameReference'}],
     },
     {
       code: `export class NodeSelectedEvent extends Event {
@@ -100,7 +98,7 @@ export class ConstructedEvent extends Event {
         }
       }`,
       filename: 'front_end/common/Importing.js',
-      errors: [{messageId: 'invalidEventNameReference'}]
+      errors: [{messageId: 'invalidEventNameReference'}],
     },
     {
       code: `export class NodeSelectedEvent extends Event {
@@ -110,7 +108,7 @@ export class ConstructedEvent extends Event {
         }
       }`,
       filename: 'front_end/common/Importing.js',
-      errors: [{messageId: 'invalidEventNameReference'}]
+      errors: [{messageId: 'invalidEventNameReference'}],
     },
     {
       code: `export class NodeSelectedEvent extends Event {
@@ -120,8 +118,8 @@ export class ConstructedEvent extends Event {
         }
       }`,
       filename: 'front_end/common/Importing.js',
-      errors: [{messageId: 'invalidEventName'}]
+      errors: [{messageId: 'invalidEventName'}],
     },
     // TODO: valid static, but the actual string is invalid
-  ]
+  ],
 });

package/scripts/eslint_rules/tests/enforce-default-import-name.test.js

@@ -4,16 +4,28 @@
 'use strict';
 
 const path = require('path');
+
 const rule = require('../lib/enforce-default-import-name.js');
-const ruleTester = new (require('eslint').RuleTester)({
-  parser: require.resolve('@typescript-eslint/parser'),
-});
+
+const {ruleTester} = require('./utils/utils.js');
 
 const TEST_OPTIONS = [
-  {modulePath: path.join(__dirname, '..', '..', '..', 'front_end', 'models', 'trace', 'trace.js'), importName: 'Trace'}
+  {
+    modulePath: path.join(
+        __dirname,
+        '..',
+        '..',
+        '..',
+        'front_end',
+        'models',
+        'trace',
+        'trace.js',
+        ),
+    importName: 'Trace',
+  },
 ];
 
-ruleTester.run('es-modules-import', rule, {
+ruleTester.run('enforce-default-import-name', rule, {
   valid: [
     {
       code: 'import * as Trace from "../models/trace/trace.js"',
@@ -31,7 +43,11 @@ ruleTester.run('es-modules-import', rule, {
       code: 'import * as TraceEngine from "../models/trace/trace.js"',
       filename: 'front_end/common/Importing.js',
       options: TEST_OPTIONS,
-      errors: [{message: 'When importing ../models/trace/trace.js, the name used must be Trace'}],
+      errors: [
+        {
+          message: 'When importing ../models/trace/trace.js, the name used must be Trace',
+        },
+      ],
     },
-  ]
+  ],
 });

package/scripts/eslint_rules/tests/enforce-optional-properties-last.test.js

@@ -1,15 +1,11 @@
-
 // Copyright 2024 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.
 'use strict';
 
 const rule = require('../lib/enforce-optional-properties-last.js');
-const ruleTester = new (require('eslint').RuleTester)({
-  parserOptions: {ecmaVersion: 9, sourceType: 'module'},
-  parser: require.resolve('@typescript-eslint/parser'),
-});
 
+const {ruleTester} = require('./utils/utils.js');
 ruleTester.run('optional-properties-last', rule, {
   valid: [
     {
@@ -69,7 +65,7 @@ export interface LCPPhases {
       errors: [
         {
           message: 'Optional property \'name\' should be defined after required properties.',
-          type: 'TSPropertySignature'
+          type: 'TSPropertySignature',
         },
       ],
       output: `
@@ -90,7 +86,7 @@ export interface LCPPhases {
       errors: [
         {
           message: 'Optional property \'isCool\' should be defined after required properties.',
-          type: 'TSPropertySignature'
+          type: 'TSPropertySignature',
         },
       ],
       output: `