@astrojs/language-server 0.19.0 → 0.19.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @astrojs/language-server
 
+## 0.19.1
+
+### Patch Changes
+
+- 729dff5: Add support for giving linked editing ranges
+- 05a48c2: Fix some TypeScript diagnostics not showing up in certain cases
+- fe2d26b: Add support for showing Svelte components documentation on hover
+- Updated dependencies [fe2d26b]
+  - @astrojs/svelte-language-integration@0.1.5
+
 ## 0.19.0
 
 ### Minor Changes

package/dist/plugins/PluginHost.d.ts

@@ -1,4 +1,4 @@
-import { CancellationToken, Color, ColorInformation, ColorPresentation, CompletionContext, CompletionItem, CompletionList, DefinitionLink, Diagnostic, FoldingRange, Hover, Position, Range, Location, SignatureHelp, SignatureHelpContext, TextDocumentContentChangeEvent, TextDocumentIdentifier, WorkspaceEdit, SymbolInformation, SemanticTokens, CodeActionContext, CodeAction, InlayHint, FormattingOptions, TextEdit } from 'vscode-languageserver';
+import { CancellationToken, Color, ColorInformation, ColorPresentation, CompletionContext, CompletionItem, CompletionList, DefinitionLink, Diagnostic, FoldingRange, Hover, Position, Range, Location, SignatureHelp, SignatureHelpContext, TextDocumentContentChangeEvent, TextDocumentIdentifier, WorkspaceEdit, SymbolInformation, SemanticTokens, CodeActionContext, CodeAction, InlayHint, FormattingOptions, TextEdit, LinkedEditingRanges } from 'vscode-languageserver';
 import type { AppCompletionItem, Plugin } from './interfaces';
 import { DocumentManager } from '../core/documents/DocumentManager';
 interface PluginHostConfig {
@@ -22,6 +22,7 @@ export declare class PluginHost {
     getFoldingRanges(textDocument: TextDocumentIdentifier): Promise<FoldingRange[] | null>;
     getDocumentSymbols(textDocument: TextDocumentIdentifier, cancellationToken: CancellationToken): Promise<SymbolInformation[]>;
     getSemanticTokens(textDocument: TextDocumentIdentifier, range?: Range, cancellationToken?: CancellationToken): Promise<SemanticTokens | null>;
+    getLinkedEditingRanges(textDocument: TextDocumentIdentifier, position: Position): Promise<LinkedEditingRanges | null>;
     getDefinitions(textDocument: TextDocumentIdentifier, position: Position): Promise<DefinitionLink[] | Location[]>;
     rename(textDocument: TextDocumentIdentifier, position: Position, newName: string): Promise<WorkspaceEdit | null>;
     getDocumentColors(textDocument: TextDocumentIdentifier): Promise<ColorInformation[]>;

package/dist/plugins/PluginHost.js

@@ -94,6 +94,10 @@ class PluginHost {
         const document = this.getDocument(textDocument.uri);
         return await this.execute('getSemanticTokens', [document, range, cancellationToken], ExecuteMode.FirstNonNull);
     }
+    async getLinkedEditingRanges(textDocument, position) {
+        const document = this.getDocument(textDocument.uri);
+        return await this.execute('getLinkedEditingRanges', [document, position], ExecuteMode.FirstNonNull);
+    }
     async getDefinitions(textDocument, position) {
         const document = this.getDocument(textDocument.uri);
         const definitions = (0, lodash_1.flatten)(await this.execute('getDefinitions', [document, position], ExecuteMode.Collect));

package/dist/plugins/html/HTMLPlugin.d.ts

@@ -1,4 +1,4 @@
-import { CompletionList, Position, TextEdit, FoldingRange, Hover, SymbolInformation, FormattingOptions } from 'vscode-languageserver';
+import { CompletionList, Position, TextEdit, FoldingRange, Hover, SymbolInformation, FormattingOptions, LinkedEditingRanges } from 'vscode-languageserver';
 import type { Plugin } from '../interfaces';
 import { ConfigManager } from '../../core/config/ConfigManager';
 import { AstroDocument } from '../../core/documents/AstroDocument';
@@ -17,6 +17,7 @@ export declare class HTMLPlugin implements Plugin {
     getCompletions(document: AstroDocument, position: Position): Promise<CompletionList | null>;
     formatDocument(document: AstroDocument, options: FormattingOptions): Promise<TextEdit[]>;
     getFoldingRanges(document: AstroDocument): FoldingRange[] | null;
+    getLinkedEditingRanges(document: AstroDocument, position: Position): LinkedEditingRanges | null;
     doTagComplete(document: AstroDocument, position: Position): Promise<string | null>;
     getDocumentSymbols(document: AstroDocument): Promise<SymbolInformation[]>;
     /**

package/dist/plugins/html/HTMLPlugin.js

@@ -105,6 +105,17 @@ class HTMLPlugin {
         }
         return this.lang.getFoldingRanges(document);
     }
+    getLinkedEditingRanges(document, position) {
+        const html = document.html;
+        if (!html) {
+            return null;
+        }
+        const ranges = this.lang.findLinkedEditingRanges(document, position, html);
+        if (!ranges) {
+            return null;
+        }
+        return { ranges };
+    }
     async doTagComplete(document, position) {
         if (!(await this.featureEnabled(document, 'tagComplete'))) {
             return null;

package/dist/plugins/typescript/features/DiagnosticsProvider.d.ts

@@ -3,6 +3,17 @@ import { Diagnostic } from 'vscode-languageserver-types';
 import { AstroDocument } from '../../../core/documents';
 import { DiagnosticsProvider } from '../../interfaces';
 import { LanguageServiceManager } from '../LanguageServiceManager';
+export declare enum DiagnosticCodes {
+    SPREAD_EXPECTED = 1005,
+    DUPLICATED_JSX_ATTRIBUTES = 17001,
+    MUST_HAVE_PARENT_ELEMENT = 2657,
+    CANNOT_IMPORT_TS_EXT = 2691,
+    CANT_RETURN_OUTSIDE_FUNC = 1108,
+    ISOLATED_MODULE_COMPILE_ERR = 1208,
+    TYPE_NOT_ASSIGNABLE = 2322,
+    JSX_NO_CLOSING_TAG = 17008,
+    NO_DECL_IMPLICIT_ANY_TYPE = 7016
+}
 export declare class DiagnosticsProviderImpl implements DiagnosticsProvider {
     private readonly languageServiceManager;
     constructor(languageServiceManager: LanguageServiceManager);

package/dist/plugins/typescript/features/DiagnosticsProvider.js

@@ -3,11 +3,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DiagnosticsProviderImpl = void 0;
+exports.DiagnosticsProviderImpl = exports.DiagnosticCodes = void 0;
 const typescript_1 = __importDefault(require("typescript"));
 const vscode_languageserver_types_1 = require("vscode-languageserver-types");
 const documents_1 = require("../../../core/documents");
 const utils_1 = require("../utils");
+// List of codes:
+// https://github.com/Microsoft/TypeScript/blob/main/src/compiler/diagnosticMessages.json
+var DiagnosticCodes;
+(function (DiagnosticCodes) {
+    DiagnosticCodes[DiagnosticCodes["SPREAD_EXPECTED"] = 1005] = "SPREAD_EXPECTED";
+    DiagnosticCodes[DiagnosticCodes["DUPLICATED_JSX_ATTRIBUTES"] = 17001] = "DUPLICATED_JSX_ATTRIBUTES";
+    DiagnosticCodes[DiagnosticCodes["MUST_HAVE_PARENT_ELEMENT"] = 2657] = "MUST_HAVE_PARENT_ELEMENT";
+    DiagnosticCodes[DiagnosticCodes["CANNOT_IMPORT_TS_EXT"] = 2691] = "CANNOT_IMPORT_TS_EXT";
+    DiagnosticCodes[DiagnosticCodes["CANT_RETURN_OUTSIDE_FUNC"] = 1108] = "CANT_RETURN_OUTSIDE_FUNC";
+    DiagnosticCodes[DiagnosticCodes["ISOLATED_MODULE_COMPILE_ERR"] = 1208] = "ISOLATED_MODULE_COMPILE_ERR";
+    DiagnosticCodes[DiagnosticCodes["TYPE_NOT_ASSIGNABLE"] = 2322] = "TYPE_NOT_ASSIGNABLE";
+    DiagnosticCodes[DiagnosticCodes["JSX_NO_CLOSING_TAG"] = 17008] = "JSX_NO_CLOSING_TAG";
+    DiagnosticCodes[DiagnosticCodes["NO_DECL_IMPLICIT_ANY_TYPE"] = 7016] = "NO_DECL_IMPLICIT_ANY_TYPE";
+})(DiagnosticCodes = exports.DiagnosticCodes || (exports.DiagnosticCodes = {}));
 class DiagnosticsProviderImpl {
     constructor(languageServiceManager) {
         this.languageServiceManager = languageServiceManager;
@@ -39,17 +53,15 @@ class DiagnosticsProviderImpl {
                 code: diagnostic.code,
                 tags: getDiagnosticTag(diagnostic),
             }))
+                .filter(isNoCantEndWithTS)
                 .map(mapRange(scriptTagSnapshot, document));
             scriptDiagnostics.push(...scriptDiagnostic);
         });
         const { script: scriptBoundaries } = this.getTagBoundaries(lang, filePath);
-        const syntaxDiagnostics = lang.getSyntacticDiagnostics(filePath);
-        const suggestionDiagnostics = lang.getSuggestionDiagnostics(filePath);
-        const semanticDiagnostics = lang.getSemanticDiagnostics(filePath);
         const diagnostics = [
-            ...syntaxDiagnostics,
-            ...suggestionDiagnostics,
-            ...semanticDiagnostics,
+            ...lang.getSyntacticDiagnostics(filePath),
+            ...lang.getSuggestionDiagnostics(filePath),
+            ...lang.getSemanticDiagnostics(filePath),
         ].filter((diag) => {
             return isNoWithinBoundary(scriptBoundaries, diag);
         });
@@ -67,14 +79,15 @@ class DiagnosticsProviderImpl {
             ...scriptDiagnostics,
         ]
             .filter((diag) => {
-            return (hasNoNegativeLines(diag) &&
-                isNoJSXImplicitRuntimeWarning(diag) &&
+            return (
+            // Make sure the diagnostic is inside the document and not in generated code
+            diag.range.start.line <= document.lineCount &&
+                hasNoNegativeLines(diag) &&
                 isNoJSXMustHaveOneParent(diag) &&
-                isNoCantEndWithTS(diag) &&
-                isNoSpreadExpected(diag) &&
-                isNoCantResolveJSONModule(diag) &&
+                isNoSpreadExpected(diag, document) &&
                 isNoCantReturnOutsideFunction(diag) &&
                 isNoIsolatedModuleError(diag) &&
+                isNoImportImplicitAnyType(diag) &&
                 isNoJsxCannotHaveMultipleAttrsError(diag));
         })
             .map(enhanceIfNecessary);
@@ -113,30 +126,39 @@ class DiagnosticsProviderImpl {
     }
 }
 exports.DiagnosticsProviderImpl = DiagnosticsProviderImpl;
-function getDiagnosticTag(diagnostic) {
-    const tags = [];
-    if (diagnostic.reportsUnnecessary) {
-        tags.push(vscode_languageserver_types_1.DiagnosticTag.Unnecessary);
+function isWithinBoundaries(boundaries, start) {
+    for (let [bstart, bend] of boundaries) {
+        if (start > bstart && start < bend) {
+            return true;
+        }
     }
-    if (diagnostic.reportsDeprecated) {
-        tags.push(vscode_languageserver_types_1.DiagnosticTag.Deprecated);
+    return false;
+}
+function diagnosticIsWithinBoundaries(sourceFile, boundaries, diagnostic) {
+    if ('start' in diagnostic) {
+        if (diagnostic.start == null)
+            return false;
+        return isWithinBoundaries(boundaries, diagnostic.start);
     }
-    return tags;
+    if (!sourceFile)
+        return false;
+    let startRange = diagnostic.range.start;
+    let pos = typescript_1.default.getPositionOfLineAndCharacter(sourceFile, startRange.line, startRange.character);
+    return isWithinBoundaries(boundaries, pos);
+}
+function isNoWithinBoundary(boundaries, diagnostic) {
+    return !diagnosticIsWithinBoundaries(undefined, boundaries, diagnostic);
 }
 function mapRange(fragment, _document) {
     return (diagnostic) => {
         let range = (0, documents_1.mapRangeToOriginal)(fragment, diagnostic.range);
-        if (range.start.line < 0) {
-            // Could be a props error?
-            // From svelte
-        }
         return { ...diagnostic, range };
     };
 }
 /**
  * In some rare cases mapping of diagnostics does not work and produces negative lines.
  * We filter out these diagnostics with negative lines because else the LSP
- * apparently has a hickup and does not show any diagnostics at all.
+ * apparently has a hiccup and does not show any diagnostics at all.
  */
 function hasNoNegativeLines(diagnostic) {
     return diagnostic.range.start.line >= 0 && diagnostic.range.end.line >= 0;
@@ -145,56 +167,59 @@ function hasNoNegativeLines(diagnostic) {
  * Astro allows multiple attributes to have the same name
  */
 function isNoJsxCannotHaveMultipleAttrsError(diagnostic) {
-    return diagnostic.code !== 17001;
+    return diagnostic.code !== DiagnosticCodes.DUPLICATED_JSX_ATTRIBUTES;
 }
 /** Astro allows component with multiple root elements */
 function isNoJSXMustHaveOneParent(diagnostic) {
-    return diagnostic.code !== 2657;
+    return diagnostic.code !== DiagnosticCodes.MUST_HAVE_PARENT_ELEMENT;
 }
-/** Astro allows `.ts` ending for imports, unlike TypeScript */
-function isNoCantEndWithTS(diagnostic) {
-    return diagnostic.code !== 2691;
+function isNoImportImplicitAnyType(diagnostic) {
+    return diagnostic.code !== DiagnosticCodes.NO_DECL_IMPLICIT_ANY_TYPE;
 }
-function isNoSpreadExpected(diagnostic) {
-    return diagnostic.code !== 1005;
+/**
+ * When using the shorthand syntax for props TSX expects you to use the spread operator
+ * Since the shorthand syntax works differently in Astro and this is not required, hide this message
+ * However, the error code used here is quite generic, as such we need to make we only ignore in valid cases
+ */
+function isNoSpreadExpected(diagnostic, document) {
+    if (diagnostic.code === DiagnosticCodes.SPREAD_EXPECTED &&
+        diagnostic.message.includes('...') &&
+        document.offsetAt(diagnostic.range.start) > (document.astroMeta.frontmatter.endOffset ?? 0)) {
+        return false;
+    }
+    return true;
 }
-function isNoJSXImplicitRuntimeWarning(diagnostic) {
-    return diagnostic.code !== 7016 && diagnostic.code !== 2792;
+/** Inside script tags, Astro currently require the `.ts` file extension for imports */
+function isNoCantEndWithTS(diagnostic) {
+    return diagnostic.code !== DiagnosticCodes.CANNOT_IMPORT_TS_EXT;
 }
 /**
  * Ignore "Can't return outside of function body"
- * This is technically a valid diagnostic, but due to how we format our TSX, the frontmatter is at top-level so we have
- * to ignore this. It wasn't a problem before because users didn't need to return things but they can now with SSR
+ * Since the frontmatter is at the top level, users trying to return a Response  for SSR mode run into this
  */
 function isNoCantReturnOutsideFunction(diagnostic) {
-    return diagnostic.code !== 1108;
-}
-/**
- * Astro allows users to import JSON modules
- */
-function isNoCantResolveJSONModule(diagnostic) {
-    return diagnostic.code !== 2732;
+    return diagnostic.code !== DiagnosticCodes.CANT_RETURN_OUTSIDE_FUNC;
 }
 /**
  * When the content of the file is invalid and can't be parsed properly for TSX generation, TS will show an error about
  * how the current module can't be compiled under --isolatedModule, this is confusing to users so let's ignore this
  */
 function isNoIsolatedModuleError(diagnostic) {
-    return diagnostic.code !== 1208;
+    return diagnostic.code !== DiagnosticCodes.ISOLATED_MODULE_COMPILE_ERR;
 }
 /**
  * Some diagnostics have JSX-specific nomenclature or unclear description. Enhance them for more clarity.
  */
 function enhanceIfNecessary(diagnostic) {
     // JSX element has no closing tag. JSX -> HTML
-    if (diagnostic.code === 17008) {
+    if (diagnostic.code === DiagnosticCodes.JSX_NO_CLOSING_TAG) {
         return {
             ...diagnostic,
             message: diagnostic.message.replace('JSX', 'HTML'),
         };
     }
     // For the rare case where an user might try to put a client directive on something that is not a component
-    if (diagnostic.code === 2322) {
+    if (diagnostic.code === DiagnosticCodes.TYPE_NOT_ASSIGNABLE) {
         if (diagnostic.message.includes("Property 'client:") && diagnostic.message.includes("to type 'HTMLProps")) {
             return {
                 ...diagnostic,
@@ -202,28 +227,23 @@ function enhanceIfNecessary(diagnostic) {
             };
         }
     }
+    // An import path cannot end with '.ts(x)' consider importing with no extension
+    // TODO: Remove this when https://github.com/withastro/astro/issues/3415 is fixed
+    if (diagnostic.code === DiagnosticCodes.CANNOT_IMPORT_TS_EXT) {
+        return {
+            ...diagnostic,
+            message: diagnostic.message.replace(/\.jsx?/, ''),
+        };
+    }
     return diagnostic;
 }
-function isWithinBoundaries(boundaries, start) {
-    for (let [bstart, bend] of boundaries) {
-        if (start > bstart && start < bend) {
-            return true;
-        }
+function getDiagnosticTag(diagnostic) {
+    const tags = [];
+    if (diagnostic.reportsUnnecessary) {
+        tags.push(vscode_languageserver_types_1.DiagnosticTag.Unnecessary);
     }
-    return false;
-}
-function diagnosticIsWithinBoundaries(sourceFile, boundaries, diagnostic) {
-    if ('start' in diagnostic) {
-        if (diagnostic.start == null)
-            return false;
-        return isWithinBoundaries(boundaries, diagnostic.start);
+    if (diagnostic.reportsDeprecated) {
+        tags.push(vscode_languageserver_types_1.DiagnosticTag.Deprecated);
     }
-    if (!sourceFile)
-        return false;
-    let startRange = diagnostic.range.start;
-    let pos = typescript_1.default.getPositionOfLineAndCharacter(sourceFile, startRange.line, startRange.character);
-    return isWithinBoundaries(boundaries, pos);
-}
-function isNoWithinBoundary(boundaries, diagnostic) {
-    return !diagnosticIsWithinBoundaries(undefined, boundaries, diagnostic);
+    return tags;
 }

package/dist/plugins/typescript/language-service.js

@@ -224,6 +224,7 @@ async function createLanguageService(tsconfigPath, docContext, workspaceUris) {
         const forcedCompilerOptions = {
             noEmit: true,
             declaration: false,
+            resolveJsonModule: true,
             allowNonTsExtensions: true,
             allowJs: true,
             jsx: typescript_1.default.JsxEmit.Preserve,

package/dist/server.js

@@ -129,6 +129,7 @@ function startLanguageServer(connection) {
                 colorProvider: true,
                 hoverProvider: true,
                 documentSymbolProvider: true,
+                linkedEditingRangeProvider: true,
                 semanticTokensProvider: {
                     legend: (0, utils_2.getSemanticTokenLegend)(),
                     range: true,
@@ -195,6 +196,7 @@ function startLanguageServer(connection) {
     connection.onDocumentSymbol((params, cancellationToken) => pluginHost.getDocumentSymbols(params.textDocument, cancellationToken));
     connection.onRequest(vscode_languageserver_1.SemanticTokensRequest.type, (evt, cancellationToken) => pluginHost.getSemanticTokens(evt.textDocument, undefined, cancellationToken));
     connection.onRequest(vscode_languageserver_1.SemanticTokensRangeRequest.type, (evt, cancellationToken) => pluginHost.getSemanticTokens(evt.textDocument, evt.range, cancellationToken));
+    connection.onRequest(vscode_languageserver_1.LinkedEditingRangeRequest.type, async (evt) => await pluginHost.getLinkedEditingRanges(evt.textDocument, evt.position));
     connection.onDocumentFormatting((params) => pluginHost.formatDocument(params.textDocument, params.options));
     connection.onDocumentColor((params) => pluginHost.getDocumentColors(params.textDocument));
     connection.onColorPresentation((params) => pluginHost.getColorPresentations(params.textDocument, params.range, params.color));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/language-server",
-  "version": "0.19.0",
+  "version": "0.19.1",
   "author": "withastro",
   "license": "MIT",
   "type": "commonjs",
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@astrojs/vue-language-integration": "^0.1.0",
-    "@astrojs/svelte-language-integration": "^0.1.4",
+    "@astrojs/svelte-language-integration": "^0.1.5",
     "@vscode/emmet-helper": "^2.8.4",
     "lodash": "^4.17.21",
     "source-map": "^0.7.3",