From 5d494c82027fbae127104ca581d350fdb857fdb7 Mon Sep 17 00:00:00 2001 From: Vladimir Vuksanovic Date: Fri, 4 Oct 2019 16:45:27 +0200 Subject: [PATCH] feature(ellipsis): Add option to disable ellipsis Add ability to disable ellipsis parser. This is needed for some use cases. See #634 Defaults to true to keep backwards compatibility. --- README.md | 2 ++ dist/showdown.js | Bin 173544 -> 173869 bytes dist/showdown.js.map | Bin 488985 -> 490089 bytes dist/showdown.min.js | Bin 81125 -> 81379 bytes dist/showdown.min.js.map | Bin 91924 -> 92115 bytes src/options.js | 5 ++++ src/subParsers/makehtml/ellipsis.js | 4 +++ .../cases/features/ellipsis/ellipsis.html | 20 +++++++++++++++ .../cases/features/ellipsis/ellipsis.md | 24 ++++++++++++++++++ .../makehtml/cases/standard/ellipsis.html | 1 + .../makehtml/cases/standard/ellipsis.md | 4 ++- .../functional/makehtml/testsuite.features.js | 11 ++++++++ 12 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 test/functional/makehtml/cases/features/ellipsis/ellipsis.html create mode 100644 test/functional/makehtml/cases/features/ellipsis/ellipsis.md diff --git a/README.md b/README.md index 4c6008a..bf5faa5 100644 --- a/README.md +++ b/README.md @@ -348,6 +348,8 @@ var defaultOptions = showdown.getDefaultOptions(); * **underline**: (boolean) [default false] ***EXPERIMENTAL FEATURE*** Enable support for underline. Syntax is **double** or **triple** **underscores** ex: `__underlined word__`. With this option enabled, underscores are no longer parses into `` and ``. + * **ellipsis**: (boolean) [default true] Replaces three dots with the ellipsis unicode character. + * **completeHTMLDocument**: (boolean) [default false] Outputs a complete html document, including ``, `` and `` tags' instead of an HTML fragment. (since v.1.8.5) diff --git a/dist/showdown.js b/dist/showdown.js index 36c74cd802fbe1595b2e6bacaae1c6faa19313ce..aa9299bbbc31354d6c3530fd33d8b61875ddf8d4 100644 GIT binary patch delta 982 zcmX|8OGs2<6y_WqXS@?WF{QMAH1q8pANd$_@X>=&F)`5u&Bu6k?x=I8xp$a_*u!X% z5F}Rrt_Nfg)FNH{P>a%CMHZyCN`)3h5xU7uAYJGG6aK|_zVn@PzH|N`@1^I<((R*% z9OXqNj-paWNj1rrrQG3=-(#qnKR0h;wl+2WMb~>X zZ%|RlkY?y4tQuZ3R)`SlB;;2;+K@s#-htqN$54U`iOB`g3$>~5vKMT%(;sO{EXr)@ z0Q6WWB;gVIFa<2EAqjRY)YT6*R-Xn<5ol$z8E`O$v-4SS%*NqH0c=F^+OIM++$)8+ z7;cmPZiFV<;(#v^<&}<5&`*?c&8Lz*PdZWkhQJ@%%oRg}#U5>3*1cMINDKRY`aYDy>ZmH8-kY)4QkMQ}iuDj}YlI}WSOVF| zoo|&vS`>!~mGDZy6(@8GSmuJ_XfE(IfZZxClnxTR?}jPhsk~&D{#S zz{%}QGxoQ^Cp*`l?SY^*0;yS=$Ub|ZPaN<;oGI-dfm;b&x)p{Z;U#+lw0Pby;R(dE zrD<4}*vwtHQO8o(Acu(NJJ2nD?&)8+5ZTm9>lz`GUQPr%tJno=EOS|LO}Nj9#cwud ze*LB(ekS8pzA3wT7^TF>Og3MLapDwj9axRD-ievi*MxTFD8ug%i7kUcWnh#_PAs$& z(&NvmktXwMB(8Oyz*UY)E3hkq*s}`s@lx9BMk}kU!Z{J!oLI%oA$C5BX(usPz?UxE z7VtwoP9jQTL|r*rm~jeM?UXcQ3=RhA>sE9KTZ`u~o4VUD#9eH-QDVQ^&=3Qs+VKu| zRec^W3398|bhXlf9-xmdVh-!;#CjVu;k5{n#m@92wXk&sue;dbW9$X`W)6>o^be*K BE+hZ| delta 752 zcmX|7T}YE*6y_Y;KK;h0wS`Mq+t;kMhGXBRZkA|i22o+ST0+d)w6eM|f`rJlAPPwe zq3BJhi!Le>gGA!oNJL!}1!)&r5UYzWD!eFfyy=I|>-O&Id7pEh^PKZOkKgIv-|C}2 zPpmE+wZbtg+F*tvh8{fD-`8{I#HqgErUB!|jN3Dr`s|!~?b23&F*W0Uvw>l(>FNv^ z;%OO1C}}|2#$??d@QO$!*yz0zmbgN%)<9BXl^5398RP4rrj)U}2ELW3iCzm@Mb~)< z3oQyC@}_r%`2g%R7y}=&{!Sg3tf%P&yp(vM5e`YrHA9?_BG-0sX?Z_C?c4>!z{T0! z@Rx_>S$_K24t7PvNC)Vmx(yP-cNA)gX~w|=3u!nfU3jpHhK|7D!ihd%Re(k%$Kl#a zmW`f;df8#Dq)!8ot;jF&(!mkP>8wcHg3H?&r{`g#$@p~%vNDFYKajyvLyv?)x)~CS zCiq3U6CCvMA82JP_@d#wJe^}*;GC8drDsljA&VDR<8a}VUJ7_nU!@f7VJw$1q@&m( zKRH>C)%3g;7kNw)zlg?hPQ8N(>@2+LUII@l5rsG7gd*bi7Hm+eR3rXS4aziOu&~5W z<6H4pkxaMZAflm*C%j)+qiCb<9XRI@V;$J9ysRV+DK9a*4{xf*mHl|S*vRcgjm!hs vQ><8Nwj1xn7MaWPpSYrvJA)~uq3c<^Epra^;-zNBNB6NyHti2Fz<2!z|HjR# diff --git a/dist/showdown.js.map b/dist/showdown.js.map index 00aa3de48e279c994436552ae3fcaeba52cc9bfa..8395f884cc02eb4cedbcc5bfbd66b2a793e65c01 100644 GIT binary patch delta 710 zcmYL{Uq}>D6vmmkcV>1cb?0FS9EZ7J`96>+a-^t~_ zZ+wpDx{^w`mktW$lXLuP3H8l*VE!a>(T#lt(0K*r!GIeH^k=D;+6^L*DOMbtV@1f^ zL|zDlkVxfe57jzcY)yzV($M6u%2}R~htjf@mYLjFbo8DFUff3_tc_p}0$-fBSw3uZ zqebw&L1l0WvCB*pCO$IxbiSSkz06UyGpw{F)Wo{zNHB-y-Oi`B$9r8uUOGM@f;7z* z!o}w-2cvH1cy^5~X5|naJiW`(IW~is>ftswYqh!2<3(s)L4|Ox0gKdbcTxY7a=7z} z*#Ub#I0M+d99=u(0V#kmWM&wg6KnLh1cNPgb-|`%uyB_x0O_4Gfh6Gz^zvE936EpI z5)!QkOQ`+e7{VS1EHfN!eTqS!Y-|nKTz)mYPxHCk__Z{D0@B~Oub>~{aa`%sdQ_4H7(`8&8ri%sIum4n zHpp?+Fo|}a7%5%XlBN><+fYklrl}jXvfSFl^#T+C delta 265 zcmV+k0rvjs^c|V(9k9#>v-Sq;A+yUV1_uK%Ohl7VM;ezvR00&2pt}MTmwHQ0W5-x5?fERWg^l5d`c4c1V{YSOON8fcygrx5yF% zZLo*W!vwd_!vz&Fmk`zkEtlN&1qqi=^#$dZ2has3mzvfFafitE1-Hod2Cfa49vue? Px8?)~I2^ZxAqVAHt=VNf diff --git a/dist/showdown.min.js b/dist/showdown.min.js index a298817d3e1de74330369cdeb6c6f228cf8c9c4a..2051edf436327a39caaa59f5ec1694fa77c9ba1a 100644 GIT binary patch delta 193 zcmaF*ljZSmmI-oP1}3_O2D(NDhL#&O+WFX1b8<2ZiZdsl;#M#ZN-fAqOinFUD9I>F zO;t$AFDX_i&n(FR@>3O{3X2s=^D>k3Q&JU@GZKpulS@*IHqYhTFonBF52nI?^1+2_ zlP@ghoLs%Qbn@wSGMhP4vx%f> TYPUKM0ay;V${hh1AOZ~v;j$Jz diff --git a/dist/showdown.min.js.map b/dist/showdown.min.js.map index 4889b775f5371ab74cbd48586ea35380bbf4a643..173bc46e977d012ae852a84213fc67966cf301ea 100644 GIT binary patch delta 1637 zcmY*ZZA@EL7|y8_+B#a0Z6Pqnn7EnrBrVVaHPP*y)7#P&))wdoW?*P-=q<2PN}YCC@w=~$pMGL6rDtd5`GQ;J9Tu4&H~zVxWGiZAj89u z)T{rOa1`!cVmLsglj2JP%lw;oJ6mB`A}mJWOVUn;)9@ogScZAUUVvdgAt4<`(q(-W zgghzYhdd!TDsV@_WzBd6E)5^%pfb-VIt>{wKbN@O7Q{}$M?^{`mf9xK&tD#IYn1ge zLxSzlEPsFe^CQa?M+g~R+|F2{MK6%)_Z|m{n1rVYBRU6BJc*XJkt@_GXsN3&TtYU7 z2=Zq{nLd(Z+> zQ_rqyCWYHkbA6NyCzpLZa{a6=PQv|CNsy3f!XqiqnjpOGhP82tf_yBYo9tBGHy#?z zP+E!vl0`pnzTB=3-uxb!GC`rjl%1cxi`DS0AB>g~#XXcru^u09{=G$|-#%xmp*}c$ z7nzragl#$M;&0#E^NgF}xk|%}cI)e9qC-Zr-MSYMIGv%;488&N_B|uAoOFqOHU~X+ z|90T{KuyJcmdQg4u@3OhkO~ou!+_CdBS2}seqb{EP_rmU8s#626#QY0Bfiiz;^PmY1(lDd4 zI=uOX!PHH`OBNeYIvUVR%4-O1SV42JqMEc%%Nx+ex*ARc+&VHt>la~GW6O%kjQ%jg zBLHj{=(4tHMq%rg(KAY{6?N5C+8eEC!)WzTEK}ki(jCq#h5hK372XmsLW(&Bbua(< zpM9F#fm#iZLnDC3@DNVBl{1~_uf|0&$kpP?+FJ+Fl{(9U9!+LwUJD;akvj9DkR^~T zL+@SoC>wUvW~qqFKwQy}8VGBsQ%-qN!(I>&uAdU-f>h!`@Q*pzJ8-@7>M_)=Q76Ln zEuJ7$#^5#3fkMt6<@G-F$kZDYEfvaZZ}y{3b3L2{aZovb1j3&`ik{Xk9!0NMpKyy; zh$V#&K|x@!M`?_p16nMEE}+V(wDVMh(?5-3)?uz>@zAg=l@&`IeP+orT%g3`8!2ix I}KY{x3H~;_u delta 1529 zcmZ8hZA@EL7|!YFyk()Fm59QaEMzm`WNo29`^V&*)7xw5W+{}mppXD-N`YFS?Py6f zF2*b~@z*iA#vh_Heq~uAxyf$g#}cv`GXgp%`!ObnF8XJF#>78vi|;uti2k|lIq&nH z^E}V{zUP~-tgn4({ph^KxM+z+Yi21SIf@x!Gt|jX#~l2b_=9#Y#r=c~i0!@!#v=m` z{%X9gu8ran;9U}5q?7zY+;?=A;SeDqhEEW3!Y}`;cmT5V3n5&5(i(FqlDSwMQVo61AOP0CIt&klQ#yxuJo40Ox$ z!#EufhVBpmQRM@H1^5*ZDuX%x_wY*XPC^NalBXGCedOxCU2lUVJjp!9`LSMv7Wm!q zX4Gypp8POooAF~8g(_x@wU13@e}sSyJ-YiCYUSH&&3xl>pLLM*7Xy58xr0w%vDf4& z*u@gEekJ3~mEWv3;4)5vV>yj~{Yj(o#>zTUoIOJJsF&Z|z{a`N8&=yXirXnsV=m*x z>k(xa@XpN*6v!VJmS$;tN4fEsXxRQqw{$uJo0)QBi>C6x@_*4OO8WDGF5}R*R#ZLh zk&TjpPCB;PQ11jd7~=5@{})tAJH?kboA~Qn4*tsK`*kxifn=z_bgldnlc5x zxM^FNL}d*q7=VsFyGfWT949J)QfN!0T8A|^;rjM)O#&R;cwkre%MW=zL~P&va#oR;r?L- z0!f&hl(BgK3yZQqp|mX4rO!TqPU_bYx@}*O<)|F)F)v%tdsVwQ6L8ze<^xtRld*z6 zWJAB$ro{xaIa)A#t5L6gr}%08g9g;PyE4}s&~2-|o8mMj+HqOstp0g3TD8Ng0o71r zB@JBm>oX2?(ERiedc<-7dIX$?SFg>ZZ?&M`Yv#ltSJ=&)w+^Gvs;WUHq?0L{HP0PI zkt*Aq@FzGnAApYa>75uoR&kgKhfm*enP)NjaUWl~aX^1Egc{9DE`;|xxdo0%l&1^YuC;$dN90v8gTo^t7{5%joO-;3Tw<*2$h nYC`l^tC(XLowRs7*d$HqSL5hnH9Su_N_>I7oOw2ZdTRdxDW%-8 diff --git a/src/options.js b/src/options.js index afefab0..db19fff 100644 --- a/src/options.js +++ b/src/options.js @@ -146,6 +146,11 @@ function getDefaultOpts (simple) { description: 'Enable support for underline. Syntax is double or triple underscores: `__underline word__`. With this option enabled, underscores no longer parses into `` and ``', type: 'boolean' }, + ellipsis: { + defaultValue: true, + description: 'Replaces three dots with the ellipsis unicode character', + type: 'boolean' + }, completeHTMLDocument: { defaultValue: false, description: 'Outputs a complete html document, including ``, `` and `` tags', diff --git a/src/subParsers/makehtml/ellipsis.js b/src/subParsers/makehtml/ellipsis.js index 68856a6..757fca0 100644 --- a/src/subParsers/makehtml/ellipsis.js +++ b/src/subParsers/makehtml/ellipsis.js @@ -1,6 +1,10 @@ showdown.subParser('makehtml.ellipsis', function (text, options, globals) { 'use strict'; + if (!options.ellipsis) { + return text; + } + text = globals.converter._dispatch('makehtml.ellipsis.before', text, options, globals).getText(); text = text.replace(/\.\.\./g, '…'); diff --git a/test/functional/makehtml/cases/features/ellipsis/ellipsis.html b/test/functional/makehtml/cases/features/ellipsis/ellipsis.html new file mode 100644 index 0000000..8edcf27 --- /dev/null +++ b/test/functional/makehtml/cases/features/ellipsis/ellipsis.html @@ -0,0 +1,20 @@ +

