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

fix: non leading-tabs in markdown content (#1559) #2434

Merged
merged 4 commits into from
Apr 11, 2022
Merged

fix: non leading-tabs in markdown content (#1559) #2434

merged 4 commits into from
Apr 11, 2022

Conversation

rossipedia
Copy link
Contributor

Marked version:

Markdown flavor: CommonMark

Description

Only replaces tabs at the beginning of a block construct. Tabs in the middle of the item are unaffected.

Contributor

  • Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

@rossipedia
fix: non leading-tabs in markdown content (markedjs#1559)
e160e57 
Only replaces tabs at the beginning of a block construct. Tabs in the
middle of the item are unaffected.

All tests passing. Tabs in both GFM and CommonMark at 100%

fixes markedjs#1559
@vercel
Copy link

vercel bot commented Apr 8, 2022 •
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

marked-website – ./

🔍 Inspect: https://vercel.com/markedjs/marked-website/D3uTfybfhra66Kx3bbv8kgdEqMw5
✅ Preview: https://marked-website-git-fork-docker-fix-commonmark-tabs-markedjs.vercel.app

markedjs – ./

🔍 Inspect: https://vercel.com/markedjs-legacy/markedjs/A1UvPUv6aE5erAJmpiDKM5my7xeg
✅ Preview: https://markedjs-git-fork-docker-fix-commonmark-tabs-markedjs-legacy.vercel.app

UziTech
UziTech requested changes Apr 8, 2022
View reviewed changes
src/Lexer.js Outdated Show resolved Hide resolved
@rossipedia rossipedia requested a review from UziTech April 8, 2022 05:29
@rossipedia
Copy link
Contributor Author

Does this look good now?

UziTech
UziTech requested changes Apr 9, 2022
View reviewed changes
src/Lexer.js Outdated Show resolved Hide resolved
@rossipedia rossipedia requested a review from UziTech April 9, 2022 21:47
UziTech
UziTech approved these changes Apr 10, 2022
View reviewed changes
Copy link
Member

@UziTech UziTech left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this! 💯

calculuschild
calculuschild approved these changes Apr 10, 2022
View reviewed changes
Copy link
Contributor

@calculuschild calculuschild left a comment

Choose a reason for hiding this comment

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

Looks good to me. Only question is if there might be some other token that needs its rules.js updated to handle tabs?

UziTech
UziTech requested changes Apr 10, 2022
View reviewed changes
Copy link
Member

@UziTech UziTech left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I did find one example that seems broken.

>	test
// tab between > and test

It is actually currently kind of broken (additional spaces are added to the output) but with this PR it creates a code element in the blockquote.

Looks like https://github.com/markedjs/marked/blob/master/src/Tokenizer.js#L154 might have to be updated to remove a tab after > as well.

@rossipedia
Copy link
Contributor Author

rossipedia commented Apr 10, 2022 •
edited
Loading

Ok seems like that might be a case that's missing a test. I'll see about putting one together for it.

@rossipedia rossipedia requested a review from UziTech April 10, 2022 17:29
@UziTech
Copy link
Member

UziTech commented Apr 10, 2022

@calculuschild I think this now passes any test I can think of.

calculuschild
calculuschild approved these changes Apr 10, 2022
View reviewed changes
Copy link
Contributor

@calculuschild calculuschild left a comment

Choose a reason for hiding this comment

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

Cool, I approve then. I can't think of anything else either.

@UziTech UziTech merged commit 7d19665 into markedjs:master Apr 11, 2022
github-actions bot pushed a commit that referenced this pull request Apr 11, 2022
@semantic-release-bot
chore(release): 4.0.14 [skip ci]
7a6dc09 
## [4.0.14](v4.0.13...v4.0.14) (2022-04-11)

### Bug Fixes

* only convert leading tabs to spaces ([#1559](#1559)) ([#2434](#2434)) ([7d19665](7d19665))
@github-actions
Copy link

🎉 This PR is included in version 4.0.14 🎉

The release is available on:

Your semantic-release bot 📦🚀

@rossipedia rossipedia deleted the fix-commonmark-tabs branch April 11, 2022 01:45
@ErazerBrecht ErazerBrecht mentioned this pull request Jun 27, 2022
Closed
@kathy-t kathy-t mentioned this pull request Aug 3, 2023
Merged
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@calculuschild calculuschild calculuschild approved these changes

@UziTech UziTech UziTech approved these changes

@davisjam davisjam Awaiting requested review from davisjam

@joshbruce joshbruce Awaiting requested review from joshbruce

@styfle styfle Awaiting requested review from styfle

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

Successfully merging this pull request may close these issues.

Markdown containing tabs not converted properly to spaces
3 participants
@rossipedia @UziTech @calculuschild