写一点文档

Author: CppCXY

README.md

@@ -2,19 +2,16 @@
 
 [English doc](README_EN.md)
 
-## BreakChange
-
-整个项目被重写了, 文档以后再写
-
 ## 项目介绍
 
-该项目是基于C++的lua代码解析\格式化\代码诊断算法库和语言服务实例
+该项目是基于C++实现的lua代码解析\格式化\代码诊断算法库和语言服务实例
 
 该项目主要追求的是合理的格式化，多样的代码风格诊断
 
 该项目除了提供语言服务实例，也提供独立的命令行工具CodeFormat，他能用于批量的代码格式化和代码风格检查。
 ## Feature
 
+* 支持lua5.1, lua5.2, lua5.3, lua5.4, luajit
 * 文档格式化
 * 范围格式化
 * 代码格式检查
@@ -27,7 +24,7 @@
 
 ## 文档
 
-* [格式化行为介绍](docs/old_version_doc/format_action.md)
+* [格式化行为介绍](docs/format_action.md)
 * [如何配置格式化](docs/old_version_doc/format_config.md)
 * [代码诊断配置](docs/old_version_doc/diagnosis_config.md)
 

docs/format_action.md

@@ -0,0 +1,114 @@
+# 格式化行为介绍
+
+该格式化工具具有高度可配置，可支持简单扩展语法，风格多样，性能卓绝等特点。适用于格式化配置文件, 格式化大型代码库等。适合项目内统一代码风格，或者具有特别的喜好个人开发者。
+
+格式化结果符合基本审美，格式化效果出众，格式化速度一骑绝尘。
+
+## 基本格式化
+
+代码的基本格式化主要是为符号两边增设基本的空白，为语句块实现正确的缩进，为不同语句之间设定合适的间距。
+
+```lua
+local t=123 --local
+aaa,bbbb = 1123, 2342
+local f =function() end
+local d = {
+    -- comment
+    aa = 213, --comment
+};
+local e = a+b+c+d
+function fff(a,b,c) end
+function ff2()
+--[[
+    long comment
+]]
+end
+```
+
+会被格式化为：
+```lua
+local t = 123 --local
+aaa, bbbb = 1123, 2342
+local f = function()
+end
+local d = {
+    -- comment
+    aa = 213, --comment
+};
+local e = a + b + c + d
+function fff(a, b, c)
+end
+
+function ff2()
+    --[[
+    long comment
+]]
+end
+```
+
+## 对齐
+
+代码对齐也是很重要的需求，连续赋值语句，连续的键值对表项，连续的数组类表都可以对齐
+
+```lua
+local ttt  = 123 --first
+cd        = 345 --second
+
+
+local d = {
+    aa  =123,
+    bbbb = 4353,
+    eee  = 131231,
+}
+
+local c = {
+    { aaaaa, bbbb, ccc },
+    { 1, 2, 3 }
+}
+```
+
+格式化后：
+
+```lua
+local ttt = 123 --first
+cd        = 345 --second
+
+
+local d = {
+    aa   = 123,
+    bbbb = 4353,
+    eee  = 131231,
+}
+
+local c = {
+    { aaaaa, bbbb, ccc },
+    { 1,     2,    3 }
+}
+```
+
+## if语句对齐
+
+lua没有switch语句，一般都是通过if/elseif做一个匹配列表，如果喜欢的话可以设置类似于switch-case的对齐方式。
+
+```lua
+if aa.isDDDD()
+and bb == fwfwfw
+or hi == 123 then
+    print(1313)
+elseif cc == 123
+or dd == 13131 and ddd == 123 then
+    local ccc = 123
+end
+```
+
+会被格式化为：
+```lua
+if     aa.isDDDD()
+and    bb == fwfwfw
+or     hi == 123 then
+    print(1313)
+elseif cc == 123
+or     dd == 13131 and ddd == 123 then
+    local ccc = 123
+end
+```