LuaLS / LuaLS/lua-language-server

Mass renaming proposal

未关闭
#1,404 10 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

suggestion
主要语言
Lua
星标
4.4k
派生
442
PR 合并指标
30 天内没有已合并 PR

描述

There are a number of settings, diagnostics, and more that have unclear names that I think can be improved. This issue serves to propose new names for these items so that they can all be tracked in one place and implemented at once to minimize the number of breaking releases that would need to be released.

Settings

  • completion.displayContext -> completion.peekDefinition
    • There is already a Peek Definition command in VS Code that has a similar function and I think naming it the same will help people understand its function without confusing the two as they are triggered entirely differently.
  • diagnostics.disable -> REMOVE
  • diagnostics.groupFileStatus -> REMOVE
  • diagnostics.groupSeverity -> REMOVE
  • diagnostics.ignoreFiles -> diagnostics.diagnoseIgnored
  • diagnostics.libraryFiles -> diagnostics.diagnoseLibraries
  • diagnostics.neededFileStatus -> diagnostics.config (Rework functionality)
  • diagnostics.severity (Rework functionality)
  • diagnostics.workspaceDelay -> diagnostics.delay
  • hint.setType -> hint.assignType
  • hover.enumsLimit -> hover.typesLimit
  • hover.previewFields -> hover.peekFields
  • runtime.special -> runtime.aliases
  • workspace.checkThirdParty -> workspace.checkEnvConfigs
  • workspace.ignoreDir -> workspace.ignore
  • workspace.library -> workspace.libraries
  • workspace.maxPreload -> workspace.maxFiles
  • workspace.preloadFileSize -> workspace.maxFileSize
  • workspace.userThirdParty -> workspace.envConfig

Diagnostics

I imagine there is a good reason abiguity-1 is named how it is 😄 I see they all have at least 1 hyphen so I guess that is a limitation with how they are parsed?

  • unknown-diag-code -> unknown-diagnostic
  • cast-local-type -> local-cast-mismatch

Syntax Errors

Luckily these can probably be changed with very little impact on the user and most people likely would not have any settings related to these.

  • err-assign-as-eq -> assign-with-equals
  • err-c-long-comment -> multiline-comment-prefix
  • err-comment-prefix -> comment-prefix
  • err-do-as-then -> then-as-do
  • err-eq-as-assign -> equality-with-assign
  • err-esc -> unknown-escape
  • err-nonstandard-symbol -> non-standard-symbol
  • err-then-as-do -> do-as-then
  • exp-in-action -> unexpected-expression
  • keyword -> reserved
  • miss-esc-x -> miss-hex-value
  • miss-exp -> miss-expression

newfield-call and newline-call are not easy to understand but I can't think of anything that does a better job 🤔

I don't even know what these do: unexpect-efunc-name, unexpect-lfunc-name


Please let me know what you think and feel free to suggest other names.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先审查此 issue 中提出的设置、诊断代码和语法错误重命名,以及链接的 issues #1364 和 #1384。首先确定哪些名称和功能变更已获接受;要视为完成,需要一份经过同意的完整重命名计划,而不是孤立的修改。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua
领域
devtools
Issue 类型
重构
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。