更新文档

Author: CppCXY

README.md

@@ -25,8 +25,7 @@
 ## 文档
 
 * [格式化行为介绍](docs/format_action.md)
-* [如何配置格式化](docs/old_version_doc/format_config.md)
-* [代码诊断配置](docs/old_version_doc/diagnosis_config.md)
+* [如何配置格式化](docs/format_config.md)
 
 # Contribute
 

README_EN.md

@@ -19,17 +19,12 @@ In addition to providing language service examples, the project also provides an
 * Can be used as a lua library/cli tool/C++ parsing lua library/language server
 
 ## RoadMap
-* reimplement range formatting[0%]
-* reimplement type formatting[0%]
 * plugin[0%]
 
 ## Document
-* [Usage](docs/usage_EN.md)
-* [Introduction to formatting behavior](docs/old_version_doc/format_action_EN.md)
-* [How to configure formatting](docs/old_version_doc/format_config_EN.md)
-* [Code diagnosis configuration](docs/old_version_doc/diagnosis_config_EN.md)
-* [Disable format](docs/old_version_doc/disable_format_EN.md)
-* [auto import configuration](docs/old_version_doc/auto_import_config_EN.md)
+
+* [Introduction to formatting behavior](docs/format_action_EN.md)
+* [How to configure formatting](docs/format_config_EN.md)
 ## Contribute
 Any pr or issue are welcome 
 
@@ -53,6 +48,9 @@ cmake --build .
 
 **Contributors**
 
+[**@obszczymucha**](https://github.com/obszczymucha)
+
+[**@Rainer Poisel**](https://github.com/rpoisel)
 
 ## License
 

docs/format_action.md

@@ -2,11 +2,9 @@
 
 该格式化工具具有高度可配置，可支持简单扩展语法，风格多样，性能卓绝等特点。适用于格式化配置文件, 格式化大型代码库等。适合项目内统一代码风格，或者具有特别的喜好个人开发者。
 
-格式化结果符合基本审美，格式化效果出众，格式化速度一骑绝尘。
-
 ## 基本格式化
 
-代码的基本格式化主要是为符号两边增设基本的空白，为语句块实现正确的缩进，为不同语句之间设定合适的间距。
+代码的基本格式化原则主要是为符号两边增设基本的空白，为语句块实现正确的缩进，为不同语句之间设定合适的间距，保持token在顺序位置上不会改变，清理行尾多余的空白。
 
 ```lua
 local t=123 --local
@@ -48,7 +46,7 @@ end
 
 ## 对齐
 
-代码对齐也是很重要的需求，连续赋值语句，连续的键值对表项，连续的数组类表都可以对齐
+在基本需求之上格式化工具提供对进阶的审美需求的满足，代码对齐是很重要的组成部分。
 
 ```lua
 local ttt  = 123 --first
@@ -85,30 +83,3 @@ local c = {
     { 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
-```

docs/format_action_EN.md

@@ -0,0 +1,86 @@
+# Introduction to formatting behavior
+
+The formatter is highly configurable, supports simple extended syntax, has a variety of styles, and is extremely performant. Suitable for formatting configuration files, formatting large code bases, etc. Suitable for a unified code style within the project, or individual developers with special preferences.
+
+## Basic formatting
+
+The basic formatting principle of the code is mainly to add basic whitespace on both sides of the symbol, achieve correct indentation for the statement block, set the appropriate spacing between different statements, keep the token in the sequential position will not change, and clean up the excess space at the end of the line.
+
+```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
+```
+
+will be formatted as:
+```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
+```
+
+## Alignment
+
+On top of basic requirements, formatting tools provide satisfaction for advanced aesthetic needs, and code alignment is an important component.
+
+
+```lua
+local ttt  = 123 --first
+cd        = 345 --second
+
+
+local d = {
+    aa  =123,
+    bbbb = 4353,
+    eee  = 131231,
+}
+
+local c = {
+    { aaaaa, bbbb, ccc },
+    { 1, 2, 3 }
+}
+```
+
+will be formatted as:
+
+```lua
+local ttt = 123 --first
+cd        = 345 --second
+
+
+local d = {
+    aa   = 123,
+    bbbb = 4353,
+    eee  = 131231,
+}
+
+local c = {
+    { aaaaa, bbbb, ccc },
+    { 1,     2,    3 }
+}
+```