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

GFM compliance for tasks lists #1250

Merged
merged 4 commits into from
May 8, 2018
Merged

GFM compliance for tasks lists #1250

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7482990
GFM compliance for tasks
May 3, 2018
409cb0d
Merge branch 'master' into gfm-tasks
May 4, 2018
aa73bb6
add space to task regex and disable xhtml for gfm testing
May 4, 2018
b083a1a
space following task checkbox
May 4, 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
28 changes: 26 additions & 2 deletions lib/marked.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,9 @@ Lexer.prototype.token = function(src, top) {
i,
tag,
l,
isordered;
isordered,
istask,
ischecked;

while (src) {
// newline
Expand Down Expand Up @@ -363,10 +365,20 @@ Lexer.prototype.token = function(src, top) {
if (!loose) loose = next;
}

// Check for task list items
istask = /^\[[ xX]\]/.test(item);
Copy link
Member

Choose a reason for hiding this comment

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

a space seems to be required after [ ] other wise it is rendered like text

with space:

  • test

without space:

  • [x]test

Copy link
Author

Choose a reason for hiding this comment

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

I'll add this space to the pattern, along with the corresponding change below.

ischecked = undefined;
if (istask) {
ischecked = item[1] !== ' ';
item = item.replace(/^\[[ xX]\] */, '');
Copy link
Member

Choose a reason for hiding this comment

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

- /^\[[ xX]\] */
+ /^\[[ xX]\] +/

since at least one space is required

}

this.tokens.push({
type: loose
? 'loose_item_start'
: 'list_item_start'
: 'list_item_start',
task: istask,
checked: ischecked
});

// Recurse.
Expand Down Expand Up @@ -927,6 +939,14 @@ Renderer.prototype.listitem = function(text) {
return '<li>' + text + '</li>\n';
};

Renderer.prototype.checkbox = function(checked) {
return '<input '
+ (checked ? 'checked="" ' : '')
+ 'disabled="" type="checkbox"'
+ (this.options.xhtml ? ' /' : '')
+ '>';
Copy link
Member

Choose a reason for hiding this comment

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

from the specs it looks like there should be a space after >

}

Renderer.prototype.paragraph = function(text) {
return '<p>' + text + '</p>\n';
};
Expand Down Expand Up @@ -1198,6 +1218,10 @@ Parser.prototype.tok = function() {
case 'list_item_start': {
body = '';

if (this.token.task) {
body += this.renderer.checkbox(this.token.checked);
}

while (this.next().type !== 'list_item_end') {
body += this.token.type === 'text'
? this.parseText()
Expand Down
5 changes: 3 additions & 2 deletions test/specs/gfm/gfm-spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Messenger.prototype.test = function(spec, section, ignore) {
var shouldFail = ~ignore.indexOf(spec.example);
it('should ' + (shouldFail ? 'fail' : 'pass') + ' example ' + spec.example, function() {
var expected = spec.html;
var actual = marked(spec.markdown, { headerIds: false, xhtml: true });
var usexhtml = typeof spec.xhtml === 'boolean' ? spec.xhtml : true;
var actual = marked(spec.markdown, { headerIds: false, xhtml: usexhtml });
Copy link
Member

Choose a reason for hiding this comment

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

It looks like just setting the xhtml option to false for all gfm the tests works

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 CommonMark uses XHTML maybe the GFM extensions don't need XHTML. (I do think there's something to be said for the attempted solution - putting the options in the JSON - but not sure we've hit a point of actually needing it.)

Copy link
Author

Choose a reason for hiding this comment

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

I'll just turn off xhtml altogether for gfm tests, and remove this spec property.

since(messenger.message(spec, expected, actual)).expect(
htmlDiffer.isEqual(expected, actual)
).toEqual(!shouldFail);
Expand All @@ -42,7 +43,7 @@ describe('GFM 0.28 Tables', function() {
describe('GFM 0.28 Task list items', function() {
var section = 'Task list items';

var shouldPassButFails = [272, 273];
var shouldPassButFails = [];

var willNotBeAttemptedByCoreTeam = [];

Expand Down
6 changes: 4 additions & 2 deletions test/specs/gfm/gfm.0.28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,15 @@
"section": "Task list items",
"html": "<ul>\n<li><input disabled=\"\" type=\"checkbox\"> foo</li>\n<li><input checked=\"\" disabled=\"\" type=\"checkbox\"> bar</li>\n</ul>",
"markdown": "- [ ] foo\n- [x] bar",
"example": 272
"example": 272,
"xhtml": false
},
{
"section": "Task list items",
"html": "<ul>\n<li><input checked=\"\" disabled=\"\" type=\"checkbox\"> foo\n<ul>\n<li><input disabled=\"\" type=\"checkbox\"> bar</li>\n<li><input checked=\"\" disabled=\"\" type=\"checkbox\"> baz</li>\n</ul>\n</li>\n<li><input disabled=\"\" type=\"checkbox\"> bim</li>\n</ul>",
"markdown": "- [x] foo\n - [ ] bar\n - [x] baz\n- [ ] bim",
"example": 273
"example": 273,
"xhtml": false
},
{
"section": "Strikethrough",
Expand Down