LuaLS / LuaLS/lua-language-server

Mass renaming proposal

Đang mở
#1,404 10 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

suggestion
Ngôn ngữ chính
Lua
Star
4.4k
Fork
442
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách xem xét các cài đặt, mã chẩn đoán và các thay đổi tên lỗi cú pháp được đề xuất trong issue này, cùng với các issue được liên kết #1364 và #1384. Trước tiên, hãy xác định những tên và thay đổi chức năng nào được chấp nhận; để được coi là hoàn tất, cần có một kế hoạch đổi tên đầy đủ đã được thống nhất thay vì một thay đổi riêng lẻ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
lua
Lĩnh vực
devtools
Loại issue
Tái cấu trúc
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.