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

GitHub Flavored Markdown test bed #1210

Merged
merged 4 commits into from
Apr 10, 2018
Merged

GitHub Flavored Markdown test bed #1210

merged 4 commits into from
Apr 10, 2018

Conversation

joshbruce
Copy link
Member

Marked version: 0.3.19

Markdown flavor: GitHub Flavored Markdown

Description

Adds GitHub Flavored Markdown to test bed.

It is our understanding that GFM is basically just CommonMark with some extensions. Therefore, this only adds the extensions to the overarching test suite.

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.

  • Draft GitHub release notes have been updated.
  • CI is green (no forced merge required).
  • Merge PR

@joshbruce joshbruce requested review from UziTech and styfle April 9, 2018 14:40
@joshbruce
Copy link
Member Author

joshbruce commented Apr 9, 2018

@UziTech: Would also like to start shifting to the separate folders concept but don't know where to begin; think it's just easier to ask and learn or if you would be willing to take it on.

With these additional tests we should have a more trustworthy test bed overall...specifically one that protects itself against regression. Would like to get #1135 using it before merging that in, unless you or @styfle think there's a good reason not to.

Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@UziTech
Copy link
Member

UziTech commented Apr 9, 2018

where are you getting the examples for github_flavored_markdown.json?

@joshbruce
Copy link
Member Author

joshbruce commented Apr 9, 2018

@UziTech: That one I had to build, unfortunately.

https://github.github.com/gfm/ - I went to each of the TOC links that said "extension" - and copied and pasted (and modified for new lines - didn't see any tabs or anything weird).

@styfle
Copy link
Member

styfle commented Apr 9, 2018

Here's the plain text version: https://github.github.com/gfm/spec.txt

@Feder1co5oave
Copy link
Contributor

You can run this on this, like this, and then filter it in some way.

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.

Could we put this in a /test/specs/gfm folder like:

image

this will follow the update to the cm tests in #1213

@joshbruce
Copy link
Member Author

Think I got it. A couple of questions for my own edification.

  1. What's with the tilde at shouldFail?
  2. Should I be using sanitize?

@UziTech
Copy link
Member

UziTech commented Apr 10, 2018

  1. https://stackoverflow.com/a/12299717/806777
  2. No, the sanitize set in beforeEach in Test folders #1213 is just to reset the defaults after the original tests. once we merge Reset defaults before tests #1212 it will be removed. I just added it in so the tests would pass.

zhenalexfan pushed a commit to zhenalexfan/MarkdownHan that referenced this pull request Nov 8, 2021
GitHub Flavored Markdown test bed
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.

4 participants