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

GFM strikethrough compatibility #1258

Merged
merged 2 commits into from
Jul 9, 2018
Merged

GFM strikethrough compatibility #1258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1420eb3
Strikethrough support for GFM
May 5, 2018
22b17fe
Merge branch 'master' of https://github.com/markedjs/marked into gfm-…
May 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/marked.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,7 @@ inline.gfm = merge({}, inline.normal, {
.replace('email', inline._email)
.getRegex(),
_backpedal: /(?:[^?!.,:;*_~()&]+|\([^)]*\)|&(?![a-zA-Z0-9]+;$)|[?!.,:;*_~)]+(?!$))+/,
del: /^~~(?=\S)([\s\S]*?\S)~~/,
del: /^~+(?=\S)([\s\S]*?\S)~+/,
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. Could this be simplified (no look-ahead) to /^~+([^\s~][\s\S]*?\S)~+/?
  2. Why not ~~ leading/trailing spaces ~~? Seems like the spec permits this.

Copy link
Member

Choose a reason for hiding this comment

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

  1. The spec might allow it but github doesn't

without space:
asdf

with space:
~ asdf ~

Copy link
Contributor

@davisjam davisjam May 9, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Interesting. Would this work? /^~+([^~]+)~+/.

(This regex will accept the "with space" version which I think is appropriate despite GitHub's treatment of it).

The spec says "No nesting" which I think means that the first ~ should terminate the strike-through.

Copy link
Member

Choose a reason for hiding this comment

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

I think we should act like GitHub when the spec is ambiguous

Copy link
Contributor

Choose a reason for hiding this comment

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

To answer my own question, /^~+([^\s~][\s\S]*?\S)~+/ won't work -- it requires a minimum of two characters between the ~s.

Copy link
Contributor

@davisjam davisjam May 9, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

I'm a little concerned that this regex (old and new versions) will match ~~~. How about

/^~+(?=[^\s~])([^~]*[^\s~])~+/

which will:

  1. Ensure that the "text" neither begins nor ends with whitespace or a ~; and
  2. Explicitly prevent nesting without needing to rely on the non-greedy *? behavior.

Thoughts?

Copy link
Author

Choose a reason for hiding this comment

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

Is there any particular reason to avoid the non-greedy modifier?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm nervous about the structure /~+...[\s\S]*?...~+/. I do not believe that as written the regex is vulnerable, but a slight modification would make it so. If the middle group excludes a ~ character then the risk is removed.

Copy link
Member

Choose a reason for hiding this comment

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

@davisjam If this is not vulnerable as written then I think we should merge it because it brings us into compliance. Adding @joshbruce to take a look.

text: edit(inline.text)
.replace(']|', '~]|')
.replace('|', '|https?://|ftp://|www\\.|[a-zA-Z0-9.!#$%&\'*+/=?^_`{\\|}~-]+@|')
Expand Down
2 changes: 1 addition & 1 deletion test/specs/gfm/gfm-spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ describe('GFM 0.28 Task list items', function() {
describe('GFM 0.28 Strikethrough', function() {
var section = 'Strikethrough';

var shouldPassButFails = [469, 470];
var shouldPassButFails = [];

var willNotBeAttemptedByCoreTeam = [];

Expand Down