@astrojs/language-server 2.0.0-next.9 → 2.0.0

package/README.md

@@ -13,3 +13,13 @@ The Astro language server, implement the [language server protocol](https://micr
 ├── test            # Tests
 └── types           # Types injected into Astro files by the language server under certain conditions
 ```
+
+## Troubleshooting
+
+### Formatting does not work
+
+> Using VS Code? This section does not apply to you, the VS Code extension includes both Prettier and the Astro plugin by default.
+
+The Astro language server uses Prettier to format Astro files, but does not include `prettier` or `prettier-plugin-astro` by itself as dependencies in order to keep the dependency count low and allow users to better control the version of Prettier they want to use.
+
+As such, if you want to use formatting, you'll need to install `prettier` and `prettier-plugin-astro` as dependencies in your project.

package/dist/core/astro2tsx.d.ts

@@ -2,5 +2,5 @@ import { VirtualFile } from '@volar/language-core';
 import { HTMLDocument } from 'vscode-html-languageservice';
 export declare function astro2tsx(input: string, fileName: string, ts: typeof import('typescript/lib/tsserverlibrary.js'), htmlDocument: HTMLDocument): {
     virtualFile: VirtualFile;
-    diagnostics: import("@astrojs/compiler/types.js").DiagnosticMessage[];
+    diagnostics: import("@astrojs/compiler").DiagnosticMessage[];
 };

package/dist/core/index.js

@@ -47,10 +47,10 @@ function getLanguageModule(astroInstall, ts) {
                 getScriptFileNames() {
                     const fileNames = host.getScriptFileNames();
                     return [
+                        ...fileNames,
                         ...(astroInstall
                             ? ['./env.d.ts', './astro-jsx.d.ts'].map((filePath) => ts.sys.resolvePath(path.resolve(astroInstall.path, filePath)))
                             : []),
-                        ...fileNames,
                     ];
                 },
                 getCompilationSettings() {

package/dist/core/parseAstro.d.ts

@@ -1,5 +1,4 @@
-import type { Point } from '@astrojs/compiler/shared/ast';
-import type { ParseResult } from '@astrojs/compiler/types';
+import type { ParseResult, Point } from '@astrojs/compiler/types';
 type AstroMetadata = ParseResult & {
     frontmatter: FrontmatterStatus;
 };

package/dist/core/parseCSS.d.ts

@@ -2,7 +2,7 @@ import type { ParseResult } from '@astrojs/compiler/types';
 import { VirtualFile } from '@volar/language-core';
 import type ts from 'typescript/lib/tsserverlibrary';
 import type { HTMLDocument } from 'vscode-html-languageservice';
-import { AttributeNodeWithPosition } from './compilerUtils.js';
+import type { AttributeNodeWithPosition } from '../utils.js';
 export declare function extractStylesheets(fileName: string, snapshot: ts.IScriptSnapshot, htmlDocument: HTMLDocument, ast: ParseResult['ast']): VirtualFile[];
-export declare function collectClassesAndIds(ast: ParseResult['ast']): string[];
+export declare function collectClassesAndIdsFromDocument(ast: ParseResult['ast']): string[];
 export declare function findInlineStyles(ast: ParseResult['ast']): AttributeNodeWithPosition[];

package/dist/core/parseCSS.js

@@ -23,11 +23,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findInlineStyles = exports.collectClassesAndIds = exports.extractStylesheets = void 0;
+exports.findInlineStyles = exports.collectClassesAndIdsFromDocument = exports.extractStylesheets = void 0;
+const utils_1 = require("@astrojs/compiler/utils");
 const language_core_1 = require("@volar/language-core");
 const SourceMap = __importStar(require("@volar/source-map"));
 const muggle = __importStar(require("muggle-string"));
-const compilerUtils_js_1 = require("./compilerUtils.js");
 function extractStylesheets(fileName, snapshot, htmlDocument, ast) {
     const embeddedCSSFiles = [];
     for (const [index, root] of htmlDocument.roots.entries()) {
@@ -91,19 +91,20 @@ function extractStylesheets(fileName, snapshot, htmlDocument, ast) {
     return embeddedCSSFiles;
 }
 exports.extractStylesheets = extractStylesheets;
-function collectClassesAndIds(ast) {
+// TODO: Provide completion for classes and IDs
+function collectClassesAndIdsFromDocument(ast) {
     const classesAndIds = [];
     function walkDown(parent) {
         if (!parent.children)
             return;
         parent.children.forEach((child) => {
-            if (compilerUtils_js_1.is.element(child)) {
+            if (utils_1.is.element(child)) {
                 const classOrIDAttributes = child.attributes
                     .filter((attr) => attr.kind === 'quoted' && (attr.name === 'class' || attr.name === 'id'))
                     .flatMap((attr) => attr.value.split(' '));
                 classesAndIds.push(...classOrIDAttributes);
             }
-            if (compilerUtils_js_1.is.parent(child)) {
+            if (utils_1.is.parent(child)) {
                 walkDown(child);
             }
         });
@@ -111,7 +112,7 @@ function collectClassesAndIds(ast) {
     walkDown(ast);
     return classesAndIds;
 }
-exports.collectClassesAndIds = collectClassesAndIds;
+exports.collectClassesAndIdsFromDocument = collectClassesAndIdsFromDocument;
 function findInlineStyles(ast) {
     const styleAttrs = [];
     // `@astrojs/compiler`'s `walk` method is async, so we can't use it here. Arf
@@ -119,13 +120,13 @@ function findInlineStyles(ast) {
         if (!parent.children)
             return;
         parent.children.forEach((child) => {
-            if (compilerUtils_js_1.is.element(child)) {
+            if (utils_1.is.element(child)) {
                 const styleAttribute = child.attributes.find((attr) => attr.name === 'style' && attr.kind === 'quoted');
                 if (styleAttribute && styleAttribute.position) {
                     styleAttrs.push(styleAttribute);
                 }
             }
-            if (compilerUtils_js_1.is.parent(child)) {
+            if (utils_1.is.parent(child)) {
                 walkDown(child);
             }
         });

package/dist/core/parseJS.d.ts

@@ -1,4 +1,4 @@
-import type { ParseResult } from '@astrojs/compiler/types.js';
+import type { ParseResult } from '@astrojs/compiler/types';
 import { VirtualFile } from '@volar/language-core';
 import type ts from 'typescript/lib/tsserverlibrary';
 import type { HTMLDocument, Node } from 'vscode-html-languageservice';

package/dist/core/parseJS.js

@@ -24,10 +24,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.htmlEventAttributes = exports.getScriptTagLanguage = exports.extractScriptTags = void 0;
+const utils_1 = require("@astrojs/compiler/utils");
 const language_core_1 = require("@volar/language-core");
 const SourceMap = __importStar(require("@volar/source-map"));
 const muggle = __importStar(require("muggle-string"));
-const compilerUtils_js_1 = require("./compilerUtils.js");
 function extractScriptTags(fileName, snapshot, htmlDocument, ast) {
     const embeddedJSFiles = [];
     for (const [index, root] of htmlDocument.roots.entries()) {
@@ -120,7 +120,7 @@ function findEventAttributes(ast) {
         if (!parent.children)
             return;
         parent.children.forEach((child) => {
-            if (compilerUtils_js_1.is.element(child)) {
+            if (utils_1.is.element(child)) {
                 const eventAttribute = child.attributes.find((attr) => exports.htmlEventAttributes.includes(attr.name) && attr.kind === 'quoted');
                 if (eventAttribute && eventAttribute.position) {
                     eventAttrs.push({
@@ -129,7 +129,7 @@ function findEventAttributes(ast) {
                     });
                 }
             }
-            if (compilerUtils_js_1.is.parent(child)) {
+            if (utils_1.is.parent(child)) {
                 walkDown(child);
             }
         });

package/dist/importPackage.d.ts

@@ -5,5 +5,5 @@ export declare function setIsTrusted(_isTrusted: boolean): void;
 export declare function getPackagePath(packageName: string, fromPath: string[]): string | undefined;
 export declare function importSvelteIntegration(fromPath: string): typeof svelte | undefined;
 export declare function importVueIntegration(fromPath: string): typeof vue | undefined;
-export declare function importPrettier(fromPath: string): typeof prettier;
-export declare function getPrettierPluginPath(fromPath: string): string;
+export declare function importPrettier(fromPath: string): typeof prettier | undefined;
+export declare function getPrettierPluginPath(fromPath: string): string | undefined;

package/dist/importPackage.js

@@ -43,13 +43,19 @@ function importVueIntegration(fromPath) {
 }
 exports.importVueIntegration = importVueIntegration;
 function importPrettier(fromPath) {
-    // This shouldn't ever fail, because we bundle Prettier in the extension itself
     const prettierPkg = getPackagePath('prettier', [fromPath, __dirname]);
+    if (!prettierPkg) {
+        return undefined;
+    }
     return require(prettierPkg);
 }
 exports.importPrettier = importPrettier;
 function getPrettierPluginPath(fromPath) {
-    return getPackagePath('prettier-plugin-astro', [fromPath, __dirname]);
+    const prettierPluginPath = getPackagePath('prettier-plugin-astro', [fromPath, __dirname]);
+    if (!prettierPluginPath) {
+        return undefined;
+    }
+    return prettierPluginPath;
 }
 exports.getPrettierPluginPath = getPrettierPluginPath;
 //# sourceMappingURL=importPackage.js.map

package/dist/languageServerPlugin.d.ts

@@ -1,2 +1,2 @@
-import type { LanguageServerPlugin } from '@volar/language-server/node';
+import { LanguageServerPlugin } from '@volar/language-server/node';
 export declare const plugin: LanguageServerPlugin;

package/dist/languageServerPlugin.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.plugin = void 0;
+const node_1 = require("@volar/language-server/node");
 const volar_service_css_1 = __importDefault(require("volar-service-css"));
 const volar_service_emmet_1 = __importDefault(require("volar-service-emmet"));
 const volar_service_prettier_1 = __importDefault(require("volar-service-prettier"));
@@ -39,7 +40,14 @@ const plugin = (initOptions, modules) => ({
     resolveConfig(config, ctx) {
         config.languages ??= {};
         if (ctx) {
-            config.languages.astro = (0, core_1.getLanguageModule)((0, utils_1.getAstroInstall)([ctx.project.rootUri.fsPath]), modules.typescript);
+            const astroInstall = (0, utils_1.getAstroInstall)([ctx.project.rootUri.fsPath]);
+            if (!astroInstall) {
+                ctx.server.connection.sendNotification(node_1.ShowMessageNotification.type, {
+                    message: `Couldn't find Astro in workspace "${ctx.project.rootUri.fsPath}". Experience might be degraded. For the best experience, please make sure Astro is installed into your project and restart the language server.`,
+                    type: node_1.MessageType.Warning,
+                });
+            }
+            config.languages.astro = (0, core_1.getLanguageModule)(astroInstall, modules.typescript);
             config.languages.vue = (0, vue_js_1.getVueLanguageModule)();
             config.languages.svelte = (0, svelte_js_1.getSvelteLanguageModule)();
         }
