✨ Introduce AlertBlockSyntax #570

AlexV525 · 2023-12-11T02:11:36Z

Resolves dart-lang/tools#1343 by implementing a new syntax similar to blockquote.

https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

I’ve reviewed the contributor guide and applied the relevant portions to this PR.

Contribution guidelines:

See our contributor guide for general expectations for PRs.
Larger or significant changes should be discussed in an issue before creating a PR.
Contributions to our repos should follow the Dart style guide and use dart format.
Most changes should add an entry to the changelog and may need to rev the pubspec package version.
Changes to packages require corresponding tests.

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

AlexV525 · 2023-12-11T03:52:04Z

Let me know if I can fill in more test cases.

parlough · 2023-12-15T20:01:59Z

Thanks for working on this Alex!

\cc @srawlins @kevmoo For review since GitHub has now announced and documented this feature, likely resulting in greatly increased usage.

kevmoo · 2023-12-15T20:04:21Z

Wonderful! Please add

A changelog entry
Links to the announcement/documentation in the source code so folks understand what this is coming from!

coveralls · 2023-12-15T20:06:05Z

Pull Request Test Coverage Report for Build 7163959186

27 of 36 (75.0%) changed or added relevant lines in 2 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.5%) to 95.885%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
lib/src/block_syntaxes/callout_block_syntax.dart	26	35	74.29%

Totals
Change from base Build 7055081874:	-0.5%
Covered Lines:	1538
Relevant Lines:	1604

💛 - Coveralls

AlexV525 · 2023-12-16T09:28:05Z

Wonderful! Please add

All done @kevmoo

CHANGELOG.md

lib/src/block_syntaxes/alert_block_syntax.dart

srawlins · 2023-12-18T20:20:32Z

test/extensions/alert_extension.unit

@@ -0,0 +1,86 @@
+>>> type note
+> [!NoTe]


These tests look great! Can you see about this text: \[!note] or [\!note] and see what GitHub does and ensure we do the same. Other than that, test cases look great!

Note
foobar

Ah it shows an alert. I'll add this case.

srawlins · 2023-12-19T02:07:13Z

test/extensions/alert_extension.unit

+</blockquote>
+</div>
+>>>escape brackets
+> \[!note\]


Ha! Normally I would call that a bug. But our job is to match what GitHub does, and they likely will not change this behavior without making a big fuss, so 🤷 lgtm 😁

