Fix(html): Handle <br> elements to insert line breaks in text
#1950
Conversation
Dhruv-Maradiya
changed the title
<br> elements to insert line breaks in text
PR HealthBreaking changes ✔️
Changelog Entry ✔️
Changes to files need to be accounted for in their respective changelogs. Coverage ✔️
This check for test coverage is informational (issues shown here will not fail the PR).
API leaks
|
| Package | Leaked API symbols |
|---|---|
| html | HtmlTokenizer Token HtmlInputStream TagToken DoctypeToken StringToken TreeBuilder ActiveFormattingElements StartTagToken TagAttribute CommentToken CharactersToken SpaceCharactersToken EndTagToken |
This check can be disabled by tagging the PR with skip-leaking-check.
License Headers ⚠️
// Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
| Files |
|---|
| pkgs/html/lib/dom_parsing.dart |
| pkgs/html/test/parser_feature_test.dart |
All source files should start with a license header.
Unrelated files missing license headers
| Files |
|---|
| pkgs/bazel_worker/benchmark/benchmark.dart |
| pkgs/bazel_worker/example/client.dart |
| pkgs/bazel_worker/example/worker.dart |
| pkgs/benchmark_harness/integration_test/perf_benchmark_test.dart |
| pkgs/boolean_selector/example/example.dart |
| pkgs/clock/lib/clock.dart |
| pkgs/clock/lib/src/clock.dart |
| pkgs/clock/lib/src/default.dart |
| pkgs/clock/lib/src/stopwatch.dart |
| pkgs/clock/lib/src/utils.dart |
| pkgs/clock/test/clock_test.dart |
| pkgs/clock/test/default_test.dart |
| pkgs/clock/test/stopwatch_test.dart |
| pkgs/clock/test/utils.dart |
| pkgs/html/example/main.dart |
| pkgs/html/lib/dom.dart |
| pkgs/html/lib/html_escape.dart |
| pkgs/html/lib/parser.dart |
| pkgs/html/lib/src/constants.dart |
| pkgs/html/lib/src/encoding_parser.dart |
| pkgs/html/lib/src/html_input_stream.dart |
| pkgs/html/lib/src/list_proxy.dart |
| pkgs/html/lib/src/query_selector.dart |
| pkgs/html/lib/src/token.dart |
| pkgs/html/lib/src/tokenizer.dart |
| pkgs/html/lib/src/treebuilder.dart |
| pkgs/html/lib/src/utils.dart |
| pkgs/html/test/dom_test.dart |
| pkgs/html/test/parser_test.dart |
| pkgs/html/test/query_selector_test.dart |
| pkgs/html/test/selectors/level1_baseline_test.dart |
| pkgs/html/test/selectors/level1_lib.dart |
| pkgs/html/test/selectors/selectors.dart |
| pkgs/html/test/support.dart |
| pkgs/html/test/tokenizer_test.dart |
| pkgs/pubspec_parse/test/git_uri_test.dart |
| pkgs/stack_trace/example/example.dart |
| pkgs/watcher/test/custom_watcher_factory_test.dart |
| pkgs/yaml_edit/example/example.dart |
This check can be disabled by tagging the PR with skip-license-check.
| @@ -43,7 +43,14 @@ class TreeVisitor { | |||
| void visitText(Text node) => visitNodeFallback(node); | |||
|
|
|||
| // TODO(jmesserly): visit attributes. | |||
| void visitElement(Element node) => visitNodeFallback(node); | |||
| void visitElement(Element node) { | |||
| if (node.localName == 'br') { | |||
There was a problem hiding this comment.
This can be separate isElementBr function. Is this if statement enough to recognize it?
| final e = doc.firstChild!; | ||
| final text = e.firstChild!; | ||
| expect((text as Text).data, 'foo'); | ||
| expect(e.text, 'foobarbaz'); | ||
| expect(e.text, 'foo\nbarbaz\n'); |
There was a problem hiding this comment.
I wouldn't change the behavior of .text, in the link you shared we had a function with an explicit boolean like textContent({bool convertBRsToNewlines = false}), I'd prefer to add that instead.
|
Hey, thanks for reviewing this! 🙌 |
Fixes #1090 by updating the DOM parser to handle
<br>elements and insert line breaks (\n) when converting HTML content to plain text.Initially, I thought adding a simple condition might not be a reliable solution. So, I decided to check how HTML-to-text conversion is handled in Chromium and found a similar approach. Here's the link.
Contribution guidelines:
dart format.Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.