feat: Add space-dollar option (#259)

Author: taoky

README.md

@@ -214,6 +214,8 @@ rules:
   space-backticks: 1
   # Add space between dash `-`
   space-dash: 0
+  # Add space between dollar $ when near the CJK.
+  space-dollar: 0
   # Convert to fullwidth.
   fullwidth: 1
   # To remove space near the fullwidth.

autocorrect-website/public/schema.json

@@ -44,6 +44,11 @@
           "default": 0,
           "$ref": "#/definitions/SeverityMode"
         },
+        "space-dollar": {
+          "description": "Add space between dollar $ when near the CJK.",
+          "default": 0,
+          "$ref": "#/definitions/SeverityMode"
+        },
         "fullwidth": {
           "description": "Convert to fullwidth.",
           "default": 1,

autocorrect-website/src/docs/usage.md

@@ -139,6 +139,8 @@ rules:
   space-backticks: 1
   # Add space between dash `-`
   space-dash: 0
+  # Add space between dollar $ when near the CJK.
+  space-dollar: 0
   # Convert to fullwidth.
   fullwidth: 1
   # To remove space near the fullwidth.

autocorrect/.autocorrectrc.default

@@ -11,6 +11,8 @@ rules:
   space-backticks: 1
   # Add space between dash `-`
   space-dash: 1
+  # Add space between dollar $ when near the CJK.
+  space-dollar: 0
   # Convert to fullwidth.
   fullwidth: 1
   # To remove space near the fullwidth punctuations.

autocorrect/src/config/mod.rs

@@ -197,11 +197,11 @@ impl Config {
 }
 
 // Setup config for test for load tests/.autocorrectrc.test
-static STEUP_ONCE: std::sync::Once = std::sync::Once::new();
+static SETUP_ONCE: std::sync::Once = std::sync::Once::new();
 
 #[allow(unused)]
 pub(crate) fn setup_test() {
-    STEUP_ONCE.call_once(|| {
+    SETUP_ONCE.call_once(|| {
         let config_str = include_str!(concat!(
             env!("CARGO_MANIFEST_DIR"),
             "/tests/.autocorrectrc.test"
@@ -345,6 +345,7 @@ mod tests {
             match k.as_str() {
                 "spellcheck" => assert_eq!(SeverityMode::Warning, v),
                 "space-dash" => assert_eq!(SeverityMode::Error, v),
+                "space-dollar" => assert_eq!(SeverityMode::Off, v),
                 _ => assert_eq!(SeverityMode::Error, v),
             }
         }

autocorrect/src/rule/mod.rs

@@ -27,6 +27,8 @@ lazy_static! {
         Rule::new("space-dash", word::format_space_dash),
         // Rule: space-backticks
         Rule::new("space-backticks", word::format_space_backticks),
+        // Rule: space-dollar
+        Rule::new("space-dollar", word::format_space_dollar),
         // Rule: fullwidth
         Rule::new("fullwidth", fullwidth::format),
     ];
@@ -206,6 +208,7 @@ mod tests {
             "space-bracket",
             "space-dash",
             "space-backticks",
+            "space-dollar",
             "fullwidth",
             "halfwidth-word",
             "halfwidth-punctuation",
@@ -287,6 +290,8 @@ mod tests {
             "2你好[世界]" => (map!{ "space-bracket" => true }, "2 你好[世界]"),
             "代码`code`例子1" => (map!{}, "代码 `code` 例子 1"),
             "代码`code`例子2" => (map!{ "space-backticks" => true }, "代码`code`例子 2"),
+            "变量$x$表示了" => (map!{}, "变量 $x$ 表示了"),
+            "变量$x$表示了" => (map!{ "space-dollar" => true}, "变量$x$表示了"),
             "测试 ，" => (map!{}, "测试，"),
             "测试 ，" => (map!{"no-space-fullwidth"=>true}, "测试 ，"),
         };

autocorrect/src/rule/word.rs

@@ -46,6 +46,12 @@ lazy_static! {
         Strategery::new(r"[\p{CJK_N}\s）】」”’》][\-]", r"[\p{CJK_N}“‘]"),
     ];
 
+    static ref DOLLAR_STRATEGIES: Vec<Strategery> = vec![
+        // Add space before and after dollar $ near the CJK
+        Strategery::new(r"\p{CJK}", r"\$"),
+        Strategery::new(r"\$", r"\p{CJK}"),
+    ];
+
     static ref NO_SPACE_FULLWIDTH_STRATEGIES: Vec<Strategery> = vec![
         // FullwidthPunctuation remove space case, Fullwidth can safe to remove spaces
         Strategery::new(r"\w|\p{CJK}|`", r"[，。、！？：；（）「」《》【】]").with_remove_space().with_reverse(),
@@ -102,6 +108,16 @@ pub fn format_space_backticks(input: &str) -> Cow<str> {
         })
 }
 
+pub fn format_space_dollar(input: &str) -> Cow<str> {
+    DOLLAR_STRATEGIES
+        .iter()
+        .fold(Cow::Borrowed(input), |text, strategy| match text {
+            Cow::Borrowed(s) => strategy.format(s),
+            Cow::Owned(s) => Cow::Owned(strategy.format(&s).into_owned()),
+        },
+    )
+}
+
 pub fn format_no_space_fullwidth(input: &str) -> Cow<str> {
     if !CJK_RE.is_match(input) {
         return Cow::Borrowed(input);
@@ -130,7 +146,7 @@ pub fn format_no_space_fullwidth_quote(input: &str) -> Cow<str> {
 
 #[cfg(test)]
 mod tests {
-    use crate::rule::word::{format_space_backticks, format_space_bracket, format_space_dash};
+    use crate::rule::word::{format_space_backticks, format_space_bracket, format_space_dash, format_space_dollar};
 
     #[test]
     fn test_format_space_dash() {
@@ -167,4 +183,26 @@ mod tests {
         assert_eq!(format_space_backticks("`代码第1行"), "`代码第1行");
         assert_eq!(format_space_backticks("代码第2行`"), "代码第2行`");
     }
+
+    #[test]
+    fn test_format_space_dollar() {
+        assert_eq!(format_space_dollar("你好$世界"), "你好 $ 世界");
+        assert_eq!(format_space_dollar("hello$世界"), "hello$ 世界");
+        assert_eq!(format_space_dollar("你好$world"), "你好 $world");
+        assert_eq!(format_space_dollar("你好$x$世界"), "你好 $x$ 世界");
+        assert_eq!(format_space_dollar("变量 $x$ 代表"), "变量 $x$ 代表");
+        assert_eq!(format_space_dollar("令$x^2+y^2=z^2$，可得"), "令 $x^2+y^2=z^2$，可得");
+        assert_eq!(format_space_dollar("这是一个例子：$E=mc^2$。"), "这是一个例子：$E=mc^2$。");
+        assert_eq!(format_space_dollar("$x+y$是方程"), "$x+y$ 是方程");
+        assert_eq!(format_space_dollar("方程为$x+y=1$"), "方程为 $x+y=1$");
+        assert_eq!(format_space_dollar("若$x>0$且$y<0$"), "若 $x>0$ 且 $y<0$");
+        assert_eq!(format_space_dollar("函数$f(x)$的极值"), "函数 $f(x)$ 的极值");
+        assert_eq!(format_space_dollar("变数$x$、$y$满足"), "变数 $x$、$y$ 满足");
+        assert_eq!(format_space_dollar("公式$$E=mc^2$$证明了"), "公式 $$E=mc^2$$ 证明了");
+        assert_eq!(format_space_dollar("矩阵$A=\\begin{bmatrix}1&0\\\\0&1\\end{bmatrix}$满足"), "矩阵 $A=\\begin{bmatrix}1&0\\\\0&1\\end{bmatrix}$ 满足");
+        assert_eq!(format_space_dollar("测试$x_1,x_2$以及$x_3$"), "测试 $x_1,x_2$ 以及 $x_3$");
+        assert_eq!(format_space_dollar("若$a>b$则有$c>d$"), "若 $a>b$ 则有 $c>d$");
+        assert_eq!(format_space_dollar("设$a,b∈\\mathbb{R}$且$a>b$"), "设 $a,b∈\\mathbb{R}$ 且 $a>b$");
+        assert_eq!(format_space_dollar("下式成立：$$f(x)=x^2$$"), "下式成立：$$f(x)=x^2$$");
+    }
 }