Add double-space alias for a preferred of 2

retextjs · Jun 7, 2019 · 6ecd0c8 · 6ecd0c8
1 parent 640dccb
commit 6ecd0c8
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/index.js b/index.js
@@ -25,6 +25,10 @@ function sentenceSpacing(options) {
     preferred = 0
   }
 
+  if (preferred === 'double-space') {
+    preferred = 2
+  }
+
   if (typeof preferred !== 'number') {
     throw new Error(
       "Expected `options.preferred` to be `'space'`, `'newline'`, or a `number`"

diff --git a/readme.md b/readme.md
@@ -81,7 +81,7 @@ Emit warnings when the spacing does not adhere to the preferred style.
 
 *   `0` (or `'newline'`) — Disallow spaces between sentences
 *   `1` (or `'space'`, default) — Allow only one space between sentences
-*   `2` — Allow only two spaces between sentences
+*   `2` (or `'double-space'`) — Allow only two spaces between sentences
 
 ### Messages
 

diff --git a/test.js b/test.js
@@ -15,7 +15,7 @@ var mixed = [
 test('sentenceSpacing(value[, size])', function(t) {
   var zero = [0, 'newline']
   var one = [null, 'space', 1]
-  var two = [2]
+  var two = [2, 'double-space']
 
   retext()
     .use(spacing, {preferred: 1})