Split Roblox-specific functionality into dedicated interface

CHANGELOG.md

@@ -6,6 +6,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 
+### Deprecated
+
+- Deprecated `luau-lsp.types.roblox` setting in favour of `luau-lsp.platform.type`
+- Deprecated `luau-lsp.completion.imports.suggestServices` setting in favour of `luau-lsp.platform.roblox.suggestServices`
+- Deprecated `luau-lsp.sourcemap.*` settings in favour of `luau-lsp.platform.roblox.sourcemap.*`
+- Deprecated `luau-lsp.plugin.*` settings in favour of `luau-lsp.platform.roblox.plugin.*`
+- Deprecated `luau-lsp.types.robloxSecurityLevel` setting in favour of `luau-lsp.platform.roblox.typesSecurityLevel`
+
+### Added
+
+- Added `luau-lsp.platform.type` to separate platform-specific functionality from the main LSP
+- Added option `--platform` to analyze CLI to make configuring `luau-lsp.platform.type` more convenient
+
 ### Changed
 
 - Sync to upstream Luau 0.612

CMakeLists.txt

@@ -15,15 +15,23 @@ target_sources(Luau.LanguageServer PRIVATE
         src/Uri.cpp
         src/WorkspaceFileResolver.cpp
         src/Workspace.cpp
-        src/Sourcemap.cpp
         src/TextDocument.cpp
         src/Client.cpp
         src/DocumentationParser.cpp
         src/LuauExt.cpp
         src/IostreamHelpers.cpp
         src/Utils.cpp
-        src/StudioPlugin.cpp
         src/CliConfigurationParser.cpp
+        src/platform/LSPPlatform.cpp
+        src/platform/roblox/RobloxCodeAction.cpp
+        src/platform/roblox/RobloxColorProvider.cpp
+        src/platform/roblox/RobloxCompletion.cpp
+        src/platform/roblox/RobloxFileResolver.cpp
+        src/platform/roblox/RobloxLanguageServer.cpp
+        src/platform/roblox/RobloxLuauExt.cpp
+        src/platform/roblox/RobloxSourcemap.cpp
+        src/platform/roblox/RobloxSourceNode.cpp
+        src/platform/roblox/RobloxStudioPlugin.cpp
         src/operations/Diagnostics.cpp
         src/operations/Completion.cpp
         src/operations/DocumentSymbol.cpp

README.md

@@ -29,7 +29,7 @@ looking for any specific features, please get in touch!
 ### For Rojo Users (requires `v7.3.0+`)
 
 By default, the latest Roblox type definitions and documentation are preloaded out of the box.
-This can be disabled by configuring `luau-lsp.types.roblox`.
+This can be disabled by configuring `luau-lsp.platform.type`.
 
 The language server uses Rojo-style sourcemaps to resolve DataModel instance trees for intellisense.
 This is done by running `rojo sourcemap --watch default.project.json --output sourcemap.json`.
@@ -38,10 +38,10 @@ file to your `.gitignore`.
 
 The following settings are configurable for sourcemap generation:
 
-- `luau-lsp.sourcemap.enabled`: Whether sourcemap support is enabled (default: on)
-- `luau-lsp.sourcemap.autogenerate`: Whether sourcemaps are automatically generated by the client. If disabled, the server will listen to manual changes to a `sourcemap.json` file (default: on)
-- `luau-lsp.sourcemap.rojoProjectFile`: What project file to use (default: `default.project.json`)
-- `luau-lsp.sourcemap.includeNonScripts`: Whether to include non script instances in the sourcemap. May be disabled for expensive DataModels (default: on)
+- `luau-lsp.platform.roblox.sourcemap.enabled`: Whether sourcemap support is enabled (default: on)
+- `luau-lsp.platform.roblox.sourcemap.autogenerate`: Whether sourcemaps are automatically generated by the client. If disabled, the server will listen to manual changes to a `sourcemap.json` file (default: on)
+- `luau-lsp.platform.roblox.sourcemap.rojoProjectFile`: What project file to use (default: `default.project.json`)
+- `luau-lsp.platform.roblox.sourcemap.includeNonScripts`: Whether to include non script instances in the sourcemap. May be disabled for expensive DataModels (default: on)
 
 If you do not use Rojo, you can still use the Luau Language Server, you just need to manually generate a `sourcemap.json`
 file for your particular project layout.

editors/code/package.json

@@ -138,31 +138,87 @@
           ],
           "scope": "resource"
         },
