Support tabs and CRLF line endings

Question

Support tabs and CRLF line endings

Opened this issue 11 years ago · 23 comments

Answer 1 · 2013-10-24T13:58:46.000Z

+1
Apiary users are often facing this issue:

message: Cannot parse blueprint code 
description: The use of tab(s) '\\t' in source data isn't currently 
supported, please contact makers 
code: 2

Answer 2 · 2013-11-02T06:08:51.000Z

@zzen commented

+1

Answer 3 · 2013-11-13T22:08:43.000Z

@zdne commented

To fix this issues a moderate modification to https://github.com/apiaryio/sundown is needed.

Consider using Hoedown contributing to hoedown/hoedown#22 and hoedown/hoedown#28 instead

Answer 4 · 2014-09-24T10:51:52.000Z

@pksunkara commented

Can we make a hack for this by expanding all \t before parsing?

Answer 5 · 2014-09-26T12:16:59.000Z

@zdne commented

This won't not help as then you would need to recalculate the source maps (in order to display any possible warning / errors). Doing so (recalculating) is the core problem here and solving it would bring the solution for this issue (and thus it wouldn't be a hack)

Answer 6 · 2015-04-25T02:28:06.000Z

@ze-phyr-us commented

+1 for tabs! Any ETA on this?

Answer 7 · 2015-04-27T02:05:07.000Z

@zdne commented

@ze-phyr-us so far there wasn't too much of push on this one (read no concrete plans yet). Introducing this will most likely mean migration to Hoedown or CommonMark parser.

Answer 8 · 2016-01-13T17:09:29.000Z

@defaltd commented

Pinging for update @zdne

Answer 9 · 2016-01-14T13:02:24.000Z

@zdne commented

Hey @Stephn-R,
you are the first one to ask for this in a long time. I am afraid the status hasn't changed since apiaryio/snowcrash#29 (comment) we might migrate the parser but no ETA just yet.

Answer 10 · 2016-01-14T16:24:49.000Z

@defaltd commented

So lets rise this baby back from the dead 💀 ⚡

Answer 11 · 2016-01-25T03:39:36.000Z

@jacquesfu commented

So what's a workaround? I have codeblocks with tabs to show examples... will the codeblocks have to be converted to spaces I guess?

Answer 12 · 2016-01-25T03:45:47.000Z

@ze-phyr-us commented

@jacquesfu I'm just piping my blueprints through sed 's/ / /g' before feeding them to snowcrash.

Edit: GH screws up the formatting, but obviously that was s/<tab>/<4 spaces>/g

Answer 13 · 2016-01-26T13:34:42.000Z

@zdne commented

Hey guys, may I just ask you where you need the tabs? Is it the mock server or testing? I presume it is really about the content of payloads and not necessarily the blueprint itself, correct?

Answer 14 · 2016-01-26T14:41:12.000Z

@defaltd commented

Alright so the way I was able to resolve this was if I targeted the affected files and ran a python method for stripping out carriage returns >> \r

Answer 15 · 2016-01-27T03:05:08.000Z

@ze-phyr-us commented

@zdne Coding standards. When the entire project uses tabs rather than spaces, I want my documentation consistent with that.

Answer 16 · 2016-01-27T04:11:50.000Z

@defaltd commented

Agreed but this discussion is about the way line endings are formed by your IDE/System

Answer 17 · 2016-03-09T23:16:38.000Z

@lippea commented

This is not big problem, but quite annoying.
We also have problem that I removed all \t \r, committed to git, but others still have problem with \r after downloading the code again.

Answer 18 · 2016-08-08T20:11:17.000Z

@BigBlueHat commented

I just hit this issue because Windows. 😖 It's obviously possible to route around, but it's an unfortunate complication when trying to use API Blueprint docs with dredd, etc.

Remove pain. Win hearts and minds. 😄

👍 to fixing this soon.