Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposed rule: enforce typography #51

Open
flodolo opened this issue Mar 17, 2017 · 5 comments
Open

Proposed rule: enforce typography #51

flodolo opened this issue Mar 17, 2017 · 5 comments
Labels

Comments

@flodolo
Copy link

flodolo commented Mar 17, 2017

Here's a few checks that I would like to have:

  • quotes: use proper “” instead of "".
  • apostrophes: use proper apostrophes instead of '.
  • punctuation_space: enforce one space after a punctuation symbol, unless it's followed by a new line.
  • double_spaces: no double spaces.

I think code should be excluded by default for all these checks.

For the first two, Atom has a really nice package that might be used as inspiration.

@DavidAnson
Copy link
Owner

Double spaces was already on my list. :) Punctuation space seems fine.

But quotes worries me. The package you link to changes normal quotes to smart ones - but emphasizes that you still type dumb quotes the easy way. markdownlint is not a transformer like that. I think nobody will want to have to type smart quotes every time in order to satisfy this rule. Or am I thinking about this part wrong?

@flodolo
Copy link
Author

flodolo commented Mar 17, 2017

I think nobody will want to have to type smart quotes every time in order to satisfy this rule. Or am I thinking about this part wrong?

Yes, you would either be writing the correct quotes directly, or use a package like the one above to make your life easier.

I realize that this might not be a useful rule for a lot of users, it sounds more like good material for a custom rule.

@DavidAnson
Copy link
Owner

It fits within the bigger idea of a typography rule, but maybe this part would default to "off". I like the idea to bundle these similar checks, though.

@CircleCode
Copy link

Please also note that these rules can depend on text language.
For example, in French

  • you would have to enforce a non breakable space before every double punctuation sign (; : !)
  • valid quotes are « and »

@kdeldycke
Copy link

Checks on properly balanced quotes and the way they terminates sentences is what I'n trying to achieve at: sindresorhus/awesome-lint#101 . Only managed to create a set of use-cases at the moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants