Deprecate language IDs configuration file (#2586)

* Remove language IDs configuration file

* make this a non breaking change

* fix typos

* tweak wording

* remove comment

---------

Co-authored-by: Предраг Николић <[email protected]>

Author: jwortmann

Default.sublime-commands

@@ -16,15 +16,6 @@
             "default": "[\n\t$0\n]\n",
         }
     },
-    {
-        "caption": "Preferences: LSP Language ID Mapping Overrides",
-        "command": "edit_settings",
-        "args": {
-            "base_file": "${packages}/LSP/language-ids.sublime-settings",
-            "user_file": "${packages}/User/language-ids.sublime-settings",
-            "default": "// SublimeText base scope -> LSP Language ID overrides\n{\n\t// \"source.mylanguage\": \"mylang\"\n\t$0\n}\n"
-        }
-    },
     {
         "caption": "Preferences: LSP Utils Settings",
         "command": "edit_settings",

Main.sublime-menu

@@ -307,15 +307,6 @@
                   "default": "[\n\t$0\n]\n",
                 }
               },
-              {
-                "caption": "Base Scope to Language ID Mapping",
-                "command": "edit_settings",
-                "args": {
-                  "base_file": "${packages}/LSP/language-ids.sublime-settings",
-                  "user_file": "${packages}/User/language-ids.sublime-settings",
-                  "default": "// SublimeText base scope -> LSP Language ID overrides\n{\n\t// \"source.mylanguage\": \"mylang\"\n\t$0\n}\n"
-                }
-              }
             ]
           }
         ]

boot.py

@@ -199,7 +199,14 @@ def plugin_loaded() -> None:
     windows.enable()
     _register_all_plugins()
     client_configs.update_configs()
+    # TODO: remove this in the next minor release
+    base_scope_map = sublime.load_settings("language-ids.sublime-settings")
+    if base_scope_map.to_dict():
+        def show_warning():
+            print("LSP - The language-ids.sublime-settings file is deprecated, but it looks like you have it.\nSee the migration guide -> https://github.com/sublimelsp/LSP/issues/2592")
+            sublime.status_message("LSP - The language-ids.sublime-settings file is deprecated. Open the Console for details.")
 
+        sublime.set_timeout(show_warning, 5_000)
 
 def plugin_unloaded() -> None:
     _unregister_all_plugins()

language-ids.sublime-settings

@@ -0,0 +1,8 @@
+=> 2.4.0
+
+# Breaking changes
+
+- The language-ids.sublime-settings configuration file has been deprecated and will be removed in the next minor release of LSP. The language IDs are
+  hardcoded now. Language IDs are used by servers which handle more than one language to avoid
+  re-interpreting file extensions. If you used the configuration file and think that a language ID
+  is wrong or missing, please follow this migration guide https://github.com/sublimelsp/LSP/issues/2592.

messages/2.4.0.txt

@@ -178,6 +178,45 @@ class RegionKey(StrEnum):
     DocumentHighlightKind.Write: "region.yellowish markup.highlight.write.lsp"
 }
 
+# These are the "exceptional" base scopes. If a base scope is not in this map, nor the first two components or more
+# match any of the entries here, then the rule is that we split the base scope on the ".", and take the second
+# component. The resulting string is assumed to be the language ID. The official list is maintained at
+# https://microsoft.github.io/language-server-protocol/specification#textDocumentItem
+LANGUAGE_IDENTIFIERS = {
+    "source.c++": "cpp",
+    "source.coffee": "coffeescript",
+    "source.cs": "csharp",
+    "source.dosbatch": "bat",
+    "source.fixedform-fortran": "fortran",  # https://packagecontrol.io/packages/Fortran
+    "source.js": "javascript",
+    "source.js.react": "javascriptreact",  # https://github.com/Thom1729/Sublime-JS-Custom
+    "source.json-tmlanguage": "jsonc",  # https://github.com/SublimeText/PackageDev
+    "source.json.sublime": "jsonc",  # https://github.com/SublimeText/PackageDev
+    "source.jsx": "javascriptreact",
+    "source.Kotlin": "kotlin",  # https://github.com/vkostyukov/kotlin-sublime-package
+    "source.modern-fortran": "fortran",  # https://packagecontrol.io/packages/Fortran
+    "source.objc": "objective-c",
+    "source.objc++": "objective-cpp",
+    "source.shader": "shaderlab",  # https://github.com/waqiju/unity_shader_st3
+    "source.shell": "shellscript",
+    "source.ts": "typescript",
+    "source.ts.react": "typescriptreact",  # https://github.com/Thom1729/Sublime-JS-Custom
+    "source.tsx": "typescriptreact",
+    "source.unity.unity_shader": "shaderlab",  # https://github.com/petereichinger/Unity3D-Shader
+    "source.yaml-tmlanguage": "yaml",  # https://github.com/SublimeText/PackageDev
+    "text.advanced_csv": "csv",  # https://github.com/SublimeText/AFileIcon
+    "text.django": "html",  # https://github.com/willstott101/django-sublime-syntax
+    "text.html.handlebars": "handlebars",
+    "text.html.markdown": "markdown",
+    "text.html.markdown.rmarkdown": "r",  # https://github.com/REditorSupport/sublime-ide-r
+    "text.html.vue": "vue",
+    "text.jinja": "html",  # https://github.com/Sublime-Instincts/BetterJinja
+    "text.plain": "plaintext",
+    "text.plist": "xml",  # https://bitbucket.org/fschwehn/sublime_plist
+    "text.tex.latex": "latex",
+    "text.xml.xsl": "xsl",
+}
+
 SEMANTIC_TOKENS_MAP = {
     "namespace": "variable.other.namespace.lsp",
     "namespace.declaration": "entity.name.namespace.lsp",

plugin/core/constants.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 from .collections import DottedDict
+from .constants import LANGUAGE_IDENTIFIERS
 from .file_watcher import FileWatcherEventType
 from .logging import debug, set_debug_logging
 from .protocol import ServerCapabilities, TextDocumentSyncKind, TextDocumentSyncOptions
@@ -39,8 +40,10 @@ def basescope2languageid(base_scope: str) -> str:
     result = ""
     # Try to find exact match or less specific match consisting of at least 2 components.
     scope_parts = base_scope.split('.')
+    # TODO: remove base_scope_map in the next minor release
+    language_map = {**LANGUAGE_IDENTIFIERS, **base_scope_map.to_dict()}
     while len(scope_parts) >= 2:
-        result = base_scope_map.get('.'.join(scope_parts))
+        result = language_map.get('.'.join(scope_parts))
         if result:
             break
         scope_parts.pop()