+        "luau-lsp.platform.type": {
+          "markdownDescription": "Platform-specific support features",
+          "type": "string",
+          "enum": [
+            "standard",
+            "roblox"
+          ],
+          "scope": "window",
+          "default": "roblox"
+        },
+        "luau-lsp.platform.roblox.suggestServices": {
+          "markdownDescription": "Whether `GetService` completions are suggested in autocomplete when `#luau-lsp.completion.imports.enabled#` is `true`",
+          "type": "boolean",
+          "default": true,
+          "scope": "resource"
+        },
         "luau-lsp.sourcemap.enabled": {
           "markdownDescription": "Whether Rojo sourcemap parsing is enabled",
           "type": "boolean",
           "default": true,
-          "scope": "resource"
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: Please use `#luau-lsp.platform.roblox.sourcemap.enabled#` instead.",
+          "deprecationMessage": "Deprecated: Please use luau-lsp.platform.roblox.sourcemap.enabled instead."
         },
         "luau-lsp.sourcemap.autogenerate": {
           "markdownDescription": "Automatically run the `rojo sourcemap` command to regenerate sourcemaps on changes",
           "type": "boolean",
           "default": true,
-          "scope": "resource"
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: Please use `#luau-lsp.platform.roblox.sourcemap.autogenerate#` instead.",
+          "deprecationMessage": "Deprecated: Please use luau-lsp.platform.roblox.sourcemap.autogenerate instead."
         },
         "luau-lsp.sourcemap.rojoPath": {
           "markdownDescription": "Path to the Rojo executable. If not provided, attempts to run `rojo` in the workspace directory, so it must be available on the PATH",
           "type": "string",
           "default": null,
-          "scope": "resource"
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: Please use `#luau-lsp.platform.roblox.sourcemap.rojoPath#` instead.",
+          "deprecationMessage": "Deprecated: Please use luau-lsp.platform.roblox.sourcemap.rojoPath instead."
         },
         "luau-lsp.sourcemap.rojoProjectFile": {
           "markdownDescription": "The name of the Rojo project file to generate a sourcemap for.\nOnly applies if `#luau-lsp.sourcemap.autogenerate#` is enabled",
           "type": "string",
           "default": "default.project.json",
-          "scope": "resource"
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: Please use `#luau-lsp.platform.roblox.sourcemap.rojoProjectFile#` instead.",
+          "deprecationMessage": "Deprecated: Please use luau-lsp.platform.roblox.sourcemap.rojoProjectFile instead."
         },
         "luau-lsp.sourcemap.includeNonScripts": {
+          "markdownDescription": "Include non-script instances in the generated sourcemap",
+          "type": "boolean",
+          "default": true,
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: Please use `#luau-lsp.platform.roblox.sourcemap.includeNonScripts#` instead.",
+          "deprecationMessage": "Deprecated: Please use luau-lsp.platform.roblox.sourcemap.includeNonScripts instead."
+        },
+        "luau-lsp.platform.roblox.sourcemap.enabled": {
+          "markdownDescription": "Whether Rojo sourcemap parsing is enabled",
+          "type": "boolean",
+          "default": true,
+          "scope": "resource"
+        },
+        "luau-lsp.platform.roblox.sourcemap.autogenerate": {
+          "markdownDescription": "Automatically run the `rojo sourcemap` command to regenerate sourcemaps on changes",
+          "type": "boolean",
+          "default": true,
+          "scope": "resource"
+        },
+        "luau-lsp.platform.roblox.sourcemap.rojoPath": {
+          "markdownDescription": "Path to the Rojo executable. If not provided, attempts to run `rojo` in the workspace directory, so it must be available on the PATH",
+          "type": "string",
+          "default": null,
+          "scope": "resource"
+        },
+        "luau-lsp.platform.roblox.sourcemap.rojoProjectFile": {
+          "markdownDescription": "The name of the Rojo project file to generate a sourcemap for.\nOnly applies if `#luau-lsp.sourcemap.autogenerate#` is enabled",
+          "type": "string",
+          "default": "default.project.json",
+          "scope": "resource"
+        },
+        "luau-lsp.platform.roblox.sourcemap.includeNonScripts": {
           "markdownDescription": "Include non-script instances in the generated sourcemap",
           "type": "boolean",
           "default": true,
@@ -205,6 +261,14 @@
           "scope": "resource"
         },
         "luau-lsp.diagnostics.strictDatamodelTypes": {
+          "markdownDescription": "Use strict DataModel types in diagnostics. When on, this is equivalent to the more expressive autocompletion types. When this is off, `game`/`script`/`workspace` (and their members) are all typed as `any`, and helps to prevent false positives. [Read More](https://github.com/JohnnyMorganz/luau-lsp/issues/83#issuecomment-1192865024)",
+          "type": "boolean",
+          "default": false,
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: Please use `#luau-lsp.platform.roblox.diagnostics.strictDatamodelTypes#` instead.",
+          "deprecationMessage": "Deprecated: Please use luau-lsp.platform.roblox.diagnostics.strictDatamodelTypes instead."
+        },
+        "luau-lsp.platform.roblox.diagnostics.strictDatamodelTypes": {
           "markdownDescription": "Use strict DataModel types in diagnostics. When on, this is equivalent to the more expressive autocompletion types. When this is off, `game`/`script`/`workspace` (and their members) are all typed as `any`, and helps to prevent false positives. [Read More](https://github.com/JohnnyMorganz/luau-lsp/issues/83#issuecomment-1192865024)",
           "type": "boolean",
           "default": false,
@@ -235,9 +299,25 @@
           "scope": "window",
           "tags": [
             "usesOnlineServices"
-          ]
+          ],
+          "markdownDeprecationMessage": "**Deprecated**: Please use `#luau-lsp.platform.type#` instead.",
+          "deprecationMessage": "Deprecated: Please use luau-lsp.platform.type instead."
         },
         "luau-lsp.types.robloxSecurityLevel": {
+          "markdownDescription": "Security Level to use in the Roblox API definitions",
+          "type": "string",
+          "default": "PluginSecurity",
+          "scope": "window",
+          "enum": [
+            "None",
+            "LocalUserSecurity",
+            "PluginSecurity",
+            "RobloxScriptSecurity"
+          ],
+          "markdownDeprecationMessage": "**Deprecated**: Please use `#luau-lsp.platform.roblox.typesSecurityLevel#` instead.",
+          "deprecationMessage": "Deprecated: Please use luau-lsp.platform.roblox.typesSecurityLevel instead."
+        },
+        "luau-lsp.platform.roblox.typesSecurityLevel": {
           "markdownDescription": "Security Level to use in the Roblox API definitions",
           "type": "string",
           "default": "PluginSecurity",
@@ -377,7 +457,9 @@
           "markdownDescription": "Whether GetService completions are suggested in autocomplete",
           "type": "boolean",
           "default": true,
-          "scope": "resource"
+          "scope": "resource",
+          "markdownDeprecationMessage": "**Deprecated**: Please use `#luau-lsp.platform.roblox.suggestServices#` instead.",
+          "deprecationMessage": "Deprecated: Please use luau-lsp.platform.roblox.suggestServices instead."
         },
         "luau-lsp.completion.imports.suggestRequires": {
           "markdownDescription": "Whether module requires are suggested in autocomplete",
@@ -413,18 +495,34 @@
           "default": true,
           "scope": "resource"
         },
