languages/dart-sdk
languages/dart-sdk
1
0
Fork 0
mirror of https://github.com/dart-lang/sdk synced 2024-09-05 16:41:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change a HACK to a TODO

Browse source 
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 <brianwilkerson@google.com>
Commit-Queue: Paul Berry <paulberry@google.com>
This commit is contained in:
Paul Berry 2024-02-20 18:15:11 +00:00 committed by Commit Queue
parent 35075c1c22
commit 8047862840
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
pkg/analysis_server/lib/src/services/correction/dart/ignore_diagnostic.dart
View file

@ -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')