@@ -50,31 +58,43 @@ const plugin = (initOptions, modules) => ({
         config.services.typescript ??= (0, index_js_1.default)();
         config.services.typescripttwoslash ??= (0, volar_service_typescript_twoslash_queries_1.default)();
         config.services.astro ??= (0, astro_js_1.default)();
-        config.services.prettier ??= (0, volar_service_prettier_1.default)({
-            languages: ['astro'],
-            resolveConfigOptions: {
-                // Prettier's cache is a bit cumbersome, because you need to reload the config yourself on change
-                // TODO: Upstream a fix for this
-                useCache: false,
-            },
-            additionalOptions: (resolvedConfig) => {
-                function getAstroPrettierPlugin() {
-                    if (!ctx?.project.rootUri)
-                        return [];
-                    const rootDir = ctx.env.uriToFileName(ctx?.project.rootUri.toString());
-                    const prettier = (0, importPackage_js_1.importPrettier)(rootDir);
-                    const hasPluginLoadedAlready = prettier
-                        .getSupportInfo()
-                        .languages.some((l) => l.name === 'astro');
-                    return hasPluginLoadedAlready ? [] : [(0, importPackage_js_1.getPrettierPluginPath)(rootDir)];
-                }
-                return {
-                    plugins: [...getAstroPrettierPlugin(), ...(resolvedConfig.plugins ?? [])],
-                    parser: 'astro',
-                    ...resolvedConfig,
-                };
-            },
-        });
+        if (ctx) {
+            const rootDir = ctx.env.uriToFileName(ctx.project.rootUri.toString());
+            const prettier = (0, importPackage_js_1.importPrettier)(rootDir);
+            const prettierPluginPath = (0, importPackage_js_1.getPrettierPluginPath)(rootDir);
+            if (prettier && prettierPluginPath) {
+                config.services.prettier ??= (0, volar_service_prettier_1.default)({
+                    languages: ['astro'],
+                    resolveConfigOptions: {
+                        // Prettier's cache is a bit cumbersome, because you need to reload the config yourself on change
+                        // TODO: Upstream a fix for this
+                        useCache: false,
+                    },
+                    additionalOptions: (resolvedConfig) => {
+                        function getAstroPrettierPlugin() {
+                            if (!prettier || !prettierPluginPath) {
+                                return [];
+                            }
+                            const hasPluginLoadedAlready = prettier
+                                .getSupportInfo()
+                                .languages.some((l) => l.name === 'astro');
+                            return hasPluginLoadedAlready ? [] : [prettierPluginPath];
+                        }
+                        return {
+                            plugins: [...getAstroPrettierPlugin(), ...(resolvedConfig.plugins ?? [])],
+                            parser: 'astro',
+                            ...resolvedConfig,
+                        };
+                    },
+                });
+            }
+            else {
+                ctx.server.connection.sendNotification(node_1.ShowMessageNotification.type, {
+                    message: "Couldn't load `prettier` or `prettier-plugin-astro`. Formatting will not work. Please make sure those two packages are installed into your project.",
+                    type: node_1.MessageType.Warning,
+                });
+            }
+        }
         return config;
     },
 });

