Escaped single quotes are not properly handled

[sdepold]

The added test demonstrates an improper handling of escaped single quotes. Will see if I can get this fixed somehow.

If the line is changed from

throw new Error('Something hasn\'t been defined.');

to

throw new Error('Something has not been defined.');

it will work.

[sdepold]

Apparently related to #149

[shellscape]

@tj please put some eyes on this one :)

[Twipped]

I think you meant me ;) i'll try to take a look at it this week.

On Oct 13, 2015, at 11:06 AM, Andrew Powell [email protected] wrote:

@tj please put some eyes on this one :)

—
Reply to this email directly or view it on GitHub.

[shellscape]

@ChiperSoft thanks much!

[martindsouza]

@tj @shellscape @ChiperSoft I'm having the same issue as marked in this ticket: OraOpenSource/plsql-md-doc#21

It's due to single and double quote escaping in dox.js: } else if (!withinSingle && !withinMultiline && ('\'' == js[i] || '"' == js[i])) { Given how the files are parsed, I don't see how to get around it elegantly.

What do you think about providing an option called escapeQuotes which would default to true. Then change the above line to also include ... && escapeQuotes This would give the caller the option to disable this feature. It would then expose them to the risk of having /** in a quoted string triggering the multiLine mode however in most cases I think that's less likely than having an escaped single quote as @sdepold demonstrate above.

This suggestion is slightly different than @sdepold as it can handle for multiple languages. Oracle for instance, uses something called the q function to escape single quotes. Ex: q'! quote's!' would result in the string quote's. This can be very difficult to detect since the q function's escape character can be anything (in the example I provided I used ! but anything would do).

If you're ok with this I don't mind submitting the PR with this change.

_Note: could also call the parameter enableWithinString to match the variable. _