feat: format code and add cmd doc

lua/Trans/core/READMD.md

@@ -0,0 +1,96 @@
+# 命令说明
+
+<!--toc:start-->
+- [命令说明](#命令说明)
+  - [Translate](#translate)
+  - [TranslateInput](#translateinput)
+  - [TranslateHistory](#translatehistory)
+  - [自定义](#自定义)
+    - [可选项说明](#可选项说明)
+    - [示例](#示例)
+<!--toc:end-->
+
+## Translate
+**窗口风格默认为:** `cursor`
+- 动作(action):
+    - `vsplit`         水平分屏
+    - `split`          垂直分屏
+    - `float`          窗口样式又`cursor` 变为`float`
+    - `online_query`   使用在线引擎重新进行查询
+    - `history_insert` 将此次查询的单词记录到历史记录  
+    - `next`           展示下一个引擎的查询结果(如果默认设置了多个引擎)
+    - `prev`           展示上一个查询结果
+    > 如果没有设置自动保存历史的话
+
+    - `history`        查看历史查询的记录
+
+- `online_query`:
+    - `local_add`    将此次查询的结果添加到本地数据库  
+    > **如果本地已经存在该单词，会询问是否需要覆盖掉相同的字段**
+
+    - `local_update` 和*local_add* 类似, 但是不会询问是否覆盖
+    - `diff`         对比本地查询结果和此次在线查询的区别
+
+>  **注意**: 动作是任何窗口通用的  
+## TranslateInput
+**窗口风格默认为:** `float`
+- 自行得到要查询的单词
+
+- TODO: 
+    - fuzzy match
+
+## TranslateHistory
+**窗口风格默认为:** `float`
+- 查看历史查询
+
+---
+## 自定义
+
+### 可选项说明
+- 查询方式(method): `string`
+    - `input` 自行输入需要查询的单词
+    - `last`  显示上一次查询的结果
+    - `history`
+
+- 查询引擎(engine): `string | table`
+    - `local` 本地的数据库
+    - `youcao` 有道api
+    - `baidu` 百度api
+    - `google` 谷歌api
+    - `bing` 必应api
+    - `iciba` 金山词霸api
+    - `xunfei` 讯飞api
+
+- 窗口风格(win): `string | table`
+    - 样式(style): 
+        - `cursor` 在光标附近弹出
+        - `float` 悬浮窗口
+        - `split` 在上方或者下方分屏
+        - `vsplit` 在左边或者右边分屏
+
+    - 高度(height):
+        - `value > 1` 实际高度
+        - `0 <= value <= 1` 相对高度
+        - `0 < value` 无限制
+
+    - 宽度(width):
+        > 和`高度(height)`相同
+### 示例
+```lua
+vim.keymap.set('n', 'mi', function ()
+    require('Trans').translate({
+        method = 'input',
+        engine = { -- 异步查询所有的引擎, 按照列表
+            'local',
+            'youdao',
+            'baidu'
+        },
+        -- view = 'cursor'
+        view = {
+            style = 'cursor',
+            height = 50,
+            width = 30,
+        }
+    })
+end, { desc = '在光标旁弹出输入的单词释义'})
+```

lua/Trans/core/query.lua

@@ -14,24 +14,24 @@ local function get_select()
     return word
 end
 
+
 M.get_query_res = function(method)
     type_check {
         method = { method, 'string' },
     }
-
-    -- NOTE : get query word
     local word = ''
     if method == 'cursor' then
         word = vim.fn.expand('<cword>')
     elseif method == 'select' then
-        word = get_select():match('%s+')
+        word = get_select():match('%S+')
     elseif method == 'input' then
         word = vim.fn.input('请输入您要查询的单词:') -- TODO Use Telescope with fuzzy finder
     else
         error('unknown method')
     end
-    -- FIXME
+
     return query(word)
 end
 
+
 return M

lua/Trans/core/translate.lua

@@ -1,32 +1,20 @@
 local M          = {}
-local api        = vim.api
-local conf       = require("Trans").conf
-local display    = conf.display
-local icon       = conf.icon
-local order      = conf.order
-local auto_close = conf.auto_close
-local view       = conf.view
 
 
-local highlight = {
-    word     = 'TransWord',
-    phonetic = 'TransPhonetic',
-    ref      = 'TransRef',
-    tag      = 'TransTag',
-    exchange = 'TransExchange',
-    pos      = 'TransPos',
-    zh       = 'TransZh',
-    en       = 'TransEn',
+local opt = {
+    method = 'select',
+    view = 'cursor',
 }
 
-
-
-
-M.TransLate = function(opts)
+M.Translate = function(opts)
     local res = get_query_res(opts.method)
     -- TODO <++>
 end
 
+-- M.Translate_online = function ()
+--     -- TOOD
+-- end
+
 
 -- local win = 0
 -- local line = 0