Hacktoberfest 2026：維護者為十月標記出來的 issue，仍然開放、適合新手。 瀏覽 Hacktoberfest issue

[Feature Request] Primitive Type Extensions / Metatable Override Support

未關閉
  • 哪裡不對？
#3,297 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
25/100
Issue 類型
功能
描述清晰度
需要釐清
活躍度
停滯
技術堆疊
lua
領域
devtools

研究方向

首先查看 issue #2065 以及其中連結的 sugar.lua 範例，因為這裡沒有指出任何儲存庫檔案或測試。確定註解應如何為原始型別和表格提供自訂擴充與索引支援，並確保補全和診斷涵蓋 issue 中描述的 number、string 和 table 範例。

由索引模型根據 Issue 內容生成。

描述

Hello, I am not sure if this is something that is already possible to annotate, but I am not able to figure out how to get this to work.

By default, Lua does not have full indexing support with its base primitive types. Due to this, it is not possible to do certain things such as chaining method calls, indexing certain types in a way that feels natural, or doing some more 'common-practice' things in other languages.

Take the following examples that are invalid, by default:

local num_test = 2;
print(num_test:pow(2)); -- Error: attempt to index local 'num_test' (a number value)

local str_test = 'Hello World';
print(str_test[1]); -- Error: (returns nil)

local tbl_test = { 1, 2, 3, 4 };
print(tbl_test:remove(1)); -- Error: attempt to call method 'remove' (a nil value)

However, Lua does offer the means to enable this features in a legit manner by using the debug.setmetatable function. The above examples can be made valid by doing the following:

local math_mt = {};     -- Table to hold custom math extension methods.
local string_mt = {};   -- Table to hold custom string extension methods.
local table_mt = {};   -- Table to hold custom table extension methods.

-- Number Metatable Override
debug.setmetatable(0, {
    __index = function (_, k)
        return
            math[k] or
            math_mt[k] or
            error(string.format('Number type does not contain a definition for: %s', tostring(k)));
    end,
});

-- String Metatable Override
debug.setmetatable('', {
    __index = function (self, k)
        return
            string[k] or
            string_mt[k] or
            type(k) == 'number' and (k == 0 and #self or string.sub(self, k, k)) or
            error(string.format('String type does not contain a definition for: %s', tostring(k)));
    end,
});

Additionally, with this kind of setup, someone can then extend the built-in tables for things like math, string, table, etc. by adding things to the respective extension tables. For example, I can add new string extensions such as:

string_mt.starts_with = function (self, s)
    return self:sub(0, #s) == s;
end

string_mt.ends_with = function (self, s)
    return self:sub(-#s) == s;
end

For tables, you can also extend them to add indexing through a helper such as:

T = function (t)
    return setmetatable(t or { }, {
        __index = function (_, k)
            return table_mt[k] or table[k];
        end
    });
end

Doing this would allow indexing a table directly, such as:

local tbl = T({ 1, 2, 3, 4 });
print(tbl:remove(1));

My issue is that I do not see a way to properly annotate this kind of setup so that I can get proper intellisense on the various primitive types with my custom extensions and the added indexing to the types that normally don't have it.

Using the examples above, I should be able to do the following and have the intellisense pickup my extensions:

local num = 2;
print(num:pow(2));
print(num:add(2)); -- Assuming 'add' is an extension method in the 'math_mt' table.
print(math.add(num, 2));

local str = 'Hello world';
print(str:starts_with('H'));
print(('test'):ends_with('st'));
print(string.starts_with('test', 'te'));
print(str[1]);

And so on.

Searching past issues, I've only seen one that slightly mentioned this kind of thing here: https://github.com/LuaLS/lua-language-server/issues/2065

To give a more full-scale example of this kind of setup and what I am doing/referring to, you can see this in use via my sugar library for one of my projects here:

主要語言
Lua
星號
4.4k
分支
442
平均合併
8 天 9 小時
30 天內合併 PR
1

環境準備

從這裡開始

  1. 先讀完整個 Issue，再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫，在一個分支上完成修改。
  4. 送出 Pull Request，並在描述裡引用這個 Issue 編號。

LuaLS/lua-language-server 的其他 Issue

查看 LuaLS/lua-language-server 的全部 Issue

相似的 Issue

更多 Lua Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。