Clean up abstract classes that only contain static methods (#9170)

kenzieschmoll · web-flow · commit f157394258f3 · 2025-05-02T10:26:14.000-07:00
* Clean up abstract classes that only contain static methods

* remove unused parameter
diff --git a/packages/devtools_app/lib/src/framework/framework_core.dart b/packages/devtools_app/lib/src/framework/framework_core.dart
@@ -44,8 +44,8 @@ typedef ErrorReporter = void Function(String title, Object error);
 
 final _log = Logger('framework_core');
 
-// ignore: avoid_classes_with_only_static_members, intentional grouping of static methods.
-abstract class FrameworkCore {
+/// A namespace for core framework objects and methods.
+extension FrameworkCore on Never {
   static final _memoryObserver = MemoryObserver();
 
   /// Initializes the DevTools framework, which includes setting up global
diff --git a/packages/devtools_app/lib/src/screens/debugger/debugger_model.dart b/packages/devtools_app/lib/src/screens/debugger/debugger_model.dart
@@ -236,8 +236,8 @@ class StackFrameAndSourcePosition {
   }
 }
 
-// ignore: avoid_classes_with_only_static_members, fine for utility method.
-abstract class ScriptRefUtils {
+/// A namespace for [ScriptRef] utilities.
+extension ScriptRefUtils on Never {
   static String fileName(ScriptRef scriptRef) =>
       fileNameFromUri(Uri.parse(scriptRef.uri!).path)!;
 }
diff --git a/packages/devtools_app/lib/src/screens/debugger/span_parser.dart b/packages/devtools_app/lib/src/screens/debugger/span_parser.dart
@@ -9,8 +9,8 @@ import 'package:collection/collection.dart';
 import 'package:string_scanner/string_scanner.dart';
 
 //TODO(jacobr): cleanup.
-// ignore: avoid_classes_with_only_static_members
-abstract class SpanParser {
+/// A namespace for [SpanParser] utilities.
+extension SpanParser on Never {
   /// Takes a TextMate [Grammar] and a [String] and outputs a list of
   /// [ScopeSpan]s corresponding to the parsed input.
   static List<ScopeSpan> parse(Grammar grammar, String src) {
diff --git a/packages/devtools_app/lib/src/screens/memory/panes/chart/controller/charts/android_chart_controller.dart b/packages/devtools_app/lib/src/screens/memory/panes/chart/controller/charts/android_chart_controller.dart
@@ -13,8 +13,8 @@ import '../../../../../../shared/charts/chart_trace.dart'
 import '../../../../shared/primitives/memory_timeline.dart';
 import '../../data/charts.dart';
 
-// ignore: avoid_classes_with_only_static_members, enum-like classes are ok
-class _Color {
+/// A namespace for Android memory chart color constants.
+extension _Color on Never {
   static const otherColor = Color(0xffff8800); // HoloOrangeDark;
   static const nativeHeapColor = Color(0xff33b5e5); // HoloBlueLight
   static final graphicColor = Colors.greenAccent.shade400;
diff --git a/packages/devtools_app/lib/src/screens/memory/panes/chart/controller/charts/vm_chart_controller.dart b/packages/devtools_app/lib/src/screens/memory/panes/chart/controller/charts/vm_chart_controller.dart
@@ -13,8 +13,8 @@ import '../../../../../../shared/charts/chart_trace.dart'
 import '../../../../shared/primitives/memory_timeline.dart';
 import '../../data/charts.dart';
 
-// ignore: avoid_classes_with_only_static_members, enum-like classes are ok
-class _Colors {
+/// A namespace for VM memory chart color constants.
+extension _Colors on Never {
   static final capacity = Colors.grey[400]!;
   static const used = Color(0xff33b5e5);
   static const externals = Color(0xff4ddeff);
diff --git a/packages/devtools_app/lib/src/shared/analytics/constants/_property_editor_sidebar_constants.dart b/packages/devtools_app/lib/src/shared/analytics/constants/_property_editor_sidebar_constants.dart
@@ -4,8 +4,8 @@
 
 part of '../constants.dart';
 
-// ignore: avoid_classes_with_only_static_members, used for namespacing.
-class PropertyEditorSidebar {
+/// A namespace for Property Editor analytics.
+extension PropertyEditorSidebar on Never {
   /// Analytics id to track events that come from the DTD editor sidebar.
   static String get id => 'propertyEditorSidebar';
 
diff --git a/packages/devtools_app/lib/src/shared/analytics/gtags.dart b/packages/devtools_app/lib/src/shared/analytics/gtags.dart
@@ -21,8 +21,8 @@ import 'analytics.dart' as ga;
 external void _gTagCommandName(String command, String name, [JSObject? params]);
 
 // TODO(jacobr): refactor this code if we do not migrate off gtags.
-// ignore: avoid_classes_with_only_static_members
-class GTag {
+/// A namespace for gtags.
+extension GTag on Never {
   static const _event = 'event';
   static const _exception = 'exception';
 
diff --git a/packages/devtools_app/lib/src/shared/charts/flame_chart.dart b/packages/devtools_app/lib/src/shared/charts/flame_chart.dart
@@ -889,9 +889,8 @@ extension NodeListExtension on List<FlameChartNode> {
   }
 }
 
-// TODO(jacobr): cleanup up this util class with just static members.
-// ignore: avoid_classes_with_only_static_members
-class FlameChartUtils {
+/// A namespace for flame chart utilities.
+extension FlameChartUtils on Never {
   static double leftPaddingForNode(
     int index,
     List<FlameChartNode> nodes, {
diff --git a/packages/devtools_app/lib/src/shared/development_helpers.dart b/packages/devtools_app/lib/src/shared/development_helpers.dart
@@ -84,8 +84,10 @@ void resetDevToolsExtensionEnabledStates() =>
 /// server connection.
 final stubExtensionEnabledStates = <String, ExtensionEnabledState>{};
 
-// ignore: avoid_classes_with_only_static_members, useful for testing.
-abstract class StubDevToolsExtensions {
+/// A namespace for stubbed DevTools extensions.
+///
+/// These are useful for testing and local development.
+extension StubDevToolsExtensions on Never {
   /// Extension for package:foo detected from a running app that requires a
   /// connected app.
   static final fooExtension = DevToolsExtensionConfig.parse({
diff --git a/packages/devtools_app/lib/src/shared/feature_flags.dart b/packages/devtools_app/lib/src/shared/feature_flags.dart
@@ -41,13 +41,12 @@ const _kNetworkDisconnectExperience = bool.fromEnvironment(
   defaultValue: true,
 );
 
-// It is ok to have enum-like static only classes.
-// ignore: avoid_classes_with_only_static_members
-/// Flags to hide features under construction.
+/// A namespace for feature flags, which set the visibility of features under
+/// active development.
 ///
 /// When adding a new feature flag, the developer is responsible for adding it
 /// to the [_allFlags] map for debugging purposes.
-abstract class FeatureFlags {
+extension FeatureFlags on Never {
   /// Flag to enable the DevTools memory observer, which attempts to help users
   /// avoid OOM crashes.
   ///
diff --git a/packages/devtools_app/lib/src/shared/http/_http_date.dart b/packages/devtools_app/lib/src/shared/http/_http_date.dart
@@ -14,10 +14,8 @@
 
 part of 'http.dart';
 
-// TODO(jacobr): cleanup this class with only static members.
-// ignore: avoid_classes_with_only_static_members
-/// Utility functions for working with dates with HTTP specific date formats.
-class HttpDate {
+/// A namespace for HTTP date utilities.
+extension HttpDate on Never {
   // Parse a cookie date string.
   static DateTime _parseCookieDate(String date) {
     const monthsLowerCase = const <String>[
diff --git a/packages/devtools_app/lib/src/shared/primitives/diagnostics_text_styles.dart b/packages/devtools_app/lib/src/shared/primitives/diagnostics_text_styles.dart
@@ -5,9 +5,8 @@
 import 'package:devtools_app_shared/ui.dart';
 import 'package:flutter/material.dart';
 
-// Enum-like static classes are ok.
-// ignore: avoid_classes_with_only_static_members
-class DiagnosticsTextStyles {
+/// A namespace for diagnostic text styles and utilities.
+extension DiagnosticsTextStyles on Never {
   static TextStyle unimportant(ColorScheme colorScheme) => TextStyle(
     color: colorScheme.isLight ? Colors.grey.shade500 : Colors.grey.shade600,
   );
diff --git a/packages/devtools_app/lib/src/shared/utils/utils.dart b/packages/devtools_app/lib/src/shared/utils/utils.dart
@@ -18,6 +18,7 @@ import 'package:flutter/widgets.dart';
 import 'package:logging/logging.dart';
 import 'package:vm_service/vm_service.dart';
 
+// ignore: avoid-importing-entrypoint-exports, required to access version.
 import '../../../devtools.dart' as devtools;
 import '../../service/connected_app/connected_app.dart';
 import '../framework/app_error_handling.dart';
diff --git a/packages/devtools_app/test/screens/memory/tracing/tracing_pane_controller_test.dart b/packages/devtools_app/test/screens/memory/tracing/tracing_pane_controller_test.dart
@@ -7,8 +7,8 @@ import 'package:devtools_app/src/screens/memory/panes/tracing/tracing_pane_contr
 import 'package:flutter_test/flutter_test.dart';
 import 'package:vm_service/vm_service.dart';
 
-// ignore: avoid_classes_with_only_static_members, ok for enum-like class
-class _Tests {
+/// A namespace for memory tracing tests.
+extension _Tests on Never {
   static final empty = TracePaneController(rootPackage: '');
 
   static final selection = TracePaneController(
diff --git a/packages/devtools_app/test/test_infra/scenes/memory/default.dart b/packages/devtools_app/test/test_infra/scenes/memory/default.dart
@@ -27,8 +27,8 @@ import '../scene_test_extensions.dart';
 // To run:
 // flutter run -t test/test_infra/scenes/memory/default.stager_app.g.dart -d macos
 
-// ignore: avoid_classes_with_only_static_members, enum like classes are ok
-abstract class MemoryDefaultSceneHeaps {
+/// A namespace for stubbed data used in memory tests.
+extension MemoryDefaultSceneHeaps on Never {
   /// Many instances of the same class with different long paths.
   ///
   /// If sorted by retaining path this class will be the second from the top.
diff --git a/packages/devtools_app/test/test_infra/test_data/performance/sample_performance_data.dart b/packages/devtools_app/test/test_infra/test_data/performance/sample_performance_data.dart
@@ -4,8 +4,6 @@
 
 // This is the Perfetto data from [samplePerformanceData] as data class objects.
 
-// ignore_for_file: avoid_classes_with_only_static_members
-
 import 'dart:convert';
 
 import 'package:devtools_app/devtools_app.dart';
@@ -129,7 +127,7 @@ final timelineEventWithShaderJank = testTimelineEvent(
 );
 
 /// Data for Frame (id: 2)
-abstract class FlutterFrame2 {
+extension FlutterFrame2 on Never {
   static final frame =
       FlutterFrame.fromJson({
           'number': 2,
@@ -364,7 +362,7 @@ abstract class FlutterFrame2 {
 }
 
 /// Data for Frame (id: 4)
-abstract class FlutterFrame4 {
+extension FlutterFrame4 on Never {
   static final frame = FlutterFrame.fromJson(_frameJson)
     ..setEventFlow(uiEvent)
     ..setEventFlow(rasterEvent);
@@ -929,7 +927,7 @@ abstract class FlutterFrame4 {
 }
 
 /// Data for Frame (id: 6)
-abstract class FlutterFrame6 {
+extension FlutterFrame6 on Never {
   static final frame = FlutterFrame.fromJson(_frameJson)
     ..setEventFlow(uiEvent)
     ..setEventFlow(rasterEvent);
diff --git a/packages/devtools_shared/lib/src/server/file_system.dart b/packages/devtools_shared/lib/src/server/file_system.dart
@@ -9,8 +9,8 @@ import 'package:path/path.dart' as path;
 
 import 'devtools_store.dart';
 
-// ignore: avoid_classes_with_only_static_members, requires refactor.
-class LocalFileSystem {
+/// A namespace local file system utlities.
+extension LocalFileSystem on Never {
   static String _userHomeDir() {
     final envKey = Platform.operatingSystem == 'windows' ? 'APPDATA' : 'HOME';
     return Platform.environment[envKey] ?? '.';
diff --git a/packages/devtools_shared/lib/src/server/handlers/_app_size.dart b/packages/devtools_shared/lib/src/server/handlers/_app_size.dart
@@ -2,11 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
-// ignore_for_file: avoid_classes_with_only_static_members
-
 part of '../server_api.dart';
 
-abstract class _AppSizeHandler {
+/// A namespace for app size server request handlers.
+extension _AppSizeHandler on Never {
   static shelf.Response getBaseAppSizeFile(
     ServerApi api,
     Map<String, String> queryParams,
diff --git a/packages/devtools_shared/lib/src/server/handlers/_deeplink.dart b/packages/devtools_shared/lib/src/server/handlers/_deeplink.dart
@@ -2,11 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
-// ignore_for_file: avoid_classes_with_only_static_members
-
 part of '../server_api.dart';
 
-abstract class _DeeplinkApiHandler {
+/// A namespace for deep link server request handlers.
+extension _DeeplinkApiHandler on Never {
   static Future<shelf.Response> handleAndroidBuildVariants(
     ServerApi api,
     Map<String, String> queryParams,
diff --git a/packages/devtools_shared/lib/src/server/handlers/_devtools_extensions.dart b/packages/devtools_shared/lib/src/server/handlers/_devtools_extensions.dart
@@ -2,11 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
-// ignore_for_file: avoid_classes_with_only_static_members
-
 part of '../server_api.dart';
 
-abstract class _ExtensionsApiHandler {
+/// A namespace for DevTools extensions server request handlers.
+extension _ExtensionsApiHandler on Never {
   static Future<shelf.Response> handleServeAvailableExtensions(
     ServerApi api,
     Map<String, String> queryParams,
diff --git a/packages/devtools_shared/lib/src/server/handlers/_dtd.dart b/packages/devtools_shared/lib/src/server/handlers/_dtd.dart
@@ -2,11 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
-// ignore_for_file: avoid_classes_with_only_static_members
-
 part of '../server_api.dart';
 
-abstract class _DtdApiHandler {
+/// A namespace for Dart Tooling Daemon (DTD) server request handlers.
+extension _DtdApiHandler on Never {
   static shelf.Response handleGetDtdUri(
     ServerApi api,
     DtdInfo? dtd,
diff --git a/packages/devtools_shared/lib/src/server/handlers/_preferences.dart b/packages/devtools_shared/lib/src/server/handlers/_preferences.dart
@@ -2,11 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
-// ignore_for_file: avoid_classes_with_only_static_members
-
 part of '../server_api.dart';
 
-abstract class _PreferencesApiHandler {
+/// A namespace for preferences server request handlers.
+extension _PreferencesApiHandler on Never {
   static shelf.Response getPreferenceValue<T>(
     ServerApi api,
     Map<String, String> queryParams,
diff --git a/packages/devtools_shared/lib/src/server/handlers/_release_notes.dart b/packages/devtools_shared/lib/src/server/handlers/_release_notes.dart
@@ -2,11 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
-// ignore_for_file: avoid_classes_with_only_static_members
-
 part of '../server_api.dart';
 
-abstract class _ReleaseNotesHandler {
+/// A namespace for release notes server request handlers.
+extension _ReleaseNotesHandler on Never {
   static shelf.Response getLastReleaseNotesVersion(
     ServerApi api,
     DevToolsUsage devToolsStore,
diff --git a/packages/devtools_shared/lib/src/server/handlers/_storage.dart b/packages/devtools_shared/lib/src/server/handlers/_storage.dart
@@ -2,11 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
-// ignore_for_file: avoid_classes_with_only_static_members
-
 part of '../server_api.dart';
 
-abstract class _StorageHandler {
+/// A namespace for local storage request handlers.
+extension _StorageHandler on Never {
   static shelf.Response handleGetStorageValue<T>(
     ServerApi api,
     DevToolsUsage devToolsStore, {
diff --git a/packages/devtools_shared/lib/src/server/handlers/_survey.dart b/packages/devtools_shared/lib/src/server/handlers/_survey.dart
@@ -2,11 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
-// ignore_for_file: avoid_classes_with_only_static_members
-
 part of '../server_api.dart';
 
-abstract class _SurveyHandler {
+/// A namespace for DevTools survey server request handlers.
+extension _SurveyHandler on Never {
   static shelf.Response setActiveSurvey(
     ServerApi api,
     Map<String, String> queryParams,
diff --git a/packages/devtools_shared/lib/src/server/handlers/_vm_service.dart b/packages/devtools_shared/lib/src/server/handlers/_vm_service.dart
@@ -2,12 +2,11 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
 
-// ignore_for_file: avoid_classes_with_only_static_members
-
 part of '../server_api.dart';
 
+/// A namespace for VM service related server request handlers.
 @visibleForTesting
-abstract class Handler {
+extension VmServiceHandler on Never {
   /// Stores the calculated package roots for VM service connections that are
   /// initiated in [handleNotifyForVmServiceConnection].
   ///
@@ -68,7 +67,6 @@ abstract class Handler {
         vmServiceUriAsString: vmServiceUriAsString,
         vmServiceUri: vmServiceUri,
         connected: connected,
-        api: api,
         dtd: dartToolingDaemon,
       );
       if (detectRootResponse.success) {
@@ -98,7 +96,6 @@ abstract class Handler {
     required String vmServiceUriAsString,
     required Uri vmServiceUri,
     required bool connected,
-    required ServerApi api,
     required DartToolingDaemon dtd,
   }) async {
     final Uri rootPackageUri;
diff --git a/packages/devtools_shared/lib/src/server/server_api.dart b/packages/devtools_shared/lib/src/server/server_api.dart
@@ -32,7 +32,7 @@ part 'handlers/_app_size.dart';
 part 'handlers/_deeplink.dart';
 part 'handlers/_devtools_extensions.dart';
 part 'handlers/_dtd.dart';
-part 'handlers/_general.dart';
+part 'handlers/_vm_service.dart';
 part 'handlers/_preferences.dart';
 part 'handlers/_release_notes.dart';
 part 'handlers/_storage.dart';
@@ -64,7 +64,7 @@ class ServerApi {
     final queryParams = request.requestedUri.queryParameters;
     switch (request.url.path) {
       case apiNotifyForVmServiceConnection:
-        return Handler.handleNotifyForVmServiceConnection(
+        return VmServiceHandler.handleNotifyForVmServiceConnection(
           api,
           queryParams,
           dtd,
diff --git a/packages/devtools_shared/test/server/general_api_test.dart b/packages/devtools_shared/test/server/general_api_test.dart

Original file line number	Diff line number	Diff line change
`@@ -236,8 +236,8 @@ class StackFrameAndSourcePosition {`
`236`	`236`	`}`
`237`	`237`	`}`
`238`	`238`
`239`		`-// ignore: avoid_classes_with_only_static_members, fine for utility method.`
`240`		`-abstract class ScriptRefUtils {`
	`239`	`+/// A namespace for [ScriptRef] utilities.`
	`240`	`+extension ScriptRefUtils on Never {`
`241`	`241`	`static String fileName(ScriptRef scriptRef) =>`
`242`	`242`	`fileNameFromUri(Uri.parse(scriptRef.uri!).path)!;`
`243`	`243`	`}`
Original file line number	Diff line number	Diff line change
`@@ -889,9 +889,8 @@ extension NodeListExtension on List<FlameChartNode> {`
`889`	`889`	`}`
`890`	`890`	`}`
`891`	`891`
`892`		`-// TODO(jacobr): cleanup up this util class with just static members.`
`893`		`-// ignore: avoid_classes_with_only_static_members`
`894`		`-class FlameChartUtils {`
	`892`	`+/// A namespace for flame chart utilities.`
	`893`	`+extension FlameChartUtils on Never {`
`895`	`894`	`static double leftPaddingForNode(`
`896`	`895`	`int index,`
`897`	`896`	`List<FlameChartNode> nodes, {`