LuaLS / LuaLS/lua-language-server
Feature: namespaced type definitions
還沒有人認領這個 Issue。
- 主要語言
- Lua
- 星號
- 4.4k
- 分支
- 442
- PR 合併指標
- 30 天內沒有已合併 PR
描述
This is yet another feature/enhancement idea to make annotations easier to read/write. Perhaps it's come up before, but I couldn't find any issues or discussions about it.
It's wise to namespace type definitions to avoid collisions with type definitions from other code. This can lead to painfully long type names (e.g. `my-project.db.entities.Foo`). This idea allows defining namespaces for utility and syntactic sugar.
Here is a semi-realistic example and application of this idea:
- file: `./my-library/db.lua`
```lua
--- Namespace declaration
---
--- All types declared in this file will be prefixed with the `my-library.db` namespace
--- identifier when used elsewhere.
---
---@namespace my-library.db
--- Database connection Handle
-- Locally, this can be referenced as `connection`. Files/modules with different namespaces can
-- reference it by it's fully-qualified name, `my-library.db.connection`
--
---@class connection
--- Database Connection Options
--
---@class opts
---@field host string
---@field port number
---@field user string
---@field pass string
--- Establish a new DB connection
---@param opts opts
---@return connection? conn
---@return string? error
return function(opts) end
```
- file: `./my-library/db/migration.lua`
```lua
--- namespaces can be re-used
---@namespace my-library.db
--- usable locally as `migration.status`, exports as `my-library.db.migration.status`
---
---@alias migration.status
---| 0 # pending
---| 1 # executing
---| 2 # complete
---| 3 # error
--- exported as `my-library.db.migration.opts`
---
---@class migration.opts
---@field name string
---@field run_in_transaction boolean
---
---@class migration
---@field status migration.status
---@field name string
local migration = {}
--- Execute the migration
---@param db connection
---@return boolean ok
---@return string? error
function migration:exec(db) end
--- Check migration status
---@param db connection
---@return migration.status
function migration:status(db) end
local _M = {}
--- Create a new DB migration
---@param opts migration.opts
function _M.new(opts) end
--- List all migrations
---@param db connection
---@return migration[]
function _M.list(db) end
return _M
```
- file: `./my-library/utils.lua`
```lua
---@namespace my-library
local db = require "my-library.db"
local migrations = require "my-library.db.migrations"
local _M = {}
--- Check to see if any migrations need to be executed
---@param opts db.opts # options for connecting to the database server
function _M.check_migrations(opts)
-- the displayed type for `conn` is `db.connection`, because the current namespace is `my-library`
local conn = db(opts)
for _, m in ipairs(migrations.list(conn)) do
-- displayed type for `m` is `db.migration`
-- displayed type for `status` is `db.migration.status`
local status = m:status(conn)
print("migration: ", m.name, ", status: ", status)
end
end
return _M
```
* namespaces are just labels/aliases, so they can be shared and re-used between files
* types are resolved by checking the local namespace before searching the global namespace
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
該 issue 提供了位於 ./my-library/db.lua、./my-library/db/migration.lua 和 ./my-library/utils.lua 的 Lua 範例檔案,但沒有指出儲存庫中的實作檔案或測試。首先追蹤語言伺服器目前如何解析型別定義和註解,然後確定應如何表示 namespace 宣告以及區域名稱和完整限定名稱。完成的標準是:所有範例中的帶有 namespace 的類別、別名、欄位和參照都能一致地解析。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- lua
- 領域
- devtools
- Issue 類型
- 功能
- 難度
- 5/5
- 預估耗時
- 一週以上
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100