From 8047862840d6b8580d273e826a2789df4252ab34 Mon Sep 17 00:00:00 2001 From: Paul Berry Date: Tue, 20 Feb 2024 18:15:11 +0000 Subject: [PATCH] Change a HACK to a TODO The analyzer team has decided to adopt the convention of using `TODO` comments to document long term issues that should persist in the codebase, and `FIXME` comments to document short term issues that need immediate attention (see https://dart-review.googlesource.com/c/sdk/+/295662). They may even consider adding a presubmit hook to ensure that `FIXME` comments are only used during local development. We didn't consider `HACK` comments at the time, but IMHO it makes sense to treat them the same as `FIXME` comments; that is, as a rule we don't include them in checked in code. This change restores the analysis server to a state of having a clean "problems" view when edited using Visual Studio code. Change-Id: Icd6079cb1eb47e02d9084332d0bad0e3afa04177 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/353200 Reviewed-by: Brian Wilkerson Commit-Queue: Paul Berry --- .../lib/src/services/correction/dart/ignore_diagnostic.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/analysis_server/lib/src/services/correction/dart/ignore_diagnostic.dart b/pkg/analysis_server/lib/src/services/correction/dart/ignore_diagnostic.dart index e8623a0a143..805dc760b3b 100644 --- a/pkg/analysis_server/lib/src/services/correction/dart/ignore_diagnostic.dart +++ b/pkg/analysis_server/lib/src/services/correction/dart/ignore_diagnostic.dart @@ -157,7 +157,7 @@ class IgnoreDiagnosticInAnalysisOptionsFile extends AbstractIgnoreDiagnostic { var edit = editor.edits.single; var replacement = edit.replacement; - // HACK(dantup): The YAML editor currently produces inconsistent line + // TODO(dantup): The YAML editor currently produces inconsistent line // endings in edits when the source file contains '\r\n'. // https://github.com/dart-lang/yaml_edit/issues/65 var analysisOptionsEol = content.contains('\r')