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

chore: bump markdown-it-github-alerts to 0.3.0 (override self markdown-it peer) #1389

Merged
merged 3 commits into from
Feb 14, 2024

Conversation

prazdevs
Copy link
Contributor

markdown-it-github-alerts was updated to fully respect github's alerts (case insensitive keywords) so it supports [!Note] as well as [!NOTE].

However it had markdown-it@14 as peer, which is a rewrite in ESM and updating to this version would break lots of things (especially since @types/markdown-it isnt updated as I write this), so I forced an override for this specific case. It doesn't seem to break anything so far.

@prazdevs prazdevs changed the title chore: bump markdown-it-github-alerts to 0.3.0 (override markdown-it) chore: bump markdown-it-github-alerts to 0.3.0 (override self markdown-it peer) Jan 23, 2024
@yzhang-gh
Copy link
Owner

Many thanks. It makes sense to me. However, the CI is complaining about the markdown-it version. Could you help check it out?

image

@prazdevs
Copy link
Contributor Author

That's odd 🤔 running the vsce package locally (even using [email protected]) does work without throwing an error, is there some sort of cache in the CI maybe so that overrides arent considered when running this specific command ?

@yzhang-gh
Copy link
Owner

too strange 😂

@Unfocused
Copy link

I have no idea about the CI problem, but I had looked into the case sensitivity compatibility issue to post #1390 (I'd looked for an existing issue, but didn't think to look for pull requests, so missed this).

The only code change for markdown-it-github-alerts between v0.1.2 and v0.3.0 (diff here) is changing the default of the matchCaseSensitive config option to be false. The changes to make it support markdown-it v14 seem to be merely updating the peer dependency for markdown-it and updating several dev dependencies - no code changes for that, and no other unrelated changes.

So in practice, just passing in a config object to markdown-it-github-alerts (same as other plugins) and setting matchCaseSensitive to false should be functionality equivalent to using v0.3.0.

@prazdevs
Copy link
Contributor Author

prazdevs commented Feb 7, 2024

@Unfocused that's a fair statement tbh, markdown-it@14 and the ESM thing is a bit too much IMO for what we need to fix in this PR.

Passing the param works perfectly fine, updated the PR to reflect that and make it work 👍

Pinging @yzhang-gh if that's fine for you 🎉

@yzhang-gh yzhang-gh merged commit d2862ca into yzhang-gh:master Feb 14, 2024
1 check passed
@yzhang-gh
Copy link
Owner

Hi all, thanks a lot for the help. (Sorry for the late reply as it was Chinese New Year 😉.)

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