package/dist/plugins/astro.js

@@ -59,8 +59,10 @@ exports.default = () => (context, modules) => {
             function walk() {
                 return ts.forEachChild(sourceFile, function cb(node) {
                     if (ts.isCallExpression(node) && node.expression.getText() === 'Astro.glob') {
-                        const globText = node.arguments.at(0).getText().slice(1, -1);
-                        globcodeLens.push(getGlobResultAsCodeLens(globText, (0, node_path_1.dirname)(context.env.uriToFileName(document.uri)), document.positionAt(node.arguments.pos)));
+                        const globArgument = node.arguments.at(0);
+                        if (globArgument) {
+                            globcodeLens.push(getGlobResultAsCodeLens(globArgument.getText().slice(1, -1), (0, node_path_1.dirname)(context.env.uriToFileName(document.uri)), document.positionAt(node.arguments.pos)));
+                        }
                     }
                     return ts.forEachChild(node, cb);
                 });

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
-import type { Point } from '@astrojs/compiler/types';
-import { HTMLDocument, Node, Position, Range, TextEdit } from 'vscode-html-languageservice';
+import type { AttributeNode, Position as CompilerPosition, Point } from '@astrojs/compiler/types';
+import { HTMLDocument, Position as LSPPosition, Node, Range, TextEdit } from 'vscode-html-languageservice';
 import type { FrontmatterStatus } from './core/parseAstro.js';
 export declare function isJSDocument(languageId: string): boolean;
 /**
@@ -22,7 +22,13 @@ export declare function isInsideFrontmatter(offset: number, frontmatter: Frontma
 /**
  * Transform a Point from the Astro compiler to an LSP Position
  */
-export declare function PointToPosition(point: Point): Position;
+export declare function PointToPosition(point: Point): LSPPosition;
+export declare function createCompilerPosition(start: Point, end: Point): CompilerPosition;
+export declare function createCompilerPoint(line: number, column: number, offset: number): Point;
+type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+export type AttributeNodeWithPosition = WithRequired<AttributeNode, 'position'>;
 /**
  * Force a range to be at the start of the frontmatter if it is outside
  */
@@ -30,3 +36,4 @@ export declare function ensureRangeIsInFrontmatter(range: Range, frontmatter: Fr
 export declare function getNewFrontmatterEdit(edit: TextEdit, newLine: string): TextEdit;
 export declare function getOpenFrontmatterEdit(edit: TextEdit, newLine: string): TextEdit;
 export declare function getWorkspacePnpPath(workspacePath: string): string | null;
+export {};

package/dist/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWorkspacePnpPath = exports.getOpenFrontmatterEdit = exports.getNewFrontmatterEdit = exports.ensureRangeIsInFrontmatter = exports.PointToPosition = exports.isInsideFrontmatter = exports.isInsideExpression = exports.isInComponentStartTag = exports.isPossibleComponent = exports.isJSDocument = void 0;
+exports.getWorkspacePnpPath = exports.getOpenFrontmatterEdit = exports.getNewFrontmatterEdit = exports.ensureRangeIsInFrontmatter = exports.createCompilerPoint = exports.createCompilerPosition = exports.PointToPosition = exports.isInsideFrontmatter = exports.isInsideExpression = exports.isInComponentStartTag = exports.isPossibleComponent = exports.isJSDocument = void 0;
 const node_path_1 = __importDefault(require("node:path"));
 const vscode_html_languageservice_1 = require("vscode-html-languageservice");
 function isJSDocument(languageId) {
@@ -59,6 +59,21 @@ function PointToPosition(point) {
     return vscode_html_languageservice_1.Position.create(point.line, point.column - 1);
 }
 exports.PointToPosition = PointToPosition;
+function createCompilerPosition(start, end) {
+    return {
+        start,
+        end,
+    };
+}
+exports.createCompilerPosition = createCompilerPosition;
+function createCompilerPoint(line, column, offset) {
+    return {
+        line,
+        column,
+        offset,
+    };
+}
+exports.createCompilerPoint = createCompilerPoint;
 /**
  * Force a range to be at the start of the frontmatter if it is outside
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/language-server",
-  "version": "2.0.0-next.9",
+  "version": "2.0.0",
   "author": "withastro",
   "license": "MIT",
   "repository": {
@@ -20,7 +20,7 @@
     "astro-ls": "./bin/nodeServer.js"
   },
   "dependencies": {
-    "@astrojs/compiler": "^1.4.2",
+    "@astrojs/compiler": "^1.5.0",
     "@jridgewell/sourcemap-codec": "^1.4.15",
     "@volar/kit": "^1.6.9",
     "@volar/language-core": "^1.6.9",
@@ -29,8 +29,6 @@
     "@volar/source-map": "^1.6.9",
     "fast-glob": "^3.2.12",
     "muggle-string": "^0.3.1",
-    "prettier": "^2.8.8",
-    "prettier-plugin-astro": "^0.9.1",
     "volar-service-css": "^0.0.4",
     "volar-service-emmet": "^0.0.4",
     "volar-service-html": "^0.0.4",
@@ -55,6 +53,18 @@
     "vscode-languageserver-protocol": "^3.17.3",
     "vscode-languageserver-textdocument": "^1.0.8"
   },
+  "peerDependencies": {
+    "prettier": "^2.8.8",
+    "prettier-plugin-astro": "^0.10.0"
+  },
+  "peerDependenciesMeta": {
+    "prettier": {
+      "optional": true
+    },
+    "prettier-plugin-astro": {
+      "optional": true
+    }
+  },
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",

package/dist/core/compilerUtils.d.ts

@@ -1,27 +0,0 @@
-/**
- * TODO: Upstream this
- */
-import type { AttributeNode, CommentNode, ComponentNode, CustomElementNode, DoctypeNode, ElementNode, ExpressionNode, FragmentNode, FrontmatterNode, LiteralNode, Node, ParentNode, Point, Position, RootNode, TagLikeNode, TextNode } from '@astrojs/compiler/types';
-export declare const is: {
-    parent(node: Node): node is ParentNode;
-    literal(node: Node): node is LiteralNode;
-    tag(node: Node): node is TagLikeNode;
-    whitespace(node: Node): node is TextNode;
-    root: (node: Node) => node is RootNode;
-    element: (node: Node) => node is ElementNode;
-    customElement: (node: Node) => node is CustomElementNode;
-    component: (node: Node) => node is ComponentNode;
-    fragment: (node: Node) => node is FragmentNode;
-    expression: (node: Node) => node is ExpressionNode;
-    text: (node: Node) => node is TextNode;
-    doctype: (node: Node) => node is DoctypeNode;
-    comment: (node: Node) => node is CommentNode;
-    frontmatter: (node: Node) => node is FrontmatterNode;
-};
-export declare function createCompilerPosition(start: Point, end: Point): Position;
-export declare function createCompilerPoint(line: number, column: number, offset: number): Point;
-type WithRequired<T, K extends keyof T> = T & {
-    [P in K]-?: T[P];
-};
-export type AttributeNodeWithPosition = WithRequired<AttributeNode, 'position'>;
-export {};

package/dist/core/compilerUtils.js

@@ -1,52 +0,0 @@
-"use strict";
-/**
- * TODO: Upstream this
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCompilerPoint = exports.createCompilerPosition = exports.is = void 0;
-function guard(type) {
-    return (node) => node.type === type;
-}
-exports.is = {
-    parent(node) {
-        return Array.isArray(node.children);
-    },
-    literal(node) {
-        return typeof node.value === 'string';
-    },
-    tag(node) {
-        return (node.type === 'element' ||
-            node.type === 'custom-element' ||
-            node.type === 'component' ||
-            node.type === 'fragment');
-    },
-    whitespace(node) {
-        return node.type === 'text' && node.value.trim().length === 0;
-    },
-    root: guard('root'),
-    element: guard('element'),
-    customElement: guard('custom-element'),
-    component: guard('component'),
-    fragment: guard('fragment'),
-    expression: guard('expression'),
-    text: guard('text'),
-    doctype: guard('doctype'),
-    comment: guard('comment'),
-    frontmatter: guard('frontmatter'),
-};
-function createCompilerPosition(start, end) {
-    return {
-        start,
-        end,
-    };
-}
-exports.createCompilerPosition = createCompilerPosition;
-function createCompilerPoint(line, column, offset) {
-    return {
-        line,
-        column,
-        offset,
-    };
-}
-exports.createCompilerPoint = createCompilerPoint;
-//# sourceMappingURL=compilerUtils.js.map