ellipsis in text...

+

…

+
    +
  1. foo...
    2. +
  2. bar
    3. +
+
+

ellipsis in blockquote...

+
+
ellipsis in code...
+
+
ellipsis in code...
+
+

ellipsis in header...

+

1...

+
    +
  1. ..
    2. +
+

1…

+

Link

\ No newline at end of file diff --git a/test/functional/makehtml/cases/features/ellipsis/ellipsis.md b/test/functional/makehtml/cases/features/ellipsis/ellipsis.md new file mode 100644 index 0000000..81023be --- /dev/null +++ b/test/functional/makehtml/cases/features/ellipsis/ellipsis.md @@ -0,0 +1,24 @@ +ellipsis in text... + +… + +1. foo... +2. bar + +> ellipsis in blockquote... + +``` +ellipsis in code... +``` + + ellipsis in code... + +# ellipsis in header... + +1... + +1. .. + +1… + +[Link](https://gitlab.com/gitlab-org/gitlab-ce/compare/v11.5.4...v11.5.5 "title") \ No newline at end of file diff --git a/test/functional/makehtml/cases/standard/ellipsis.html b/test/functional/makehtml/cases/standard/ellipsis.html index fd77939..5830164 100644 --- a/test/functional/makehtml/cases/standard/ellipsis.html +++ b/test/functional/makehtml/cases/standard/ellipsis.html @@ -17,3 +17,4 @@
  • ..

    • 1…

    +

    Link

    \ No newline at end of file diff --git a/test/functional/makehtml/cases/standard/ellipsis.md b/test/functional/makehtml/cases/standard/ellipsis.md index e790fb5..5b6aa98 100644 --- a/test/functional/makehtml/cases/standard/ellipsis.md +++ b/test/functional/makehtml/cases/standard/ellipsis.md @@ -19,4 +19,6 @@ ellipsis in code... 1. .. -1... \ No newline at end of file +1... + +[Link](https://gitlab.com/gitlab-org/gitlab-ce/compare/v11.5.4...v11.5.5 "title") \ No newline at end of file diff --git a/test/functional/makehtml/testsuite.features.js b/test/functional/makehtml/testsuite.features.js index 4affe1c..7510194 100644 --- a/test/functional/makehtml/testsuite.features.js +++ b/test/functional/makehtml/testsuite.features.js @@ -13,6 +13,7 @@ var bootstrap = require('./makehtml.bootstrap.js'), rawPrefixHeaderIdSuite = bootstrap.getTestSuite('test/functional/makehtml/cases/features/rawPrefixHeaderId/'), emojisSuite = bootstrap.getTestSuite('test/functional/makehtml/cases/features/emojis/'), underlineSuite = bootstrap.getTestSuite('test/functional/makehtml/cases/features/underline/'), + ellipsisSuite = bootstrap.getTestSuite('test/functional/makehtml/cases/features/ellipsis/'), literalMidWordUnderscoresSuite = bootstrap.getTestSuite('test/functional/makehtml/cases/features/literalMidWordUnderscores/'), //literalMidWordAsterisksSuite = bootstrap.getTestSuite('test/functional/makehtml/cases/features/literalMidWordAsterisks/'), completeHTMLOutputSuite = bootstrap.getTestSuite('test/functional/makehtml/cases/features/completeHTMLOutput/'), @@ -213,6 +214,16 @@ describe('makeHtml() features testsuite', function () { } }); + /** test ellipsis option **/ + describe('ellipsis option', function () { + var converter, + suite = ellipsisSuite; + for (var i = 0; i < suite.length; ++i) { + converter = new showdown.Converter({ellipsis: false}); + it(suite[i].name.replace(/-/g, ' '), assertion(suite[i], converter)); + } + }); + /** test literalMidWordUnderscores option **/ describe('literalMidWordUnderscores option', function () { var converter,