search

josh-berry / magic-reflow

Atom package to reflow/rewrap text in a variety of situations (paragraphs, comments, bulleted/numbered lists, etc.)
MIT License
5 stars 1 forks source link

Add options to choose text-wrapping styles #3

Open audreytoskin opened 7 years ago

audreytoskin commented 7 years ago

By default, Magic Reflow will wrap Markdown list items with a hanging indent of two or more spaces. I personally like this, even though I generally use tabs for block indentation. However, it occurs to me other users might prefer to also use tabs for hanging indentation, or no hanging indent at all.

Similarly for Markdown blockquotes: Some users will prefer to put the right angle brackets (>) at the beginning of each line, others may prefer to only put the angle bracket on the first line. Among users who only mark the first line of a blockquote, users might like to apply hanging indent, and others may not.

I also personally think Markdown hyperlinks are easier to read if you keep them as a single line, so when wrapping Markdown paragraphs, I often make an exception to the line length limit for links that include a long URL.

josh-berry commented 7 years ago

The blockquote thing (as you described in issue #2) is definitely a bug; I don't know that I've ever seen anyone wrap quotes by putting a > just at the beginning of the first line. Fortunately that should be an easy fix.

I think/hope I've addressed the spaces-vs.-tabs question in issue #2.

audreytoskin commented 7 years ago

I guess I don't know how common this is, but I usually just use a single > for a blockquote paragraph, because I find all those sharp angles a little distracting. I'm not the only one, though. I've seen at least a couple other projects that do single-angle-bracket-on-first-line-style blockquotes.

audreytoskin commented 7 years ago

There are several valid ways to format a Markdown blockquote (one angle bracket at the beginning of the paragraph or one at the beginning of each line? hanging indents or no? spaces or tabs or a mix?) and list items (hanging indents or no? spaces or tabs or a mix? for unordered lists, asterisks or hyphens?). This wiggle room means that people are going to make different decisions on their preferred formatting.

One or a few formatting styles might be more popular than others, but since it's all just a matter of taste, there won't ever be 100% consensus. So adding options might help.