…, shelf, tools, webdev Revisions updated by `dart tools/rev_sdk_deps.dart`. async (https://github.com/dart-lang/async/compare/9924570..e83d054): e83d054 2024-01-08 Futuristic Goo Fix typo (dart-archive/async#262) ecosystem (https://github.com/dart-lang/ecosystem/compare/dc44e82..1e2785d): 1e2785d 2024-01-09 Jacob MacDonald fix saving of comment ids to disk (dart-lang/ecosystem#221) 244a28d 2024-01-09 Moritz Update publish.yaml (dart-lang/ecosystem#217) bab9833 2024-01-09 Moritz Fix health commenting (dart-lang/ecosystem#219) f87e6f4 2024-01-08 Moritz Update health workflow (dart-lang/ecosystem#216) a58c7d8 2024-01-03 Moritz Fix `labeler.yml` (dart-lang/ecosystem#214) leak_tracker (https://github.com/dart-lang/leak_tracker/compare/3d4c0d6..4a5b077): 4a5b077 2024-01-09 Polina Cherkasova Enhance scripting. (dart-lang/leak_tracker#204) e7094f4 2024-01-08 Polina Cherkasova Ignore test helpers. (dart-lang/leak_tracker#196) 6591934 2024-01-03 Polina Cherkasova Handle deprecation in Flutter. (dart-lang/leak_tracker#203) markdown (https://github.com/dart-lang/markdown/compare/d2e7903..7fdfa55): 7fdfa55 2024-01-01 dependabot[bot] Bump actions/stale from 8.0.0 to 9.0.0 (dart-archive/markdown#571) 5fab3a7 2023-12-19 Alex Li ✨ Introduce AlertBlockSyntax (dart-archive/markdown#570) native (https://github.com/dart-lang/native/compare/0605d9a..14f6da1): 14f6da1d 2024-01-09 Simon Binder Support `@Native` fields and `addressOf` (dart-lang/native#860) protobuf (https://github.com/dart-lang/protobuf/compare/20ec685..a293fb9): a293fb9 2024-01-08 Ömer Sinan Ağacan Handle deprecated options in grpc services and methods, enum types and values, messages (google/protobuf.dart#908) 9a408a7 2024-01-08 Ömer Sinan Ağacan Generate docs of enums and rpc clients, some refactoring (google/protobuf.dart#909) c4fd596 2024-01-06 Ömer Sinan Ağacan Export GeneratedMessageGenericExtensions in generated files (google/protobuf.dart#907) shelf (https://github.com/dart-lang/shelf/compare/733588f..823966f): 823966f 2024-01-03 Moritz Fix `labeler.yml` (dart-lang/shelf#403) tools (https://github.com/dart-lang/tools/compare/2f59ab4..8ffc077): 8ffc077 2024-01-03 Moritz Fix `labeler.yml` (dart-lang/tools#224) webdev (https://github.com/dart-lang/webdev/compare/b2405cb..c08a65c): c08a65c9 2024-01-09 Elliott Brooks Loosen `vm_service` constraints and prepare DWDS for release to 23.1.1 (dart-lang/webdev#2329) 651bdae6 2024-01-08 Derek Xu Make FrontendServerClient start the frontend server from AOT snapshot by default (dart-lang/webdev#2263) 4d1de266 2024-01-03 Elliott Brooks Prepare DWDS for release to version 23.1.0 (dart-lang/webdev#2328) Change-Id: I4d7fd994cc54ac2d72335c3ebf40710f3bd020e6 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/345366 Commit-Queue: Konstantin Shcheglov <[email protected]> Auto-Submit: Devon Carew <[email protected]> Reviewed-by: Konstantin Shcheglov <[email protected]>

AlexV525 · 2024-01-16T14:01:54Z

Hi @kevmoo @srawlins do we have any plan to publish a new version of the package?

srawlins · 2024-01-16T17:34:11Z

Sorry for the delay, I will prioritize publishing.

* ✨ Introduce `CalloutBlockSyntax` * ⚡️ More flex patterns * 🚀 Produce correct structure * ⚡️ Case-insensitive types * ⚡️ Improve `canParse` * ✅ Fill test cases * Update AUTHORS * 🚚 Rename * 📝 Add CHANGELOG * 🔥 Remove `zh` * Update CHANGELOG.md * Update pubspec.yaml * 🔖 Fix version * 🧪 Add escape brackets case * ⚡️ const type text map

AlexV525 added 6 commits December 10, 2023 17:39

✨ Introduce CalloutBlockSyntax

2791529

⚡️ More flex patterns

085eabc

🚀 Produce correct structure

cd63f43

⚡️ Case-insensitive types

d0bef01

⚡️ Improve canParse

3fa039f

✅ Fill test cases

4e18f53

AlexV525 marked this pull request as ready for review December 11, 2023 03:51

Update AUTHORS

4e5f95d

AlexV525 mentioned this pull request Dec 15, 2023

Supports GitHub Alerts with Markdown dart-lang/pub-dev#7278

Closed

AlexV525 added 2 commits December 16, 2023 17:26

🚚 Rename

abec2dd

📝 Add CHANGELOG

bfe95c9

AlexV525 changed the title ~~✨ Introduce CalloutBlockSyntax~~ ✨ Introduce AlertBlockSyntax Dec 16, 2023

🔥 Remove zh

18d05f8

kevmoo reviewed Dec 16, 2023

View reviewed changes

CHANGELOG.md Show resolved Hide resolved

AlexV525 added 2 commits December 17, 2023 01:28

Update CHANGELOG.md

18582f7

Update pubspec.yaml

f3e3298

kevmoo requested a review from srawlins December 18, 2023 20:03

srawlins suggested changes Dec 18, 2023

View reviewed changes

AlexV525 added 3 commits December 19, 2023 09:58

🔖 Fix version

401ab1c

🧪 Add escape brackets case

6f0a264

⚡️ const type text map

c634fcf

AlexV525 requested a review from srawlins December 19, 2023 02:04

srawlins approved these changes Dec 19, 2023

View reviewed changes

srawlins merged commit 5fab3a7 into dart-archive:master Dec 19, 2023

AlexV525 deleted the feat/github-callout branch December 19, 2023 03:46

jonasfj mentioned this pull request Feb 22, 2024

Crash "Bad state: No element" in AlertBlockSyntax.parseChildLines dart-lang/tools#1349

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

✨ Introduce AlertBlockSyntax #570

✨ Introduce AlertBlockSyntax #570

Uh oh!

AlexV525 commented Dec 11, 2023 •

edited

Loading

Uh oh!

AlexV525 commented Dec 11, 2023

Uh oh!

parlough commented Dec 15, 2023

Uh oh!

kevmoo commented Dec 15, 2023

Uh oh!

coveralls commented Dec 15, 2023

Uh oh!

AlexV525 commented Dec 16, 2023

Uh oh!

Uh oh!

Uh oh!

srawlins Dec 18, 2023

Uh oh!

AlexV525 Dec 18, 2023

Uh oh!

srawlins Dec 19, 2023

Uh oh!

AlexV525 commented Jan 16, 2024

Uh oh!

srawlins commented Jan 16, 2024

Uh oh!

Uh oh!

✨ Introduce AlertBlockSyntax #570

✨ Introduce AlertBlockSyntax #570

Uh oh!

Conversation

AlexV525 commented Dec 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AlexV525 commented Dec 11, 2023

Uh oh!

parlough commented Dec 15, 2023

Uh oh!

kevmoo commented Dec 15, 2023

Uh oh!

coveralls commented Dec 15, 2023

Pull Request Test Coverage Report for Build 7163959186

💛 - Coveralls

Uh oh!

AlexV525 commented Dec 16, 2023

Uh oh!

Uh oh!

Uh oh!

srawlins Dec 18, 2023

Choose a reason for hiding this comment

Uh oh!

AlexV525 Dec 18, 2023

Choose a reason for hiding this comment

Uh oh!

srawlins Dec 19, 2023

Choose a reason for hiding this comment

Uh oh!

AlexV525 commented Jan 16, 2024

Uh oh!

srawlins commented Jan 16, 2024

Uh oh!

Uh oh!

AlexV525 commented Dec 11, 2023 •

edited

Loading