-        "luau-lsp.plugin.enabled": {
+        "luau-lsp.platform.roblox.plugin.enabled": {
           "markdownDescription": "Use Roblox Studio Plugin to provide DataModel information",
           "type": "boolean",
           "default": false,
           "scope": "window"
         },
-        "luau-lsp.plugin.port": {
+        "luau-lsp.platform.roblox.plugin.port": {
           "markdownDescription": "Port number to connect to the Studio Plugin",
           "type": "number",
           "default": 3667,
           "scope": "window"
         },
+        "luau-lsp.plugin.enabled": {
+          "markdownDescription": "Use Roblox Studio Plugin to provide DataModel information",
+          "type": "boolean",
+          "default": false,
+          "scope": "window",
+          "markdownDeprecationMessage": "**Deprecated**: Please use `#luau-lsp.platform.roblox.plugin.enabled#` instead.",
+          "deprecationMessage": "Deprecated: Please use luau-lsp.platform.roblox.plugin.enabled instead."
+        },
+        "luau-lsp.plugin.port": {
+          "markdownDescription": "Port number to connect to the Studio Plugin",
+          "type": "number",
+          "default": 3667,
+          "scope": "window",
+          "markdownDeprecationMessage": "**Deprecated**: Please use `#luau-lsp.platform.roblox.plugin.port#` instead.",
+          "deprecationMessage": "Deprecated: Please use luau-lsp.platform.roblox.plugin.port instead."
+        },
         "luau-lsp.require.mode": {
           "markdownDescription": "How string requires should be interpreted",
           "type": "string",