#
+ ``` + + Commonmark output: + ``` + + ``` \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 486f9cd..f570b44 100644 --- a/package-lock.json +++ b/package-lock.json @@ -29,6 +29,7 @@ "grunt-endline": "^0.7.0", "grunt-eslint": "^24.0.0", "grunt-mocha-test": "^0.13.3", + "html-prettify": "^1.0.6", "karma": "^6.3.17", "karma-browserstack-launcher": "^1.6.0", "karma-chai": "^0.1.0", @@ -3271,6 +3272,12 @@ "node": ">=12" } }, + "node_modules/html-prettify": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/html-prettify/-/html-prettify-1.0.6.tgz", + "integrity": "sha512-a2e5NX3pjP1io0Up0d3JOr+tMwKy8IsT4JaMMLznXzuuqPlthnvNdKd3lesQpu37/XWiA28FvDYQU0w/RlAymA==", + "dev": true + }, "node_modules/htmlparser2": { "version": "3.8.3", "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-3.8.3.tgz", @@ -9249,6 +9256,12 @@ "whatwg-encoding": "^2.0.0" } }, + "html-prettify": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/html-prettify/-/html-prettify-1.0.6.tgz", + "integrity": "sha512-a2e5NX3pjP1io0Up0d3JOr+tMwKy8IsT4JaMMLznXzuuqPlthnvNdKd3lesQpu37/XWiA28FvDYQU0w/RlAymA==", + "dev": true + }, "htmlparser2": { "version": "3.8.3", "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-3.8.3.tgz", diff --git a/package.json b/package.json index 0be0b6f..161580f 100644 --- a/package.json +++ b/package.json @@ -60,6 +60,7 @@ "grunt-endline": "^0.7.0", "grunt-eslint": "^24.0.0", "grunt-mocha-test": "^0.13.3", + "html-prettify": "^1.0.6", "karma": "^6.3.17", "karma-browserstack-launcher": "^1.6.0", "karma-chai": "^0.1.0", diff --git a/src/converter.js b/src/converter.js index cdf2e0d..57f35fe 100644 --- a/src/converter.js +++ b/src/converter.js @@ -303,7 +303,8 @@ showdown.Converter = function (converterOptions) { text = '\n\n' + text + '\n\n'; // detab - text = showdown.subParser('makehtml.detab')(text, options, globals); + //text = showdown.subParser('makehtml.detab')(text, options, globals); + text = showdown.helper.normalizeLeadingTabs(text); /** * Strip any lines consisting only of spaces and tabs. diff --git a/src/helpers.js b/src/helpers.js index 14d8d59..4898e1b 100644 --- a/src/helpers.js +++ b/src/helpers.js @@ -705,6 +705,14 @@ showdown.helper._populateAttributes = function (attributes) { return text; }; +showdown.helper.normalizeLeadingTabs = function (text) { + // 1. (1 to 3 spaces followed by a tab at the start of the line) becomes (1 tab) + text = text.replace(/^ {1,3}\t/gm, '\t'); + + // 2. + return text; +}; + /** * Remove one level of line-leading tabs or spaces * @param {string} text diff --git a/src/showdown.js b/src/showdown.js index a361b93..0a6cd8b 100644 --- a/src/showdown.js +++ b/src/showdown.js @@ -30,21 +30,9 @@ var showdown = {}, noHeaderId: true, ghCodeBlocks: false }, - ghost: { - omitExtraWLInCodeBlocks: true, - parseImgDimensions: true, - simplifiedAutoLink: true, - literalMidWordUnderscores: true, - strikethrough: true, - tables: true, - tablesHeaderId: true, - ghCodeBlocks: true, - tasklists: true, - smoothLivePreview: true, - simpleLineBreaks: true, - requireSpaceBeforeHeadingText: true, - ghMentions: false, - encodeEmails: true + commonmark: { + noHeaderId: true, + requireSpaceBeforeHeadingText: true }, vanilla: getDefaultOpts(true), allOn: allOptionsOn() diff --git a/src/subParsers/makehtml/codeBlock.js b/src/subParsers/makehtml/codeBlock.js index c8cc24a..3b49d05 100644 --- a/src/subParsers/makehtml/codeBlock.js +++ b/src/subParsers/makehtml/codeBlock.js @@ -23,7 +23,7 @@ showdown.subParser('makehtml.codeBlock', function (text, options, globals) { // sentinel workarounds for lack of \A and \Z, safari\khtml bug text += '¨0'; - let pattern = /(?:\n\n|^)((?:(?:[ ]{4}|\t).*\n+)+)(\n*[ ]{0,3}[^ \t\n]|(?=¨0))/g; + let pattern = /(?:\n\n|^)((?:(?: {4}|\t).*\n+)+)(\n* {0,3}[^ \t\n]|(?=¨0))/g; text = text.replace(pattern, function (wholeMatch, m1, m2) { let codeblock = m1, nextChar = m2, @@ -55,7 +55,7 @@ showdown.subParser('makehtml.codeBlock', function (text, options, globals) { codeblock = captureStartEvent.matches.codeblock; codeblock = showdown.helper.outdent(codeblock); codeblock = showdown.subParser('makehtml.encodeCode')(codeblock, options, globals); - codeblock = showdown.subParser('makehtml.detab')(codeblock, options, globals); + //codeblock = showdown.subParser('makehtml.detab')(codeblock, options, globals); codeblock = codeblock.replace(/^\n+/g, ''); // trim leading newlines codeblock = codeblock.replace(/\n+$/g, ''); // trim trailing newlines attributes = captureStartEvent.attributes; diff --git a/src/subParsers/makehtml/detab.js b/src/subParsers/makehtml/detab.js index be16e37..aa9f4b8 100644 --- a/src/subParsers/makehtml/detab.js +++ b/src/subParsers/makehtml/detab.js @@ -12,6 +12,7 @@ showdown.subParser('makehtml.detab', function (text, options, globals) { 'use strict'; + return text; let startEvent = new showdown.Event('makehtml.detab.onStart', text); startEvent .setOutput(text) diff --git a/src/subParsers/makehtml/githubCodeBlock.js b/src/subParsers/makehtml/githubCodeBlock.js index 7a98a66..4833c11 100644 --- a/src/subParsers/makehtml/githubCodeBlock.js +++ b/src/subParsers/makehtml/githubCodeBlock.js @@ -68,7 +68,7 @@ showdown.subParser('makehtml.githubCodeBlock', function (text, options, globals) let lang = infostring.trim().split(' ')[0]; codeblock = captureStartEvent.matches.codeblock; codeblock = showdown.subParser('makehtml.encodeCode')(codeblock, options, globals); - codeblock = showdown.subParser('makehtml.detab')(codeblock, options, globals); + //codeblock = showdown.subParser('makehtml.detab')(codeblock, options, globals); codeblock = codeblock .replace(/^\n+/g, '') // trim leading newlines .replace(/\n+$/g, ''); // trim trailing whitespace diff --git a/src/subParsers/makehtml/heading.js b/src/subParsers/makehtml/heading.js index 9ca040e..69cf5cd 100644 --- a/src/subParsers/makehtml/heading.js +++ b/src/subParsers/makehtml/heading.js @@ -73,16 +73,18 @@ showdown.subParser('makehtml.heading', function (text, options, globals) { startEvent = globals.converter.dispatch(startEvent); text = startEvent.output; - let setextRegexH1 = (options.smoothLivePreview) ? /^(.+)[ \t]*\n={2,}[ \t]*\n+/gm : /^(.+)[ \t]*\n=+[ \t]*\n+/gm, - setextRegexH2 = (options.smoothLivePreview) ? /^(.+)[ \t]*\n-{2,}[ \t]*\n+/gm : /^(.+)[ \t]*\n-+[ \t]*\n+/gm, - atxRegex = (options.requireSpaceBeforeHeadingText) ? /^(#{1,6})[ \t]+(.+?)[ \t]*#*\n+/gm : /^(#{1,6})[ \t]*(.+?)[ \t]*#*\n+/gm; + let setextRegexH1 = (options.smoothLivePreview) ? /^(.+[ \t]*\n)(.+[ \t]*\n)?(.+[ \t]*\n)?={2,}[ \t]*\n+/gm : /^( {0,3}[^ \t\n].+[ \t]*\n)(.+[ \t]*\n)?(.+[ \t]*\n)? {0,3}=+[ \t]*$/gm, + setextRegexH2 = (options.smoothLivePreview) ? /^(.+[ \t]*\n)(.+[ \t]*\n)?(.+[ \t]*\n)?-{2,}[ \t]*\n+/gm : /^( {0,3}[^ \t\n].+[ \t]*\n)(.+[ \t]*\n)?(.+[ \t]*\n)? {0,3}-+[ \t]*$/gm, + atxRegex = (options.requireSpaceBeforeHeadingText) ? /^ {0,3}(#{1,6})[ \t]+(.+?)(?:[ \t]+#+)?[ \t]*$/gm : /^ {0,3}(#{1,6})[ \t]*(.+?)[ \t]*#*[ \t]*$/gm; - text = text.replace(setextRegexH1, function (wholeMatch, headingText) { + text = text.replace(setextRegexH1, function (wholeMatch, line1, line2, line3) { + let headingText = line1.trim() + ((line2) ? '\n' + line2.trim() : '') + ((line3) ? '\n' + line3.trim() : ''); let id = (options.noHeaderId) ? null : showdown.subParser('makehtml.heading.id')(headingText, options, globals); return parseHeader(setextRegexH1, wholeMatch, headingText, options.headerLevelStart, id); }); - text = text.replace(setextRegexH2, function (wholeMatch, headingText) { + text = text.replace(setextRegexH2, function (wholeMatch, line1, line2, line3) { + let headingText = line1.trim() + ((line2) ? '\n' + line2.trim() : '') + ((line3) ? '\n' + line3.trim() : ''); let id = (options.noHeaderId) ? null : showdown.subParser('makehtml.heading.id')(headingText, options, globals); return parseHeader(setextRegexH2, wholeMatch, headingText, options.headerLevelStart + 1, id); }); @@ -154,7 +156,7 @@ showdown.subParser('makehtml.heading.id', function (m, options, globals) { .toLowerCase(); } else { title = title - .replace(/[^\w]/g, '') + .replace(/\W/g, '') .toLowerCase(); } diff --git a/src/subParsers/makehtml/paragraphs.js b/src/subParsers/makehtml/paragraphs.js index 1792ff8..1950b25 100644 --- a/src/subParsers/makehtml/paragraphs.js +++ b/src/subParsers/makehtml/paragraphs.js @@ -15,7 +15,7 @@ showdown.subParser('makehtml.paragraphs', function (text, options, globals) { for (var i = 0; i < end; i++) { var str = grafs[i]; // if this is an HTML marker, copy it - if (str.search(/¨(K|G)(\d+)\1/g) >= 0) { + if (str.search(/¨([KG])(\d+)\1/g) >= 0) { grafsOut.push(str); // test for presence of characters to prevent empty lines being parsed diff --git a/test/functional/makehtml/cases/features/underline/fulltext.html b/test/functional/makehtml/cases/features/underline/fulltext.html index 22fb5e2..7e6e03d 100644 --- a/test/functional/makehtml/cases/features/underline/fulltext.html +++ b/test/functional/makehtml/cases/features/underline/fulltext.html @@ -104,11 +104,11 @@ ___triple underscores___###### Heading 6You can also create Setext-style headings which have two levels.
- Level 1 markup use an equal sign = (equal sign)
==============================
Level 2 markup uses - (dashes)
-------------
# This is an H1
\ No newline at end of file +This is a paragraph with 1 trailing tab.
\ No newline at end of file +This is a paragraph with 1 trailing tab.
\ No newline at end of file diff --git a/test/functional/makehtml/extra.testsuite.commonmark.js b/test/functional/makehtml/extra.testsuite.commonmark.js index 67a03b3..3c8fe75 100644 --- a/test/functional/makehtml/extra.testsuite.commonmark.js +++ b/test/functional/makehtml/extra.testsuite.commonmark.js @@ -3,19 +3,35 @@ */ // jshint ignore: start -var bootstrap = require('./makehtml.bootstrap.js'), - converter = new bootstrap.showdown.Converter(), +let bootstrap = require('./makehtml.bootstrap.js'), + converter = new bootstrap.showdown.Converter({ + noHeaderId: true, + requireSpaceBeforeHeadingText: true + }), assertion = bootstrap.assertion, testsuite = bootstrap.getJsonTestSuite('test/functional/makehtml/cases/commonmark.testsuite.json'); describe('makeHtml() commonmark testsuite', function () { 'use strict'; - for (var section in testsuite) { + for (let section in testsuite) { if (testsuite.hasOwnProperty(section)) { describe(section, function () { - for (var i = 0; i < testsuite[section].length; ++i) { - it(testsuite[section][i].name, assertion(testsuite[section][i], converter)); + for (let i = 0; i < testsuite[section].length; ++i) { + let name = testsuite[section][i].name; + switch (name) { + case 'ATX headings_79': // empty headings don't make sense + case 'Setext headings_92': // lazy continuation is needed for compatibility + case 'Setext headings_93': // lazy continuation is needed for compatibility + case 'Setext headings_94': // lazy continuation is needed for compatibility + continue; + } + + + if (testsuite[section][i].name === 'ATX headings_79') { + continue; + } + it(name, assertion(testsuite[section][i], converter, true)); } }); } diff --git a/test/functional/makehtml/makehtml.bootstrap.js b/test/functional/makehtml/makehtml.bootstrap.js index c60c190..17129d5 100644 --- a/test/functional/makehtml/makehtml.bootstrap.js +++ b/test/functional/makehtml/makehtml.bootstrap.js @@ -8,6 +8,7 @@ require('source-map-support').install(); require('chai').should(); + const htmlPrettify = require('html-prettify'); let fs = require('fs'); function getTestSuite (dir) { @@ -52,7 +53,13 @@ let section = jsonArray[i].section; let name = jsonArray[i].section + '_' + (jsonArray[i].example || jsonArray[i].number); let md = jsonArray[i].markdown; + // transformations + md = md.replace(/→/g, '\t'); // replace → with tabs + let html = jsonArray[i].html; + // transformations + html = html.replace(/→/g, '\t'); // replace → with tabs + if (!tcObj.hasOwnProperty(section)) { tcObj[section] = []; } @@ -67,10 +74,15 @@ } - function assertion (testCase, converter) { + function assertion (testCase, converter, prettify) { + prettify = prettify || false; return function () { testCase.actual = converter.makeHtml(testCase.input); - testCase = normalize(testCase); + // transformations for readability + //testCase.expected = testCase.expected.replace(/\t/g, '→'); + //testCase.actual = testCase.actual.replace(/\t/g, '→'); + + testCase = normalize(testCase, prettify); // Compare testCase.actual.should.equal(testCase.expected, testCase.file); @@ -78,7 +90,7 @@ } //Normalize input/output - function normalize (testCase) { + function normalize (testCase, prettify) { // Normalize line returns testCase.expected = testCase.expected.replace(/(\r\n)|\n|\r/g, '\n'); @@ -96,9 +108,12 @@ testCase.expected = testCase.expected.trim(); testCase.actual = testCase.actual.trim(); - //Beautify - //testCase.expected = beautify(testCase.expected, beauOptions); - //testCase.actual = beautify(testCase.actual, beauOptions); + //prettify + if (prettify) { + testCase.expected = htmlPrettify(testCase.expected); + testCase.actual = htmlPrettify(testCase.actual); + } + // Normalize line returns testCase.expected = testCase.expected.replace(/(\r\n)|\n|\r/g, '\n');