@astrojs/language-server 0.13.4 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @astrojs/language-server
 
+## 0.14.0
+
+### Minor Changes
+
+- 9118c46: Add support for loading type definitions from Astro itself
+
+### Patch Changes
+
+- 9ea5b97: Make TypeScript ignore content of Markdown tags
+- dbf624a: Fix error when returning a response from the frontmatter
+
 ## 0.13.4
 
 ### Patch Changes

package/dist/plugins/typescript/astro2tsx.js

@@ -38,9 +38,13 @@ function default_1(content) {
         .replace(/<\s*!--([^-->]*)(.*?)-->/gs, (whole) => {
         return `{/*${whole}*/}`;
     })
-        // Turn styles into internal strings
+        // Turn styles tags into internal strings
         .replace(/<\s*style([^>]*)>(.*?)<\s*\/\s*style>/gs, (_whole, attrs, children) => {
         return `<style${attrs}>{\`${escapeTemplateLiteralContent(children)}\`}</style>`;
+    })
+        // Turn Markdown tags into internal strings
+        .replace(/<\s*Markdown([^>]*)>(.*?)<\s*\/\s*Markdown>/gs, (_whole, attrs, children) => {
+        return `<Markdown${attrs}>{\`${escapeTemplateLiteralContent(children)}\`}</Markdown>`;
     })
         // Turn scripts into function calls
         .replace(/<\s*script([^\/>]*)>(.*?)<\s*\/\s*script>/gs, (_whole, attrs, children, offset) => {

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

@@ -13,7 +13,7 @@ class DiagnosticsProviderImpl {
         this.languageServiceManager = languageServiceManager;
     }
     async getDiagnostics(document, _cancellationToken) {
-        var _a, _b, _c;
+        var _a, _b;
         // Don't return diagnostics for files inside node_modules. These are considered read-only
         // and they would pollute the output for astro check
         if (((_a = document.getFilePath()) === null || _a === void 0 ? void 0 : _a.includes('/node_modules/')) || ((_b = document.getFilePath()) === null || _b === void 0 ? void 0 : _b.includes('\\node_modules\\'))) {
@@ -21,16 +21,14 @@ class DiagnosticsProviderImpl {
         }
         const { lang, tsDoc } = await this.languageServiceManager.getLSAndTSDoc(document);
         const filePath = (0, utils_1.toVirtualAstroFilePath)(tsDoc.filePath);
-        const { script: scriptBoundaries, markdown: markdownBoundaries } = this.getTagBoundaries(lang, filePath);
+        const { script: scriptBoundaries } = this.getTagBoundaries(lang, filePath);
         const syntaxDiagnostics = lang.getSyntacticDiagnostics(filePath);
         const suggestionDiagnostics = lang.getSuggestionDiagnostics(filePath);
         const semanticDiagnostics = lang.getSemanticDiagnostics(filePath).filter((d) => {
-            return isNoWithinScript(scriptBoundaries, d);
+            return isNoWithinBoundary(scriptBoundaries, d);
         });
         const diagnostics = [...syntaxDiagnostics, ...suggestionDiagnostics, ...semanticDiagnostics];
         const fragment = await tsDoc.createFragment();
-        const sourceFile = (_c = lang.getProgram()) === null || _c === void 0 ? void 0 : _c.getSourceFile(filePath);
-        const isNoFalsePositiveInst = isNoFalsePositive();
         return diagnostics
             .map((diagnostic) => ({
             range: (0, utils_1.convertRange)(tsDoc, diagnostic),
@@ -43,14 +41,13 @@ class DiagnosticsProviderImpl {
             .map(mapRange(fragment, document))
             .filter((diag) => {
             return (hasNoNegativeLines(diag) &&
-                isNoFalsePositiveInst(diag) &&
                 isNoJSXImplicitRuntimeWarning(diag) &&
                 isNoJSXMustHaveOneParent(diag) &&
-                isNoCantUseJSX(diag) &&
                 isNoCantEndWithTS(diag) &&
                 isNoSpreadExpected(diag) &&
                 isNoCantResolveJSONModule(diag) &&
-                isNoMarkdownBlockQuoteWithinMarkdown(sourceFile, markdownBoundaries, diag));
+                isNoCantReturnOutsideFunction(diag) &&
+                isNoJsxCannotHaveMultipleAttrsError(diag));
         })
             .map(enhanceIfNecessary);
     }
@@ -64,7 +61,7 @@ class DiagnosticsProviderImpl {
         if (!sourceFile) {
             return boundaries;
         }
-        function findScript(parent) {
+        function findTags(parent) {
             typescript_1.default.forEachChild(parent, (node) => {
                 if (typescript_1.default.isJsxElement(node)) {
                     let tagName = node.openingElement.tagName.getText();
@@ -80,10 +77,10 @@ class DiagnosticsProviderImpl {
                         }
                     }
                 }
-                findScript(node);
+                findTags(node);
             });
         }
-        findScript(sourceFile);
+        findTags(sourceFile);
         return boundaries;
     }
 }
@@ -116,33 +113,55 @@ function mapRange(fragment, _document) {
 function hasNoNegativeLines(diagnostic) {
     return diagnostic.range.start.line >= 0 && diagnostic.range.end.line >= 0;
 }
-function isNoFalsePositive() {
-    return (diagnostic) => {
-        return isNoJsxCannotHaveMultipleAttrsError(diagnostic);
-    };
-}
 /**
- * Jsx cannot have multiple attributes with same name,
- * but that's allowed for svelte
+ * Astro allows multiple attributes to have the same name
  */
 function isNoJsxCannotHaveMultipleAttrsError(diagnostic) {
     return diagnostic.code !== 17001;
 }
-function isNoJSXImplicitRuntimeWarning(diagnostic) {
-    return diagnostic.code !== 7016 && diagnostic.code !== 2792;
-}
+/** Astro allows component with multiple root elements */
 function isNoJSXMustHaveOneParent(diagnostic) {
     return diagnostic.code !== 2657;
 }
-function isNoCantUseJSX(diagnostic) {
-    return diagnostic.code !== 17004 && diagnostic.code !== 6142;
-}
+/** Astro allows `.ts` ending for imports, unlike TypeScript */
 function isNoCantEndWithTS(diagnostic) {
     return diagnostic.code !== 2691;
 }
 function isNoSpreadExpected(diagnostic) {
     return diagnostic.code !== 1005;
 }
+function isNoJSXImplicitRuntimeWarning(diagnostic) {
+    return diagnostic.code !== 7016 && diagnostic.code !== 2792;
+}
+/**
+ * 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
+ */
+function isNoCantReturnOutsideFunction(diagnostic) {
+    return diagnostic.code !== 1108;
+}
+/**
+ * Astro allows users to import JSON modules
+ */
+function isNoCantResolveJSONModule(diagnostic) {
+    return diagnostic.code !== 2732;
+}
+/**
+ * Some diagnostics have JSX-specific nomenclature or unclear description. Enhance them for more clarity.
+ */
+function enhanceIfNecessary(diagnostic) {
+    if (diagnostic.code === 2322) {
+        // For the rare case where an user might try to put a client directive on something that is not a component
+        if (diagnostic.message.includes("Property 'client:") && diagnostic.message.includes("to type 'HTMLProps")) {
+            return {
+                ...diagnostic,
+                message: 'Client directives are only available on framework components',
+            };
+        }
+    }
+    return diagnostic;
+}
 function isWithinBoundaries(boundaries, start) {
     for (let [bstart, bend] of boundaries) {
         if (start > bstart && start < bend) {
@@ -163,39 +182,6 @@ function diagnosticIsWithinBoundaries(sourceFile, boundaries, diagnostic) {
     let pos = typescript_1.default.getPositionOfLineAndCharacter(sourceFile, startRange.line, startRange.character);
     return isWithinBoundaries(boundaries, pos);
 }
-function isNoWithinScript(boundaries, diagnostic) {
+function isNoWithinBoundary(boundaries, diagnostic) {
     return !diagnosticIsWithinBoundaries(undefined, boundaries, diagnostic);
 }
-/**
- * This allows us to have JSON module imports.
- */
-function isNoCantResolveJSONModule(diagnostic) {
-    return diagnostic.code !== 2732;
-}
-/**
- * This is for using > within a markdown component like:
- * <Markdown>
- *   > Blockquote here.
- * </Markdown>
- */
-function isNoMarkdownBlockQuoteWithinMarkdown(sourceFile, boundaries, diagnostic) {
-    if (diagnostic.code !== 1382) {
-        return true;
-    }
-    return !diagnosticIsWithinBoundaries(sourceFile, boundaries, diagnostic);
-}
-/**
- * Some diagnostics have JSX-specific nomenclature. Enhance them for more clarity.
- */
-function enhanceIfNecessary(diagnostic) {
-    if (diagnostic.code === 2322) {
-        // For the rare case where an user might try to put a client directive on something that is not a component
-        if (diagnostic.message.includes("Property 'client:") && diagnostic.message.includes("to type 'HTMLProps")) {
-            return {
-                ...diagnostic,
-                message: 'Client directives are only available on framework components',
-            };
-        }
-    }
-    return diagnostic;
-}

package/dist/plugins/typescript/language-service.d.ts

@@ -35,4 +35,4 @@ export declare function forAllLanguageServices(cb: (service: LanguageServiceCont
  * @param tsconfigPath has to be absolute
  * @param docContext
  */
-export declare function getLanguageServiceForTsconfig(tsconfigPath: string, docContext: LanguageServiceDocumentContext): Promise<LanguageServiceContainer>;
+export declare function getLanguageServiceForTsconfig(tsconfigPath: string, docContext: LanguageServiceDocumentContext, workspaceUris: string[]): Promise<LanguageServiceContainer>;

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

@@ -37,7 +37,7 @@ const DocumentSnapshotUtils = __importStar(require("./snapshots/utils"));
 const services = new Map();
 async function getLanguageService(path, workspaceUris, docContext) {
     const tsconfigPath = (0, utils_2.findTsConfigPath)(path, workspaceUris);
-    return getLanguageServiceForTsconfig(tsconfigPath, docContext);
+    return getLanguageServiceForTsconfig(tsconfigPath, docContext, workspaceUris);
 }
 exports.getLanguageService = getLanguageService;
 async function forAllLanguageServices(cb) {
@@ -50,34 +50,44 @@ exports.forAllLanguageServices = forAllLanguageServices;
  * @param tsconfigPath has to be absolute
  * @param docContext
  */
-async function getLanguageServiceForTsconfig(tsconfigPath, docContext) {
+async function getLanguageServiceForTsconfig(tsconfigPath, docContext, workspaceUris) {
     let service;
     if (services.has(tsconfigPath)) {
         service = await services.get(tsconfigPath);
     }
     else {
-        const newService = createLanguageService(tsconfigPath, docContext);
+        const newService = createLanguageService(tsconfigPath, docContext, workspaceUris);
         services.set(tsconfigPath, newService);
         service = await newService;
     }
     return service;
 }
 exports.getLanguageServiceForTsconfig = getLanguageServiceForTsconfig;
-async function createLanguageService(tsconfigPath, docContext) {
-    const workspaceRoot = tsconfigPath ? (0, path_1.dirname)(tsconfigPath) : '';
+async function createLanguageService(tsconfigPath, docContext, workspaceUris) {
+    const tsconfigRoot = tsconfigPath ? (0, path_1.dirname)(tsconfigPath) : process.cwd();
+    const workspacePaths = workspaceUris.map((uri) => (0, utils_1.urlToPath)(uri));
+    const workspacePath = workspacePaths.find((uri) => tsconfigRoot.startsWith(uri)) || workspacePaths[0];
+    const astroVersion = (0, utils_1.getUserAstroVersion)(workspacePath);
     // `raw` here represent the tsconfig merged with any extended config
     const { compilerOptions, fileNames: files, raw: fullConfig } = getParsedTSConfig();
     let projectVersion = 0;
-    const snapshotManager = new SnapshotManager_1.SnapshotManager(docContext.globalSnapshotManager, files, fullConfig, workspaceRoot || process.cwd());
+    const snapshotManager = new SnapshotManager_1.SnapshotManager(docContext.globalSnapshotManager, files, fullConfig, tsconfigRoot || process.cwd());
     const astroModuleLoader = (0, module_loader_1.createAstroModuleLoader)(getScriptSnapshot, compilerOptions);
-    let languageServerDirectory;
-    try {
-        languageServerDirectory = (0, path_1.dirname)(require.resolve('@astrojs/language-server'));
-    }
-    catch (e) {
-        languageServerDirectory = __dirname;
+    const scriptFileNames = [];
+    // Before Astro 1.0, JSX definitions were inside of the language-server instead of inside Astro
+    // TODO: Remove this and astro-jsx.d.ts in types when we consider having support for Astro < 1.0 unnecessary
+    if (astroVersion.major === 0 || astroVersion.full === '1.0.0-beta.0') {
+        let languageServerDirectory;
+        try {
+            languageServerDirectory = (0, path_1.dirname)(require.resolve('@astrojs/language-server'));
+        }
+        catch (e) {
+            languageServerDirectory = __dirname;
+        }
+        const astroTSXFile = typescript_1.default.sys.resolvePath((0, path_1.resolve)(languageServerDirectory, '../types/astro-jsx.d.ts'));
+        scriptFileNames.push(astroTSXFile);
+        console.warn("Version lower than 1.0 detected, using internal types instead of Astro's");
     }
-    const astroTSXFile = typescript_1.default.sys.resolvePath((0, path_1.resolve)(languageServerDirectory, '../types/astro-jsx.d.ts'));
     const host = {
         getNewLine: () => typescript_1.default.sys.newLine,
         useCaseSensitiveFileNames: () => typescript_1.default.sys.useCaseSensitiveFileNames,
@@ -87,10 +97,10 @@ async function createLanguageService(tsconfigPath, docContext) {
         fileExists: astroModuleLoader.fileExists,
         readDirectory: astroModuleLoader.readDirectory,
         getCompilationSettings: () => compilerOptions,
-        getCurrentDirectory: () => workspaceRoot,
+        getCurrentDirectory: () => tsconfigRoot,
         getDefaultLibFileName: typescript_1.default.getDefaultLibFilePath,
         getProjectVersion: () => projectVersion.toString(),
-        getScriptFileNames: () => Array.from(new Set([...snapshotManager.getProjectFileNames(), ...snapshotManager.getFileNames(), astroTSXFile])),
+        getScriptFileNames: () => Array.from(new Set([...snapshotManager.getProjectFileNames(), ...snapshotManager.getFileNames(), ...scriptFileNames])),
         getScriptSnapshot,
         getScriptVersion: (fileName) => getScriptSnapshot(fileName).version.toString(),
     };
@@ -176,17 +186,24 @@ async function createLanguageService(tsconfigPath, docContext) {
         snapshotManager.updateNonAstroFile(fileName, changes);
     }
     function getParsedTSConfig() {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         let configJson = (tsconfigPath && typescript_1.default.readConfigFile(tsconfigPath, typescript_1.default.sys.readFile).config) || {};
         // If our user has types in their config but it doesn't include the types needed for Astro, add them to the config
-        if (((_a = configJson.compilerOptions) === null || _a === void 0 ? void 0 : _a.types) && !((_b = configJson.compilerOptions) === null || _b === void 0 ? void 0 : _b.types.includes('astro/env'))) {
-            configJson.compilerOptions.types.push('astro/env');
+        if ((_a = configJson.compilerOptions) === null || _a === void 0 ? void 0 : _a.types) {
+            if (!((_b = configJson.compilerOptions) === null || _b === void 0 ? void 0 : _b.types.includes('astro/env'))) {
+                configJson.compilerOptions.types.push('astro/env');
+            }
+            if (astroVersion.major >= 1 &&
+                astroVersion.full !== '1.0.0-beta.0' &&
+                !((_c = configJson.compilerOptions) === null || _c === void 0 ? void 0 : _c.types.includes('astro/astro-jsx'))) {
+                configJson.compilerOptions.types.push('astro/astro-jsx');
+            }
         }
-        configJson.compilerOptions = Object.assign(getDefaultCompilerOptions(), configJson.compilerOptions);
+        configJson.compilerOptions = Object.assign(getDefaultCompilerOptions(astroVersion), configJson.compilerOptions);
         // Delete include so that .astro files don't get mistakenly excluded by the user
         delete configJson.include;
         // If the user supplied exclude, let's use theirs otherwise, use ours
-        (_c = configJson.exclude) !== null && _c !== void 0 ? _c : (configJson.exclude = getDefaultExclude());
+        (_d = configJson.exclude) !== null && _d !== void 0 ? _d : (configJson.exclude = getDefaultExclude());
         // Everything here will always, unconditionally, be in the resulting config
         const forcedCompilerOptions = {
             noEmit: true,
@@ -200,7 +217,7 @@ async function createLanguageService(tsconfigPath, docContext) {
             target: typescript_1.default.ScriptTarget.ESNext,
             moduleResolution: typescript_1.default.ModuleResolutionKind.NodeJs,
         };
-        const project = typescript_1.default.parseJsonConfigFileContent(configJson, typescript_1.default.sys, workspaceRoot, forcedCompilerOptions, tsconfigPath, undefined, [
+        const project = typescript_1.default.parseJsonConfigFileContent(configJson, typescript_1.default.sys, tsconfigRoot, forcedCompilerOptions, tsconfigPath, undefined, [
             { extension: '.vue', isMixedContent: true, scriptKind: typescript_1.default.ScriptKind.Deferred },
             { extension: '.svelte', isMixedContent: true, scriptKind: typescript_1.default.ScriptKind.Deferred },
             { extension: '.astro', isMixedContent: true, scriptKind: typescript_1.default.ScriptKind.Deferred },
@@ -218,11 +235,15 @@ async function createLanguageService(tsconfigPath, docContext) {
 /**
  * Default configuration used as a base and when the user doesn't have any
  */
-function getDefaultCompilerOptions() {
+function getDefaultCompilerOptions(astroVersion) {
+    const types = ['astro/env'];
+    if (astroVersion.major >= 1 && astroVersion.full !== '1.0.0-beta.0') {
+        types.push('astro/astro-jsx');
+    }
     return {
         maxNodeModuleJsDepth: 2,
         allowSyntheticDefaultImports: true,
-        types: ['astro/env'],
+        types: types,
     };
 }
 function getDefaultExclude() {

package/dist/server.js

@@ -46,6 +46,22 @@ function startLanguageServer(connection) {
     connection.onInitialize((params) => {
         var _a, _b, _c, _d, _e, _f;
         const workspaceUris = (_b = (_a = params.workspaceFolders) === null || _a === void 0 ? void 0 : _a.map((folder) => folder.uri.toString())) !== null && _b !== void 0 ? _b : [(_c = params.rootUri) !== null && _c !== void 0 ? _c : ''];
+        workspaceUris.forEach((uri) => {
+            uri = (0, utils_1.urlToPath)(uri);
+            const astroVersion = (0, utils_1.getUserAstroVersion)(uri);
+            if (astroVersion.exist === false) {
+                connection.sendNotification(vscode_languageserver_1.ShowMessageNotification.type, {
+                    message: `Couldn't find Astro in workspace "${uri}". Experience might be degraded. For the best experience, please make sure Astro is installed and then restart the language server`,
+                    type: vscode_languageserver_1.MessageType.Warning,
+                });
+            }
+            if (astroVersion.exist && astroVersion.major === 0 && astroVersion.minor < 24 && astroVersion.patch < 5) {
+                connection.sendNotification(vscode_languageserver_1.ShowMessageNotification.type, {
+                    message: `The version of Astro you're using (${astroVersion.full}) is not supported by this version of the Astro language server. Please upgrade Astro to any version higher than 0.23.4 or if using the VS Code extension, downgrade the extension to 0.8.10`,
+                    type: vscode_languageserver_1.MessageType.Error,
+                });
+            }
+        });
         pluginHost.initialize({
             filterIncompleteCompletions: !((_d = params.initializationOptions) === null || _d === void 0 ? void 0 : _d.dontFilterIncompleteCompletions),
             definitionLinkSupport: !!((_f = (_e = params.capabilities.textDocument) === null || _e === void 0 ? void 0 : _e.definition) === null || _f === void 0 ? void 0 : _f.linkSupport),

package/dist/utils.d.ts

@@ -46,3 +46,11 @@ export declare function debounceSameArg<T>(fn: (arg: T) => void, shouldCancelPre
  * @param milliseconds Number of milliseconds to debounce/throttle
  */
 export declare function debounceThrottle<T extends (...args: any) => void>(fn: T, milliseconds: number): T;
+export interface AstroVersion {
+    full: string;
+    major: number;
+    minor: number;
+    patch: number;
+    exist: boolean;
+}
+export declare function getUserAstroVersion(basePath: string): AstroVersion;

package/dist/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.debounceThrottle = exports.debounceSameArg = exports.isBeforeOrEqualToPosition = exports.isInRange = exports.isNotNullOrUndefined = exports.clamp = exports.flatten = exports.isPossibleComponent = exports.getLastPartOfPath = exports.pathToUrl = exports.urlToPath = exports.normalizePath = exports.normalizeUri = void 0;
+exports.getUserAstroVersion = exports.debounceThrottle = exports.debounceSameArg = exports.isBeforeOrEqualToPosition = exports.isInRange = exports.isNotNullOrUndefined = exports.clamp = exports.flatten = exports.isPossibleComponent = exports.getLastPartOfPath = exports.pathToUrl = exports.urlToPath = exports.normalizePath = exports.normalizeUri = void 0;
 const vscode_uri_1 = require("vscode-uri");
 /** Normalizes a document URI */
 function normalizeUri(uri) {
@@ -117,3 +117,36 @@ function debounceThrottle(fn, milliseconds) {
     return maybeCall;
 }
 exports.debounceThrottle = debounceThrottle;
+function getUserAstroVersion(basePath) {
+    let version = '0.0.0';
+    let exist = true;
+    try {
+        const astroPackageJson = require.resolve('astro/package.json', { paths: [basePath] });
+        version = require(astroPackageJson).version;
+    }
+    catch {
+        // If we couldn't find it inside the workspace's node_modules, it might means we're in the monorepo
+        try {
+            const monorepoPackageJson = require.resolve('./packages/astro/package.json', { paths: [basePath] });
+            version = require(monorepoPackageJson).version;
+        }
+        catch (e) {
+            // If we still couldn't find it, it probably just doesn't exist
+            exist = false;
+            console.error(e);
+        }
+    }
+    let [major, minor, patch] = version.split('.');
+    if (patch.includes('-')) {
+        const patchParts = patch.split('-');
+        patch = patchParts[0];
+    }
+    return {
+        full: version,
+        major: Number(major),
+        minor: Number(minor),
+        patch: Number(patch),
+        exist,
+    };
+}
+exports.getUserAstroVersion = getUserAstroVersion;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/language-server",
-  "version": "0.13.4",
+  "version": "0.14.0",
   "author": "withastro",
   "license": "MIT",
   "type": "commonjs",
@@ -37,7 +37,7 @@
     "@types/lodash": "^4.14.179",
     "@types/mocha": "^9.1.0",
     "@types/sinon": "^10.0.11",
-    "astro": "^0.23.7",
+    "astro": "^1.0.0-beta.1",
     "astro-scripts": "0.0.1",
     "chai": "^4.3.6",
     "cross-env": "^7.0.3",