LuaLS / LuaLS/lua-language-server

Mass renaming proposal

オープン
#1,404 コメント 10 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、この issue で提案されている設定、診断コード、構文エラーの名称変更と、リンクされている issue #1364 および #1384 を確認します。最初に、どの名称と機能変更が受け入れられるかを判断してください。完了とするには、個別の変更ではなく、合意された完全な名称変更計画が必要です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
lua
領域
devtools
issue の種類
リファクタリング
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。