Merge pull request #40 from hotoo/feat/date

hotoo · web-flow · commit 4806ac51a5d1 · 2022-01-21T22:19:15.000+08:00
Feat/date
diff --git a/README.md b/README.md
@@ -4,18 +4,49 @@
 
 它会将一些不规范，或不推荐的排版方式，在保存文件时进行自动格式化、规范化。
 
-![image](https://user-images.githubusercontent.com/143572/150163233-3697396a-e5ee-448c-ac5a-73188e02331f.png)
-
-
 ## 功能
 
 * 中英文字符间增加一个半角空白。
+* 特殊的，日期可以指定不添加空白。
 * 中文前后的半角标点转成全角标点。
 * 全角英文、数字转成半角字符。
 * 连续的句号自动转省略号。
 * 感叹号、问号最多允许连续重复 3 次。
 * 其他中文标点符号不允许重复出现。
 
+```diff
+- 中文和English之间要有空白.
++ 中文和 English 之间要有空白。
+
+  let g:pangu_rule_date = 0
+- 今天是 2022 年 1 月 21 日星期五。
++ 今天是2022年1月21日星期五。
+
+  let g:pangu_rule_date = 1
+- 今天是2022年1月21日星期五。
++ 今天是 2022年1月21日 星期五。
+
+- <世界观: 现代人必须要懂的科学哲学和科学史>这本书重建了我的科学观和世界观.
++ 《世界观：现代人必须要懂的科学哲学和科学史》这本书重建了我的科学观和世界观。
+
+- ０１２３４５６７８９
++ 0123456789
+
+- ＡＢＣＤＥＦＧ...ＸＹＺ
++ ABCDEFG...XYZ
+- ａｂｃｄｅｆｇ...ｘｙｚ
++ abcdefg...xyz
+
+- 真是太无语了。。。
++ 真是太无语了......
+
+- 苍天哪！！！！！这是怎么了？？？？？？
++ 苍天哪！！！这是怎么了？？？
+
+- 不小心多打了标点，，，和符号。。
++ 不小心多打了标点，和符号。
+```
+
 ## 支持的文件格式
 
 推荐在以下文件格式中使用：
@@ -25,21 +56,21 @@
 * Wiki (*.wiki)
 * Vim 中文文档 (*.cnx)
 
-如果想在其他格式的文件中使用这个功能，可以执行 `:Pangu` 命令。
+如果想在其他格式的文件中使用这个功能，可以执行 `:[range]Pangu` 命令。
 
-同时可以在 vimrc 中开启自动规范化功能。开启方式：
+同时可以在 vimrc 中开启保存文件时自动规范化功能。开启方式：
 
 ```viml
 autocmd BufWritePre *.markdown,*.md,*.text,*.txt,*.wiki,*.cnx call PanGuSpacing()
 ```
 
-> **注意：目前只对纯文本格式的文件支持较好，其他如 html 等，请谨慎开启。**
+> **注意：目前只对纯文本格式的文件支持较好。其他源代码场景，请谨慎开启。**
 >
 > 如果有合适的文件格式推荐，请提交 [Issue](https://github.com/hotoo/pangu.vim/issues)
 
 ## 安装
 
-via vim-plug
+via vim-plug:
 
 ```viml
 Plug "hotoo/pangu.vim"
@@ -48,7 +79,7 @@ Plug "hotoo/pangu.vim"
 via Vundle:
 
 ```
-Bundle "hotoo/pangu.vim"
+Plugin "hotoo/pangu.vim"
 ```
 
 ## 用法
@@ -85,7 +116,7 @@ $ vim a.md b.md c.md
 :wq
 ```
 
-### 持久化禁用
+## 持久化禁用
 
 在编辑的文档中任何位置注明 `PANGU_DISABLE`，则整个文档不自动规范化。
 
diff --git a/doc/pangu.txt b/doc/pangu.txt
@@ -5,21 +5,50 @@
                   https://github.com/hotoo/pangu.vim
 
 
-1. 用法                                       |pangu-usage|
-2. 配置                                       |pangu-config|
-3. 规则                                       |pangu-rules|
+1. 安装                                       |pangu-install|
+2. 命令                                       |pangu-command|
+3. 配置                                       |pangu-config|
+4. 规则                                       |pangu-rules|
+5. 技巧                                       |pangu-tricks|
+
 
 ==============================================================================
-USAGE                                                         *pangu-usage*
+INSTALL                                                     *pangu-install*
+
+via vim-plug: >
+  Plug "hotoo/pangu.vim"
+<
+
+via Vundle: >
+  Plugin "hotoo/pangu.vim"
+<
+
+==============================================================================
+COMMANDS                                                    *pangu-command*
+
+                                                            *:[range]Pangu*
+手动执行命令，对指定范围的中文进行规范化。 >
+  :Pangu
+<
+
+                                                                *:PanguAll*
+手动执行命令，对当前 Buffer 的所有中文进行规范化。 >
+  :PanguAll
+<
 
-关闭 Pangu 插件。 >
                                                             *:PanguDisable*
->
+关闭 Pangu 插件。 >
   :PanguDisable
 <
+
+持久化禁用：
+
+在文档中任何位置注明 `PANGU_DISABLE`，则整个文档不自动规范化。
+
+
                                                              *:PanguEnable*
 打开 Pangu 插件。 >
-  :PanguDisable
+  :PanguEnable
 <
 
 ==============================================================================
@@ -31,7 +60,7 @@ CONFIGURATION                                                *pangu-config*
 <
 
 ==============================================================================
-CONFIGURATION                                                *pangu-config*
+RULES                                                *pangu-rules*
 
                                        *g:pangu_rule_fullwidth_punctuation*
 
@@ -64,12 +93,33 @@ http://www.moe.gov.cn/ewebeditor/uploadfile/2015/01/13/20150113091548267.pdf
   let g:pangu_rule_spacing = 0
 <
 
+                                                     *g:pangu_rule_date*
+
+“年月日”之间的数字，默认通过 `g:pangu_rule_spacing` 规则会被空格隔开。
+如果你希望“年月日”之间的数字不以空白隔开，可以使用这个新增的这个设置： >
+  let g:pangu_rule_date = 0 " 年月日两头不留白
+  " eg: 今天是2022年1月21日星期五。
+
+  let g:pangu_rule_date = 1 " 年月日两头留白
+  " eg: 今天是 2022年1月21日 星期五。
+<
+默认值 `2`，为了和之前默认行为兼容。
+
                                          *g:pangu_rule_trailing_whitespace*
 
 删除前置空白和尾空白。默认开启，如需关闭可以设置： >
   let g:pangu_rule_trailing_whitespace = 0
 <
 
 ==============================================================================
-PANGU_DISABLE
+TRICKS                                                    *pangu-tricks*
+
+批量规范化多个文档。 >
+  $ vim a.md b.md c.md
+
+  :argdo PanguAll | update
+  :wq
+<
+
+==============================================================================
 vim:tw=78:fo=tcroq2mM:et:sts=2:sw=2:ft=help:norl:
diff --git a/plugin/pangu.vim b/plugin/pangu.vim
@@ -25,6 +25,9 @@ endif
 if !exists("g:pangu_rule_trailing_whitespace")
   let g:pangu_rule_trailing_whitespace=1
 endif
+if !exists("g:pangu_rule_date")
+  let g:pangu_rule_date = 2
+endif
 
 function! PanGuSpacingCore(mode) range
   let ignore = search("PANGU_DISABLE", 'n')
@@ -110,6 +113,32 @@ function! PanGuSpacingCore(mode) range
     silent! execute firstline . ',' . lastline . 's/\([a-zA-Z0-9!&;=\]\,\.\:\?\$\%\^\-\+\)\\]\)\([\u4e00-\u9fa5\u3040-\u30FF]\)/\1 \2/g'
   endif
 
+  " 默认日期每个数字都留白，向前兼容。
+  " 例：
+  " 在 2017 年 8 月 7 日生日。
+  " 在2017年8月7日。
+  if g:pangu_rule_date == 0
+    " 日期两端也不留白
+    " 例：
+    " 我在2017年8月7日生日。
+    " 在2017年8月7日。
+    silent! execute firstline . ',' . lastline . 's/\s*\(\d\{4,5}\)\s*年\s*\(\d\{1,2}\)\s*月/\1年\2月/g'
+    silent! execute firstline . ',' . lastline . 's/\s*\(\d\{1,2}\)\s*月\s*\(\d\{1,2}\)\s*日/\1月\2日/g'
+    silent! execute firstline . ',' . lastline . 's/\s*\(\d\{4,5}\)\s*年\s*\(\d\{1,2}\)\s*月\s*\(\d\{1,2}\)\s*日/\1年\2月\3日/g'
+    " 去除两端留白
+    silent! execute firstline . ',' . lastline . 's/\(\(\d\{4,5}年\)\?\d\{1,2}月\(\d\{1,2}日\)\?\)\s\+\([\u4e00-\u9fa5\u3040-\u30FF]\)/\1\4/g'
+  elseif g:pangu_rule_date == 1
+    " 日期两端留白
+    " 例：
+    " 我在 2019年12月1日 生日。
+    " 在 2017年8月7日。
+    silent! execute firstline . ',' . lastline . 's/\(\d\{4,5}\)\s*年\s*\(\d\{1,2}\)\s*月/\1年\2月/g'
+    silent! execute firstline . ',' . lastline . 's/\(\d\{1,2}\)\s*月\s*\(\d\{1,2}\)\s\+日/\1月\2日/g'
+    silent! execute firstline . ',' . lastline . 's/\(\d\{4,5}\)\s*年\s*\(\d\{1,2}\)\s*月\s*\(\d\{1,2}\)\s\+日/\1年\2月\3日/g'
+    " 两端留白
+    silent! execute firstline . ',' . lastline . 's/\(\(\d\{4,5}年\)\?\d\{1,2}月\(\d\{1,2}日\)\?\)\([\u4e00-\u9fa5\u3040-\u30FF]\)/\1 \4/g'
+  endif
+
   if g:pangu_rule_trailing_whitespace == 1
     silent! execute firstline . ',' . lastline . 's/^ \[/[/'
     silent! execute firstline . ',' . lastline . 's/\s\+$//'
diff --git a/test/date.txt b/test/date.txt
@@ -0,0 +1,22 @@
+日期测试用例：
+
+在2021年1月。
+我在2021年1月生日
+在1月1日。
+我在1月1日生日
+在2021年1月1日。
+我在2021年1月1日生日
+
+在2021年1月。
+我在 2021年1月 生日
+在 1月1日。
+我在 1月1日 生日
+在 2021年1月1日。
+我在 2021年1月1日 生日
+
+在 2021 年 1 月。
+我在 2021 年 1 月生日
+在 1 月 1 日。
+我在 1 月 1 日生日
+在 2021 年 1 月 1 日。
+我在 2021 年 1 月 1 日生日
