update document

Author: CppCXY

CHANGELOG.md

@@ -1,8 +1,75 @@
 # Change Log
 
+## 1.1.3
+
+`NEW` 功能 `命名风格检查` 正式支持配置.
+
+`CHANGE` `local empty = function() end` 格式化时不会再换行
+
+`NEW` 支持形如 `local d; Init()` 的排版方式
+
+`NEW` 支持链式表达式对齐
+
+## 1.1.2
+
+`NEW` 新选项 `align_continuous_line_space`
+
+`NEW` 还有其他更新, 但是我忘了
+
+## 1.1.1
+
+`NEW` 优化type format
+
+`FIX` type format 不会清理`---@format disable` 和`---@format disable-next`之下的内容了
+
+## 1.1.0
+
+`FIX` 修复许多BUG 
+
+
+`NEW` 重新支持`---@format disable` 和 `---@format disable-next`
+
+## 1.0.9
+
+`FIX` 修复缩进检查的一些BUG
+
+## 1.0.8
+
+`NEW` 支持缩进检查
+
+`NEW` 修复一些BUG
+
+## 1.0.7
+
+`FIX` fix #89 #90
+
+## 1.0.6
+
+`NEW` 支持内联注释对齐
+
+## 1.0.5
+
+`FIX` 修复文件增量更新算法的BUG
+
+## 1.0.4
+
+`Upgrade` 试图修复vscode-languageclient带来的依赖错误
+
+## 1.0.3
+
+`Upgrade` 试图修复插件无法激活的问题, 更新所有依赖库
+
+`FIX` 修复一个格式化行为.
+
+`NEW` 选项`space_before_function_call_single_arg`支持其他值always/only_string/only_table/none
+
+## 1.0.2
+
+`FIX` 修复lineIndex错误导致的Unicode字符BUG
+
 ## 1.0.0
 
-`EmmyLuaCodeStyle`经过一年的更新现在进入正式版
+`EmmyLuaCodeStyle` 经过一年的更新现在进入正式版
 
 `Refactor` 大部分代码重写, 数据结构重新设计
 

README.md

@@ -26,6 +26,7 @@
 
 * [格式化行为介绍](docs/format_action.md)
 * [如何配置格式化](docs/format_config.md)
+* [如何配置命名风格检查](docs/name_style.md)
 
 # Contribute
 

README_EN.md

@@ -25,6 +25,8 @@ In addition to providing language service examples, the project also provides an
 
 * [Introduction to formatting behavior](docs/format_action_EN.md)
 * [How to configure formatting](docs/format_config_EN.md)
+* [How to configure naming style checking](docs/name_style_EN.md)
+
 ## Contribute
 Any pr or issue are welcome 
 

docs/name_style.md

@@ -0,0 +1,96 @@
+##  概述
+
+命名风格检查支持基于基本命名法的检查和正则表达式检查:
+* snake-case
+* camel-case
+* pascal-case
+* upper-snake-case
+* pattern
+
+## 配置
+
+开启命名风格检查需要在settings添加配置:
+```json
+"emmylua.lint.nameStyle": true
+```
+
+在vscode的setting中增加配置项`emmylua.name.config`, 可如下填写:
+```json
+  "emmylua.name.config": {
+      "local_name_style": "snake_case"
+  },
+```
+可配置的项有:
+* local_name_style
+* function_param_name_style
+* function_name_style
+* local_function_name_style
+* table_field_name_style
+* global_variable_name_style
+* module_name_style
+* require_module_name_style
+* class_name_style
+
+每一个可配置项的格式都是相同的, 每个可配置项可配置的值支持如下格式:
+* 单字符串 例如: 
+```json
+"local_name_style": "snake_case"
+```
+
+单字符串支持的值有: `snake_case`, `pascal_case`, `upper_snake_case`, `camel_case`
+
+* 字符串数组, 例如:
+```json
+"local_name_style": [
+    "snake_case",
+    "upper_snake_case"
+]
+```
+
+* 忽略列表
+
+忽略列表的一般形式是:
+```json
+"local_name_style": {
+    "type": "ignore", 
+    "param": ["m", "M", "Do"]
+}
+```
+
+* 正则表达式
+
+正则语法为javascript正则语法.
+正则表达式的一般形式是:
+```json
+"local_name_style": {
+    "type" : "pattern",
+    "param": "uuu*"
+}
+```
+
+正则表达式支持捕获组后再匹配基本命名法:
+```json
+"local_name_style": {
+    "type" : "pattern",
+    "param": "m_(w+)",
+    "$1": "camel_case"
+}
+```
+
+其中`"$1": "camel_case"`表示第一个捕获组的内容需要匹配 `camel_case` 命名法
+
+* 支持表结构和字符串的混合数组 例如:
+
+```json
+"local_name_style": [
+    "snake_case",
+    "pascal_case",
+    "camel_case",
+    {
+        "type" : "pattern",
+        "param": "m_(w+)",
+        "$1": "camel_case"
+    }
+]
+```
+

docs/name_style_EN.md

@@ -0,0 +1,95 @@
+## Overview
+
+Naming style checking supports checking based on basic nomenclature and regular expression checking:
+* snake-case
+* camel-case
+* pascal-case
+* upper-snake-case
+* pattern
+
+## configuration
+
+To enable naming style checking, you need to add configuration in settings:
+```json
+"emmylua.lint.nameStyle": true
+```
+
+Add the configuration item `emmylua.name.config` in the setting of vscode, which can be filled in as follows:
+```json
+   "emmylua.name.config": {
+       "local_name_style": "snake_case"
+   },
+```
+The configurable items are:
+* local_name_style
+* function_param_name_style
+* function_name_style
+* local_function_name_style
+* table_field_name_style
+* global_variable_name_style
+* module_name_style
+* require_module_name_style
+* class_name_style
+
+The format of each configurable item is the same, and the configurable value of each configurable item supports the following formats:
+* Single string Example:
+```json
+"local_name_style": "snake_case"
+```
+
+Supported values for single string are: `snake_case`, `pascal_case`, `upper_snake_case`, `camel_case`
+
+* String array, for example:
+```json
+"local_name_style": [
+     "snake_case",
+     "upper_snake_case"
+]
+```
+
+* ignore list
+
+The general form of an ignore list is:
+```json
+"local_name_style": {
+     "type": "ignore",
+     "param": ["m", "M", "Do"]
+}
+```
+
+* regular expression
+
+The regular syntax is javascript regular syntax.
+The general form of a regular expression is:
+```json
+"local_name_style": {
+     "type" : "pattern",
+     "param": "uuu*"
+}
+```
+
+Regular expressions support capture groups and then match basic nomenclature:
+```json
+"local_name_style": {
+     "type" : "pattern",
+     "param": "m_(w+)",
+     "$1": "camel_case"
+}
+```
+
+Where `"$1": "camel_case"` means that the content of the first capture group needs to match the `camel_case` nomenclature
+
+* Supports mixed arrays of table structures and strings For example:
+
+```json
+"local_name_style": [
+     "snake_case",
+     "pascal_case",
+     "camel_case",
+     {
+         "type" : "pattern",
+         "param": "m_(w+)",
+         "$1": "camel_case"
+     }
+]
+```