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.

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

Initial wip implementation of new code excerpter #201

Merged
merged 11 commits into from
Apr 10, 2024

Conversation

parlough
Copy link
Member

@parlough parlough commented Dec 12, 2023

This new package supports similar functionality to the old excerpter, with some functionality copied over, except it runs in one pass without package:build_runner with slightly less repetitive string processing. It is structured a bit differently to enable its use as a library package, instead of just as a command-line tool. Some functionality is simplified, changed, or removed, including:

  • The unnamed region can't be changed. It's always the entire file.
  • Region names must be alphanumerical with dashes.
  • No support for Liquid prettify tags.
  • No special support for Angular syntax.
  • Transform order is always in the order provided.
  • The region extractor and updater are more both strict, erroring or warning in cases the old implementations silently accepted, such as unclosed regions.
  • Diffs are not yet supported.
  • A few more comments for our future reference :)

There is more cleanup, implementation, and automatic testing to do, but I wanted to get this initial implementation up so other's can provide feedback and help complete that =D

As mentioned, diffs are not yet supported. This will be added later for diff outputs as well as for displaying what changed when running the updater.

Contributes to dart-lang/site-www#5593

@parlough parlough changed the title Initial implementation of new code excerpter Initial wip implementation of new code excerpter Dec 12, 2023
@parlough parlough marked this pull request as ready for review December 12, 2023 03:21
@johnpryan
Copy link
Collaborator

This is a TON of cleanup, great work @parlough!

Copy link
Collaborator

@johnpryan johnpryan left a comment

Choose a reason for hiding this comment

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

Looks great!

@parlough parlough merged commit 80f090a into main Apr 10, 2024
8 checks passed
@parlough parlough deleted the feat/new-code-excerpter branch April 10, 2024 01:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants