Merge pull request #120 from xuhuanzy/hover

std文档添加简单翻译

Author: CppCXY

crates/emmylua_code_analysis/resources/std/coroutine.lua

@@ -13,6 +13,7 @@
 -- License for the specific language governing permissions and limitations under
 -- the License.
 
+---@class coroutinelib
 coroutine = {}
 
 ---
@@ -74,10 +75,10 @@ function coroutine.running() end
 --- finished its body function, or if it has stopped with an error.
 ---@param co thread
 ---@return
----| '"running"'   # Is running.
----| '"suspended"' # Is suspended or not started.
----| '"normal"'    # Is active but not running.
----| '"dead"'      # Has finished or stopped with an error.
+---| "running"   # Is running.
+---| "suspended" # Is suspended or not started.
+---| "normal"    # Is active but not running.
+---| "dead"      # Has finished or stopped with an error.
 function coroutine.status(co) end
 
 ---

crates/emmylua_code_analysis/resources/std/debug.lua

@@ -13,6 +13,7 @@
 -- License for the specific language governing permissions and limitations under
 -- the License.
 
+---@class debuglib
 debug = {}
 
 ---

crates/emmylua_code_analysis/resources/std/global.lua

@@ -24,6 +24,17 @@
 ---@return std.NotNull<T>
 function assert(v, message) end
 
+---@alias std.collectgarbage_opt
+---|>"collect" # performs a full garbage-collection cycle. This is the default option.
+---| "stop" # stops automatic execution of the garbage collector. The collector will run only when explicitly invoked, until a call to restart it.
+---| "restart" # restarts automatic execution of the garbage collector.
+---| "count" # returns the total memory in use by Lua in Kbytes. The value has a fractional part, so that it multiplied by 1024 gives the exact number of bytes in use by Lua (except for overflows).
+---| "step" # performs a garbage-collection step. The step "size" is controlled by `arg`. With a zero value, the collector will perform one basic (indivisible) step. For non-zero values, the collector will perform as if Lua had allocated that amount of memory (in KBytes). Returns true if the step finished a collection cycle.
+---| "setpause" # sets `arg` as the new value for the *pause* of the collector (see §2.5). Returns the previous value for *pause`.
+---| "incremental" # Change the collector mode to incremental. This option can be followed by three numbers: the garbage-collector pause, the step multiplier, and the step size.
+---| "generational" # Change the collector mode to generational. This option can be followed by two numbers: the garbage-collector minor multiplier and the major multiplier.
+---| "isrunning" # returns a boolean that tells whether the collector is running (i.e., not stopped).
+
 ---
 --- This function is a generic interface to the garbage collector. It performs
 --- different functions according to its first argument, `opt`:
@@ -51,11 +62,10 @@ function assert(v, message) end
 --- the major multiplier.
 --- **"isrunning"**: returns a boolean that tells whether the collector is
 --- running (i.e., not stopped).
----@alias collectgarbage_opt "collect"|"stop"|"restart"|"count"|"step"|"setpause"|"incremental"|"generational"|"isrunning"
----@param opt? collectgarbage_opt
----@param arg? string
+---@param opt? std.collectgarbage_opt
+---@param ... any
 ---@return any
-function collectgarbage(opt, arg) end
+function collectgarbage(opt, ...) end
 
 ---
 --- Opens the named file and executes its contents as a Lua chunk. When called
@@ -108,6 +118,11 @@ function getmetatable(object) end
 ---@return fun(tbl: any):int, std.NotNull<V>
 function ipairs(t) end
 
+---@alias std.loadmode
+---| "b" # only binary chunks
+---| "t" # only text chunks
+---| "bt" # both binary and text
+
 ---
 --- Loads a chunk.
 --- If `chunk` is a string, the chunk is this string. If `chunk` is a function,
@@ -139,9 +154,11 @@ function ipairs(t) end
 --- binary chunks can crash the interpreter.
 ---@param chunk (fun():string) | string
 ---@param chunkname? string
----@param mode? string
----@param env? any
+---@param mode? std.loadmode
+---@param env? table
 ---@return fun():any
+---@return string?   error_message
+---@nodiscard
 function load(chunk, chunkname, mode, env) end
 
 
@@ -315,6 +332,37 @@ function require(modname) end
 ---@return std.Select<T..., Num>
 function select(index, ...) end
 
+
+---@class std.metatable
+---@field __mode 'v'|'k'|'kv'|nil
+---@field __metatable any|nil
+---@field __tostring (fun(t):string)|nil
+---@field __gc fun(t)|nil
+---@field __add (fun(t1,t2):any)|nil
+---@field __sub (fun(t1,t2):any)|nil
+---@field __mul (fun(t1,t2):any)|nil
+---@field __div (fun(t1,t2):any)|nil
+---@field __mod (fun(t1,t2):any)|nil
+---@field __pow (fun(t1,t2):any)|nil
+---@field __unm (fun(t):any)|nil
+---@field __idiv (fun(t1,t2):any)|nil
+---@field __band (fun(t1,t2):any)|nil
+---@field __bor (fun(t1,t2):any)|nil
+---@field __bxor (fun(t1,t2):any)|nil
+---@field __bnot (fun(t):any)|nil
+---@field __shl (fun(t1,t2):any)|nil
+---@field __shr (fun(t1,t2):any)|nil
+---@field __concat (fun(t1,t2):any)|nil
+---@field __len (fun(t):integer)|nil
+---@field __eq (fun(t1,t2):boolean)|nil
+---@field __lt (fun(t1,t2):boolean)|nil
+---@field __le (fun(t1,t2):boolean)|nil
+---@field __index table|(fun(t,k):any)|nil
+---@field __newindex table|fun(t,k,v)|nil
+---@field __call (fun(t,...):...)|nil
+---@field __pairs (fun(t):((fun(t,k,v):any,any),any,any))|nil
+---@field __close (fun(t,errobj):any)|nil
+
 ---
 --- Sets the metatable for the given table. (To change the metatable of other
 --- types from Lua code, you must use the debug library.) If `metatable`
@@ -324,7 +372,7 @@ function select(index, ...) end
 --- This function returns `table`.
 ---@generic T
 ---@param table T
----@param metatable table
+---@param metatable std.metatable|table
 ---@return T
 function setmetatable(table, metatable) end
 
@@ -363,13 +411,23 @@ function tonumber(e, base) end
 ---@return string
 function tostring(v) end
 
+---@alias std.type
+---| "nil"
+---| "number"
+---| "string"
+---| "boolean"
+---| "table"
+---| "function"
+---| "thread"
+---| "userdata"
+
 ---
 --- Returns the type of its only argument, coded as a string. The possible
 --- results of this function are "`nil`" (a string, not the value **nil**),
 --- "`number`", "`string`", "`boolean`", "`table`", "`function`", "`thread`",
 --- and "`userdata`".
 ---@param v any
----@return string
+---@return std.type type
 function type(v) end
 
 ---

crates/emmylua_code_analysis/resources/std/io.lua

@@ -13,6 +13,7 @@
 -- License for the specific language governing permissions and limitations under
 -- the License.
 
+---@class iolib
 io = {}
 
 ---

crates/emmylua_code_analysis/resources/std/math.lua

@@ -13,6 +13,7 @@
 -- License for the specific language governing permissions and limitations under
 -- the License.
 
+---@class mathlib
 math = {}
 
 ---

crates/emmylua_code_analysis/resources/std/os.lua

@@ -13,6 +13,7 @@
 -- License for the specific language governing permissions and limitations under
 -- the License.
 
+---@class oslib
 os = {}
 
 ---
@@ -21,6 +22,17 @@ os = {}
 ---@return number
 function os.clock() end
 
+---@class std.osdate
+---@field year integer|string four digits
+---@field month integer|string 1-12
+---@field day integer|string 1-31
+---@field hour integer|string 0-23
+---@field min integer|string 0-59
+---@field sec integer|string 0-61, due to leap seconds
+---@field wday integer|string 1-7, Sunday is 1
+---@field yday integer|string 1-366
+---@field isdst boolean daylight saving flag, a boolean.
+
 ---
 --- Returns a string or a table containing date and time, formatted according
 --- to the given string `format`.
@@ -56,7 +68,7 @@ function os.clock() end
 ---@overload fun(fmt:"*t", time: number):table
 ---@param format string
 ---@param time? number
----@return string
+---@return string|std.osdate
 function os.date(format, time) end
 
 ---
@@ -147,6 +159,17 @@ function os.rename(oldname, newname) end
 ---@return string|nil
 function os.setlocale(locale, category) end
 
+---@class std.osdateparam
+---@field year integer|string four digits
+---@field month integer|string 1-12
+---@field day integer|string 1-31
+---@field hour (integer|string)? 0-23
+---@field min (integer|string)? 0-59
+---@field sec (integer|string)? 0-61, due to leap seconds
+---@field wday (integer|string)? 1-7, Sunday is 1
+---@field yday (integer|string)? 1-366
+---@field isdst boolean? daylight saving flag, a boolean. 
+
 ---
 --- Returns the current time when called without arguments, or a time
 --- representing the date and time specified by the given table. This table
@@ -170,9 +193,9 @@ function os.setlocale(locale, category) end
 --- documented in the `os.date` function, so that they represent the same time
 --- as before the call but with values inside their valid ranges.
 ---@overload fun():number
----@param table? table
+---@param date? std.osdateparam
 ---@return number
-function os.time(table) end
+function os.time(date) end
 
 ---
 --- Returns a string with a file name that can be used for a temporary

crates/emmylua_code_analysis/resources/std/package.lua

@@ -13,6 +13,7 @@
 -- License for the specific language governing permissions and limitations under
 -- the License.
 
+---@class packagelib
 package = {}
 
 ---
@@ -29,7 +30,12 @@ package = {}
 --- executable's directory. Default is '!'.
 --- The fifth line is a mark to ignore all text after it when building the
 --- luaopen_ function name. Default is '-'.
-package.config = ""
+package.config = [[
+/
+;
+?
+!
+-]]
 
 ---
 --- The path used by `require` to search for a C loader.

crates/emmylua_code_analysis/resources/std/table.lua

@@ -13,6 +13,7 @@
 -- License for the specific language governing permissions and limitations under
 -- the License.
 
+---@class tablelib
 table = {}
 
 ---

crates/emmylua_code_analysis/resources/std/utf8.lua

@@ -16,6 +16,7 @@
 -- the License.
 
 ---@version >5.3
+---@class utf8lib
 utf8 = {}
 
 ---

crates/emmylua_ls/locales/std/bit32/zh_CN.yaml

@@ -0,0 +1,77 @@
+std.bit32lib: |
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32"])
+
+std.bit32lib.arshift: |
+  返回 `x` 向右位移 `disp` 位的结果。`disp` 为负时向左位移。这是算数位移操作，左侧的空位使用 `x` 的高位填充，右侧空位使用 `0` 填充。
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.arshift"])
+
+std.bit32lib.band: |
+  返回参数按位与的结果。
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.band"])
+
+std.bit32lib.bnot: |
+  返回 `x` 按位取反的结果。
+
+  ```lua
+  assert(bit32.bnot(x) ==
+  (-1 - x) % 2^32)
+  ```
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.bnot"])
+
+std.bit32lib.bor: |
+  返回参数按位或的结果。
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.bor"])
+
+std.bit32lib.btest: |
+  参数按位与的结果不为0时，返回 `true` 。
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.btest"])
+
+std.bit32lib.bxor: |
+  返回参数按位异或的结果。
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.bxor"])
+
+std.bit32lib.extract: |
+  返回 `n` 中第 `field` 到第 `field + width - 1` 位组成的结果。
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.extract"])
+
+std.bit32lib.replace: |
+  返回 `v` 的第 `field` 到第 `field + width - 1` 位替换 `n` 的对应位后的结果。
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.replace"])
+
+std.bit32lib.lrotate: |
+  返回 `x` 向左旋转 `disp` 位的结果。`disp` 为负时向右旋转。
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.lrotate"])
+
+std.bit32lib.lshift: |
+  返回 `x` 向左位移 `disp` 位的结果。`disp` 为负时向右位移。空位总是使用 `0` 填充。
+
+  ```lua
+  assert(bit32.lshift(b, disp) ==
+  (b * 2^disp) % 2^32)
+  ```
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.lshift"])
+
+std.bit32lib.rrotate: |
+  返回 `x` 向右旋转 `disp` 位的结果。`disp` 为负时向左旋转。
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.rrotate"])
+
+std.bit32lib.rshift: |
+  返回 `x` 向右位移 `disp` 位的结果。`disp` 为负时向左位移。空位总是使用 `0` 填充。
+
+  ```lua
+  assert(bit32.lshift(b, disp) ==
+  (b * 2^disp) % 2^32)
+  ```
+
+  [查看文档](command:extension.lua.doc?["en-us/54/manual.html/pdf-bit32.rshift"])