Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

✨ Introduce AlertBlockSyntax #570

Merged
merged 15 commits into from
Dec 19, 2023
Merged

✨ Introduce AlertBlockSyntax #570

merged 15 commits into from
Dec 19, 2023

Conversation

AlexV525
Copy link
Contributor

@AlexV525 AlexV525 commented Dec 11, 2023 •
edited
Loading

Resolves #567 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:

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

@AlexV525 AlexV525 marked this pull request as ready for review December 11, 2023 03:51
@AlexV525
Copy link
Contributor Author

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

@AlexV525 AlexV525 mentioned this pull request Dec 15, 2023
Closed
@parlough
Copy link
Member

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
Copy link
Member

kevmoo commented Dec 15, 2023

Wonderful! Please add

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

@coveralls
Copy link

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 Coverage Status
Change from base Build 7055081874: -0.5%
Covered Lines: 1538
Relevant Lines: 1604
💛 - Coveralls

@AlexV525 AlexV525 changed the title ✨ Introduce CalloutBlockSyntax ✨ Introduce AlertBlockSyntax Dec 16, 2023
@AlexV525
Copy link
Contributor Author

Wonderful! Please add

All done @kevmoo

kevmoo
kevmoo reviewed Dec 16, 2023
View reviewed changes
CHANGELOG.md Show resolved Hide resolved
@kevmoo kevmoo requested a review from srawlins December 18, 2023 20:03
srawlins
srawlins requested changes Dec 18, 2023
View reviewed changes
lib/src/block_syntaxes/alert_block_syntax.dart Outdated Show resolved Hide resolved
test/extensions/alert_extension.unit
@@ -0,0 +1,86 @@
>>> type note
> [!NoTe]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

foobar

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

srawlins
srawlins approved these changes Dec 19, 2023
View reviewed changes
test/extensions/alert_extension.unit
</blockquote>
</div>
>>>escape brackets
> \[!note\]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😁

@srawlins srawlins merged commit 5fab3a7 into dart-lang:master Dec 19, 2023
8 checks passed
@AlexV525 AlexV525 deleted the feat/github-callout branch December 19, 2023 03:46
copybara-service bot pushed a commit to dart-lang/sdk that referenced this pull request Jan 9, 2024
@devoncarew
[deps] rev async, ecosystem, leak_tracker, markdown, native, protobuf…
0b5f092 
…, 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-lang/markdown#571)
  5fab3a7  2023-12-19  Alex Li  ✨ Introduce AlertBlockSyntax (dart-lang/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 <scheglov@google.com>
Auto-Submit: Devon Carew <devoncarew@google.com>
Reviewed-by: Konstantin Shcheglov <scheglov@google.com>
@AlexV525
Copy link
Contributor Author

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

@srawlins
Copy link
Member

Sorry for the delay, I will prioritize publishing.

@jonasfj jonasfj mentioned this pull request Feb 22, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kevmoo kevmoo kevmoo left review comments

@srawlins srawlins srawlins approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Render the "alert" markdown extension
5 participants
@AlexV525 @parlough @kevmoo @coveralls @srawlins