idyll-lang/idyll

Insert em-dashes when there are three hyphens

Open

#748 opened on Oct 1, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (1,977 stars) (97 forks)batch import
CompilerGood First PRhelp wanted

Description

Is your feature request related to a problem? Please describe. It is common for CMSs to automatically replace three hyphens (e.g. ---) with an em-dash (—).

Describe the solution you'd like Similar to how Idyll will automatically insert smart quotes, it should also convert hyphens to em-dashes, possibly with an option for users to opt-in/out of this behavior.

This logic should be added to the compiler in the same spot the smartquote logic currently exists (https://github.com/idyll-lang/idyll/blob/master/packages/idyll-compiler/src/processors/post.js#L26-L32).

This can be added via a compiler plugin. It should be added to the list of default plugins; the smartquote plugin would be a good starting point to copy, as that also modifies an article's text.

Contributor guide

Tech stack
javascript
Domain
toolingcontent
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScriptFamiliarity with Node.jsUnderstanding of Idyll compiler structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The contributor should examine the smart quotes plugin at packages/idyll compiler/src/plugins/smart quotes.js as a template. Then create a new plugin to replace three consecutive hyphens ( ) with an em dash (—). Finally, add the new plugin to the list of default plugins in packages/idyll compiler/src/index.js around line 19-27. Ensure the plugin is optionally configurable as mentioned in the issue.