summaryrefslogtreecommitdiff
path: root/doc/zh-tw
diff options
context:
space:
mode:
author最萌小汐 <sumneko@hotmail.com>2022-06-09 02:22:30 +0800
committer最萌小汐 <sumneko@hotmail.com>2022-06-09 02:22:30 +0800
commit05fc6b11b399f3024679d9ca9226b00cc193ae86 (patch)
treebd4b6e04b670cc58baad042dfabf146d2e44dfd2 /doc/zh-tw
parentc481991fee74022dd261fab3bd5f07f472b9f9ac (diff)
downloadlua-language-server-05fc6b11b399f3024679d9ca9226b00cc193ae86.zip
update doc
Diffstat (limited to 'doc/zh-tw')
-rw-r--r--doc/zh-tw/config/config.md741
1 files changed, 603 insertions, 138 deletions
diff --git a/doc/zh-tw/config/config.md b/doc/zh-tw/config/config.md
index f0cc320d..ef7438c1 100644
--- a/doc/zh-tw/config/config.md
+++ b/doc/zh-tw/config/config.md
@@ -3,206 +3,281 @@
輸入內容看起來是個檔名時,自動 `require` 此檔案。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# completion.callSnippet
顯示函式呼叫片段。
## type
-`string`
-
-## default
-`"Disable"`
+```ts
+string
+```
## enum
* `"Disable"`: 只顯示 `函式名`。
* `"Both"`: 顯示 `函式名` 與 `呼叫片段`。
* `"Replace"`: 只顯示 `呼叫片段`。
+## default
+
+```json
+"Disable"
+```
# completion.displayContext
預覽建議的相關程式碼片段,可能可以幫助你瞭解這項建議的用法。設定的數字表示程式碼片段的擷取行數,設定為 `0` 可以停用此功能。
## type
-`integer`
+
+```ts
+integer
+```
## default
-`0`
+```json
+0
+```
# completion.enable
啟用自動完成。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# completion.keywordSnippet
顯示關鍵字語法片段。
## type
-`string`
-
-## default
-`"Replace"`
+```ts
+string
+```
## enum
* `"Disable"`: 只顯示 `關鍵字`。
* `"Both"`: 顯示 `關鍵字` 與 `語法片段`。
* `"Replace"`: 只顯示 `語法片段`。
+## default
+
+```json
+"Replace"
+```
# completion.postfix
用於觸發後綴建議的符號。
## type
-`string`
+
+```ts
+string
+```
## default
-`"@"`
+```json
+"@"
+```
# completion.requireSeparator
`require` 時使用的分隔符。
## type
-`string`
+
+```ts
+string
+```
## default
-`"."`
+```json
+"."
+```
# completion.showParams
在建議列表中顯示函式的參數資訊,函式擁有多個定義時會分開顯示。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# completion.showWord
在建議中顯示上下文單詞。
## type
-`string`
-
-## default
-`"Fallback"`
+```ts
+string
+```
## enum
* `"Enable"`: 總是在建議中顯示上下文單詞。
* `"Fallback"`: 無法根據語義提供建議時才顯示上下文單詞。
* `"Disable"`: 不顯示上下文單詞。
+## default
+
+```json
+"Fallback"
+```
# completion.workspaceWord
顯示的上下文單詞是否包含工作區中其他檔案的內容。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# diagnostics.disable
停用的診斷(使用浮框括號內的程式碼)。
## type
-`array<string>`
+
+```ts
+Array<string>
+```
## default
-`[]`
+```json
+[]
+```
# diagnostics.disableScheme
不診斷使用以下 scheme 的lua檔案。
## type
-`array<string>`
+
+```ts
+Array<string>
+```
## default
-`[ "git" ]`
+```json
+["git"]
+```
# diagnostics.enable
啟用診斷。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# diagnostics.globals
已定義的全域變數。
## type
-`array<string>`
+
+```ts
+Array<string>
+```
## default
-`[]`
+```json
+[]
+```
# diagnostics.ignoredFiles
如何診斷被忽略的檔案。
## type
-`string`
-## default
-
-`"Opened"`
+```ts
+string
+```
## enum
* `"Enable"`: 總是診斷這些檔案。
* `"Opened"`: 只有打開這些檔案時才會診斷。
* `"Disable"`: 不診斷這些檔案。
+## default
+
+```json
+"Opened"
+```
# diagnostics.libraryFiles
如何診斷透過 `Lua.workspace.library` 載入的檔案。
## type
-`string`
-## default
-
-`"Opened"`
+```ts
+string
+```
## enum
* `"Enable"`: 總是診斷這些檔案。
* `"Opened"`: 只有打開這些檔案時才會診斷。
* `"Disable"`: 不診斷這些檔案。
+## default
+
+```json
+"Opened"
+```
# diagnostics.neededFileStatus
@@ -212,216 +287,431 @@
## type
-`object`
+
+```ts
+object<string, string>
+```
+
+## enum
+
+* `"Any"`
+* `"Opened"`
+* `"None"`
+## default
+
+```json
+{
+ "ambiguity-1": "Any",
+ "await-in-sync": "None",
+ "circle-doc-class": "Any",
+ "close-non-object": "Any",
+ "code-after-break": "Opened",
+ "codestyle-check": "None",
+ "count-down-loop": "Any",
+ "deprecated": "Opened",
+ "different-requires": "Any",
+ "discard-returns": "Opened",
+ "doc-field-no-class": "Any",
+ "duplicate-doc-alias": "Any",
+ "duplicate-doc-field": "Any",
+ "duplicate-doc-param": "Any",
+ "duplicate-index": "Any",
+ "duplicate-set-field": "Any",
+ "empty-block": "Opened",
+ "global-in-nil-env": "Any",
+ "lowercase-global": "Any",
+ "missing-parameter": "Opened",
+ "need-check-nil": "Opened",
+ "newfield-call": "Any",
+ "newline-call": "Any",
+ "no-unknown": "None",
+ "not-yieldable": "None",
+ "redefined-local": "Opened",
+ "redundant-parameter": "Opened",
+ "redundant-return": "Opened",
+ "redundant-value": "Opened",
+ "spell-check": "None",
+ "trailing-space": "Opened",
+ "type-check": "None",
+ "unbalanced-assignments": "Any",
+ "undefined-doc-class": "Any",
+ "undefined-doc-name": "Any",
+ "undefined-doc-param": "Any",
+ "undefined-env-child": "Any",
+ "undefined-field": "Opened",
+ "undefined-global": "Any",
+ "unknown-diag-code": "Any",
+ "unused-function": "Opened",
+ "unused-label": "Opened",
+ "unused-local": "Opened",
+ "unused-vararg": "Opened"
+}
+```
# diagnostics.severity
修改診斷等級。
## type
-`object`
+
+```ts
+object<string, string>
+```
+
+## enum
+
+* `"Error"`
+* `"Warning"`
+* `"Information"`
+* `"Hint"`
+## default
+
+```json
+{
+ "ambiguity-1": "Warning",
+ "await-in-sync": "Warning",
+ "circle-doc-class": "Warning",
+ "close-non-object": "Warning",
+ "code-after-break": "Hint",
+ "codestyle-check": "Warning",
+ "count-down-loop": "Warning",
+ "deprecated": "Warning",
+ "different-requires": "Warning",
+ "discard-returns": "Warning",
+ "doc-field-no-class": "Warning",
+ "duplicate-doc-alias": "Warning",
+ "duplicate-doc-field": "Warning",
+ "duplicate-doc-param": "Warning",
+ "duplicate-index": "Warning",
+ "duplicate-set-field": "Warning",
+ "empty-block": "Hint",
+ "global-in-nil-env": "Warning",
+ "lowercase-global": "Information",
+ "missing-parameter": "Warning",
+ "need-check-nil": "Warning",
+ "newfield-call": "Warning",
+ "newline-call": "Information",
+ "no-unknown": "Information",
+ "not-yieldable": "Warning",
+ "redefined-local": "Hint",
+ "redundant-parameter": "Warning",
+ "redundant-return": "Warning",
+ "redundant-value": "Warning",
+ "spell-check": "Information",
+ "trailing-space": "Hint",
+ "type-check": "Warning",
+ "unbalanced-assignments": "Warning",
+ "undefined-doc-class": "Warning",
+ "undefined-doc-name": "Warning",
+ "undefined-doc-param": "Warning",
+ "undefined-env-child": "Information",
+ "undefined-field": "Warning",
+ "undefined-global": "Warning",
+ "unknown-diag-code": "Warning",
+ "unused-function": "Hint",
+ "unused-label": "Hint",
+ "unused-local": "Hint",
+ "unused-vararg": "Hint"
+}
+```
# diagnostics.workspaceDelay
進行工作區診斷的延遲(毫秒)。當你啟動工作區,或編輯了任意檔案後,將會在背景對整個工作區進行重新診斷。設定為負數可以停用工作區診斷。
## type
-`integer`
+
+```ts
+integer
+```
## default
-`3000`
+```json
+3000
+```
# diagnostics.workspaceRate
工作區診斷的執行速率(百分比)。降低該值會減少CPU佔用,但是也會降低工作區診斷的速度。你目前正在編輯的檔案的診斷總是全速完成,不受該選項影響。
## type
-`integer`
+
+```ts
+integer
+```
## default
-`100`
+```json
+100
+```
# format.defaultConfig
**Missing description!!**
## type
-`object`
+
+```ts
+Object<string, string>
+```
## default
-`{}`
+```json
+{}
+```
# format.enable
啟用程式碼格式化程式。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# hint.arrayIndex
在建構表時提示陣列索引。
## type
-`string`
-
-## default
-`"Auto"`
+```ts
+string
+```
## enum
* `"Enable"`: 所有的表中都提示陣列索引。
* `"Auto"`: 只有表大於3項,或者表是混合型別時才進行提示。
* `"Disable"`: 停用陣列索引提示。
+## default
+
+```json
+"Auto"
+```
# hint.await
**Missing description!!**
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# hint.enable
啟用內嵌提示。
## type
-`boolean`
+
+```ts
+boolean
+```
+
+## default
+
+```json
+false
+```
# hint.paramName
在函式呼叫處提示參數名。
## type
-`string`
-
-## default
-`"All"`
+```ts
+string
+```
## enum
* `"All"`: 所有型別的參數均進行提示。
* `"Literal"`: 只有字面常數型別的參數進行提示。
* `"Disable"`: 停用參數提示。
+## default
+
+```json
+"All"
+```
# hint.paramType
在函式的參數位置提示型別。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# hint.setType
在賦值操作位置提示型別。
## type
-`boolean`
+
+```ts
+boolean
+```
+
+## default
+
+```json
+false
+```
# hover.enable
啟用懸浮提示。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# hover.enumsLimit
當值對應多個型別時,限制型別的顯示數量。
## type
-`integer`
+
+```ts
+integer
+```
## default
-`5`
+```json
+5
+```
# hover.expandAlias
**Missing description!!**
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# hover.previewFields
懸浮提示檢視表時,限制表內欄位的最大預覽數量。
## type
-`integer`
+
+```ts
+integer
+```
## default
-`20`
+```json
+20
+```
# hover.viewNumber
懸浮提示檢視數字內容(僅當字面常數不是十進制時)。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# hover.viewString
懸浮提示檢視字串內容(僅當字面常數包含跳脫字元時)。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# hover.viewStringMax
懸浮提示檢視字串內容時的最大長度。
## type
-`integer`
+
+```ts
+integer
+```
## default
-`1000`
+```json
+1000
+```
# misc.parameters
VSCode中啟動語言服務時的[命令列參數](https://github.com/sumneko/lua-language-server/wiki/Command-line)。
## type
-`array<string>`
+
+```ts
+Array<string>
+```
## default
-`[]`
+```json
+[]
+```
# runtime.builtin
@@ -433,18 +723,47 @@ VSCode中啟動語言服務時的[命令列參數](https://github.com/sumneko/lu
## type
-`object`
+
+```ts
+object<string, string>
+```
+
+## enum
+
+* `"default"`
+* `"enable"`
+* `"disable"`
+## default
+
+```json
+{
+ "basic": "default",
+ "bit": "default",
+ "bit32": "default",
+ "builtin": "default",
+ "coroutine": "default",
+ "debug": "default",
+ "ffi": "default",
+ "io": "default",
+ "jit": "default",
+ "math": "default",
+ "os": "default",
+ "package": "default",
+ "string": "default",
+ "table": "default",
+ "utf8": "default"
+}
+```
# runtime.fileEncoding
檔案編碼,`ansi` 選項只在 `Windows` 平台下有效。
## type
-`string`
-## default
-
-`"utf8"`
+```ts
+string
+```
## enum
@@ -452,28 +771,43 @@ VSCode中啟動語言服務時的[命令列參數](https://github.com/sumneko/lu
* `"ansi"`
* `"utf16le"`
* `"utf16be"`
+## default
+
+```json
+"utf8"
+```
# runtime.meta
**Missing description!!**
## type
-`string`
+
+```ts
+string
+```
## default
-`"${version} ${language} ${encoding}"`
+```json
+"${version} ${language} ${encoding}"
+```
# runtime.nonstandardSymbol
支援非標準的符號。請務必確認你的執行環境支援這些符號。
## type
-`array<string>`
+
+```ts
+Array<string>
+```
## default
-`[]`
+```json
+[]
+```
# runtime.path
@@ -484,29 +818,48 @@ VSCode中啟動語言服務時的[命令列參數](https://github.com/sumneko/lu
## type
-`array<string>`
+
+```ts
+Array<string>
+```
## default
-`[ "?.lua", "?/init.lua" ]`
+```json
+["?.lua","?/init.lua"]
+```
# runtime.pathStrict
啟用後 `runtime.path` 將只搜尋第一層目錄,見 `runtime.path` 的説明。
## type
-`boolean`
+
+```ts
+boolean
+```
+
+## default
+
+```json
+false
+```
# runtime.plugin
延伸模組路徑,請查閲[文件](https://github.com/sumneko/lua-language-server/wiki/Plugin)瞭解用法。
## type
-`string`
+
+```ts
+string
+```
## default
-`""`
+```json
+""
+```
# runtime.special
@@ -520,29 +873,42 @@ VSCode中啟動語言服務時的[命令列參數](https://github.com/sumneko/lu
## type
-`object`
+
+```ts
+Object<string, string>
+```
## default
-`{}`
+```json
+{}
+```
# runtime.unicodeName
允許在名字中使用 Unicode 字元。
## type
-`boolean`
+
+```ts
+boolean
+```
+
+## default
+
+```json
+false
+```
# runtime.version
Lua執行版本。
## type
-`string`
-
-## default
-`"Lua 5.4"`
+```ts
+string
+```
## enum
@@ -551,68 +917,107 @@ Lua執行版本。
* `"Lua 5.3"`
* `"Lua 5.4"`
* `"LuaJIT"`
+## default
+
+```json
+"Lua 5.4"
+```
# semantic.annotation
對型別註解進行語義著色。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# semantic.enable
啟用語義著色。你可能需要同時將 `editor.semanticHighlighting.enabled` 設定為 `true` 才能生效。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# semantic.keyword
對關鍵字/字面常數/運算子進行語義著色。只有當你的編輯器無法進行語法著色時才需要啟用此功能。
## type
-`boolean`
+
+```ts
+boolean
+```
+
+## default
+
+```json
+false
+```
# semantic.variable
對變數/欄位/參數進行語義著色。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# signatureHelp.enable
啟用參數提示。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# spell.dict
**Missing description!!**
## type
-`array<string>`
+
+```ts
+Array<string>
+```
## default
-`[]`
+```json
+[]
+```
# telemetry.enable
@@ -620,33 +1025,48 @@ Lua執行版本。
## type
-`boolean | null`
+
+```ts
+boolean | null
+```
## default
-`nil`
+```json
+null
+```
# window.progressBar
在狀態欄顯示進度條。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# window.statusBar
在狀態欄顯示延伸模組狀態。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# workspace.checkThirdParty
@@ -661,96 +1081,141 @@ Lua執行版本。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# workspace.ignoreDir
忽略的檔案與目錄(使用 `.gitignore` 語法)。
## type
-`array<string>`
+
+```ts
+Array<string>
+```
## default
-`[ ".vscode" ]`
+```json
+[".vscode"]
+```
# workspace.ignoreSubmodules
忽略子模組。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# workspace.library
除了目前工作區以外,還會從哪些目錄中載入檔案。這些目錄中的檔案將被視作外部提供的程式碼庫,部分操作(如重新命名欄位)不會修改這些檔案。
## type
-`array<string>`
+
+```ts
+Array<string>
+```
## default
-`[]`
+```json
+[]
+```
# workspace.maxPreload
最大預載入檔案數。
## type
-`integer`
+
+```ts
+integer
+```
## default
-`5000`
+```json
+5000
+```
# workspace.preloadFileSize
預載入時跳過大小大於該值(KB)的檔案。
## type
-`integer`
+
+```ts
+integer
+```
## default
-`500`
+```json
+500
+```
# workspace.supportScheme
為以下 `scheme` 的lua檔案提供語言服務。
## type
-`array<string>`
+
+```ts
+Array<string>
+```
## default
-`[ "file", "untitled", "git" ]`
+```json
+["file","untitled","git"]
+```
# workspace.useGitIgnore
忽略 `.gitignore` 中列舉的檔案。
## type
-`boolean`
+
+```ts
+boolean
+```
## default
-`true`
+```json
+true
+```
# workspace.userThirdParty
在這裡添加私有的第三方庫適應檔案路徑,請參考內建的[組態檔案路徑](https://github.com/sumneko/lua-language-server/tree/master/meta/3rd)
## type
-`array<string>`
+
+```ts
+Array<string>
+```
## default
-`[]` \ No newline at end of file
+```json
+[]
+``` \ No newline at end of file