@astrojs/language-server 2.1.4 → 2.3.0

package/dist/check.d.ts

@@ -1,24 +1,39 @@
 import * as kit from '@volar/kit';
-export { DiagnosticSeverity, type Diagnostic } from '@volar/language-server';
+import { Diagnostic, DiagnosticSeverity } from '@volar/language-server';
+export { DiagnosticSeverity, Diagnostic };
 export interface CheckResult {
-    errors: kit.Diagnostic[];
-    fileUrl: URL;
-    fileContent: string;
+    status: 'completed' | 'cancelled' | undefined;
+    fileChecked: number;
+    errors: number;
+    warnings: number;
+    hints: number;
+    fileResult: {
+        errors: kit.Diagnostic[];
+        fileUrl: URL;
+        fileContent: string;
+    }[];
 }
 export declare class AstroCheck {
     private readonly workspacePath;
     private readonly typescriptPath;
+    private readonly tsconfigPath;
     private ts;
-    private project;
+    project: ReturnType<typeof kit.createProject>;
     private linter;
-    constructor(workspacePath: string, typescriptPath: string | undefined);
+    constructor(workspacePath: string, typescriptPath: string | undefined, tsconfigPath: string | undefined);
     /**
      * Lint a list of files or the entire project and optionally log the errors found
      * @param fileNames List of files to lint, if undefined, all files included in the project will be linted
      * @param logErrors Whether to log errors by itself. This is disabled by default.
      * @return {CheckResult} The result of the lint, including a list of errors, the file's content and its file path.
      */
-    lint(fileNames?: string[] | undefined, logErrors?: boolean): Promise<CheckResult[]>;
+    lint({ fileNames, cancel, logErrors, }: {
+        fileNames?: string[] | undefined;
+        cancel?: () => boolean;
+        logErrors?: {
+            level: 'error' | 'warning' | 'hint';
+        } | undefined;
+    }): Promise<CheckResult>;
     private initialize;
     private getTsconfig;
 }

package/dist/check.js

@@ -26,8 +26,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AstroCheck = exports.DiagnosticSeverity = void 0;
+exports.AstroCheck = exports.Diagnostic = exports.DiagnosticSeverity = void 0;
 const kit = __importStar(require("@volar/kit"));
+const language_server_1 = require("@volar/language-server");
+Object.defineProperty(exports, "Diagnostic", { enumerable: true, get: function () { return language_server_1.Diagnostic; } });
+Object.defineProperty(exports, "DiagnosticSeverity", { enumerable: true, get: function () { return language_server_1.DiagnosticSeverity; } });
 const fast_glob_1 = __importDefault(require("fast-glob"));
 const node_url_1 = require("node:url");
 const index_js_1 = require("./core/index.js");
@@ -36,13 +39,11 @@ const vue_js_1 = require("./core/vue.js");
 const astro_js_1 = __importDefault(require("./plugins/astro.js"));
 const index_js_2 = __importDefault(require("./plugins/typescript/index.js"));
 const utils_js_1 = require("./utils.js");
-// Export those for downstream consumers
-var language_server_1 = require("@volar/language-server");
-Object.defineProperty(exports, "DiagnosticSeverity", { enumerable: true, get: function () { return language_server_1.DiagnosticSeverity; } });
 class AstroCheck {
-    constructor(workspacePath, typescriptPath) {
+    constructor(workspacePath, typescriptPath, tsconfigPath) {
         this.workspacePath = workspacePath;
         this.typescriptPath = typescriptPath;
+        this.tsconfigPath = tsconfigPath;
         this.initialize();
     }
     /**
@@ -51,27 +52,51 @@ class AstroCheck {
      * @param logErrors Whether to log errors by itself. This is disabled by default.
      * @return {CheckResult} The result of the lint, including a list of errors, the file's content and its file path.
      */
-    async lint(fileNames = undefined, logErrors = false) {
-        const files = fileNames !== undefined
-            ? fileNames
-            : this.project.languageHost.getScriptFileNames().filter((file) => file.endsWith('.astro'));
-        const errors = [];
+    async lint({ fileNames = undefined, cancel = () => false, logErrors = undefined, }) {
+        const files = fileNames !== undefined ? fileNames : this.project.languageHost.getScriptFileNames();
+        const result = {
+            status: undefined,
+            fileChecked: 0,
+            errors: 0,
+            warnings: 0,
+            hints: 0,
+            fileResult: [],
+        };
         for (const file of files) {
-            const fileErrors = await this.linter.check(file);
+            if (cancel()) {
+                result.status = 'cancelled';
+                return result;
+            }
+            const fileDiagnostics = (await this.linter.check(file)).filter((diag) => {
+                const severity = diag.severity ?? language_server_1.DiagnosticSeverity.Error;
+                switch (logErrors?.level ?? 'error') {
+                    case 'error':
+                        return true;
+                    case 'warning':
+                        return severity <= language_server_1.DiagnosticSeverity.Warning;
+                    case 'hint':
+                        return severity <= language_server_1.DiagnosticSeverity.Hint;
+                }
+            });
             if (logErrors) {
-                this.linter.logErrors(file, fileErrors);
+                this.linter.logErrors(file, fileDiagnostics);
             }
-            if (fileErrors.length > 0) {
+            if (fileDiagnostics.length > 0) {
                 const fileSnapshot = this.project.languageHost.getScriptSnapshot(file);
                 const fileContent = fileSnapshot?.getText(0, fileSnapshot.getLength());
-                errors.push({
-                    errors: fileErrors,
+                result.fileResult.push({
+                    errors: fileDiagnostics,
                     fileContent: fileContent ?? '',
                     fileUrl: (0, node_url_1.pathToFileURL)(file),
                 });
+                result.errors += fileDiagnostics.filter((diag) => diag.severity === language_server_1.DiagnosticSeverity.Error).length;
+                result.warnings += fileDiagnostics.filter((diag) => diag.severity === language_server_1.DiagnosticSeverity.Warning).length;
+                result.hints += fileDiagnostics.filter((diag) => diag.severity === language_server_1.DiagnosticSeverity.Hint).length;
             }
+            result.fileChecked += 1;
         }
-        return errors;
+        result.status = 'completed';
+        return result;
     }
     initialize() {
         this.ts = this.typescriptPath ? require(this.typescriptPath) : require('typescript');
@@ -106,8 +131,9 @@ class AstroCheck {
         this.linter = kit.createLinter(config, this.project.languageHost);
     }
     getTsconfig() {
-        const tsconfig = this.ts.findConfigFile(this.workspacePath, this.ts.sys.fileExists) ||
-            this.ts.findConfigFile(this.workspacePath, this.ts.sys.fileExists, 'jsconfig.json');
+        const searchPath = this.tsconfigPath ?? this.workspacePath;
+        const tsconfig = this.ts.findConfigFile(searchPath, this.ts.sys.fileExists) ||
+            this.ts.findConfigFile(searchPath, this.ts.sys.fileExists, 'jsconfig.json');
         return tsconfig;
     }
 }

package/dist/index.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DiagnosticSeverity = exports.AstroCheck = void 0;
+exports.DiagnosticSeverity = exports.Diagnostic = exports.AstroCheck = void 0;
 var check_js_1 = require("./check.js");
 Object.defineProperty(exports, "AstroCheck", { enumerable: true, get: function () { return check_js_1.AstroCheck; } });
+Object.defineProperty(exports, "Diagnostic", { enumerable: true, get: function () { return check_js_1.Diagnostic; } });
 Object.defineProperty(exports, "DiagnosticSeverity", { enumerable: true, get: function () { return check_js_1.DiagnosticSeverity; } });
 //# sourceMappingURL=index.js.map

package/dist/languageServerPlugin.js

@@ -15,7 +15,8 @@ const vue_js_1 = require("./core/vue.js");
 const importPackage_js_1 = require("./importPackage.js");
 const astro_js_1 = __importDefault(require("./plugins/astro.js"));
 const html_js_1 = __importDefault(require("./plugins/html.js"));
-const index_js_1 = __importDefault(require("./plugins/typescript/index.js"));
+const index_js_1 = require("./plugins/typescript-addons/index.js");
+const index_js_2 = __importDefault(require("./plugins/typescript/index.js"));
 const utils_js_1 = require("./utils.js");
 const plugin = (initOptions, modules) => ({
     extraFileExtensions: [
@@ -55,8 +56,9 @@ const plugin = (initOptions, modules) => ({
         config.services.html ??= (0, html_js_1.default)();
         config.services.css ??= (0, volar_service_css_1.default)();
         config.services.emmet ??= (0, volar_service_emmet_1.default)();
-        config.services.typescript ??= (0, index_js_1.default)();
+        config.services.typescript ??= (0, index_js_2.default)();
         config.services.typescripttwoslash ??= (0, volar_service_typescript_twoslash_queries_1.default)();
+        config.services.typescriptaddons ??= (0, index_js_1.createTypescriptAddonsService)();
         config.services.astro ??= (0, astro_js_1.default)();
         if (ctx) {
             const rootDir = ctx.env.uriToFileName(ctx.project.rootUri.toString());

package/dist/plugins/typescript/completions.js

@@ -6,11 +6,15 @@ function enhancedProvideCompletionItems(completions) {
     completions.items = completions.items.filter(isValidCompletion).map((completion) => {
         const source = completion?.data?.originalItem?.source;
         if (source) {
-            // For components import, use the file kind and sort them higher, as they're often what the user want over something else
+            // Sort completions starting with `astro:` higher than other imports
+            if (source.startsWith('astro:')) {
+                completion.sortText = '\u0000' + (completion.sortText ?? completion.label);
+            }
+            // For components import, use the file kind and sort them first, as they're often what the user want over something else
             if (['.astro', '.svelte', '.vue'].some((ext) => source.endsWith(ext))) {
                 completion.kind = language_server_1.CompletionItemKind.File;
                 completion.detail = completion.detail + '\n\n' + source;
-                completion.sortText = '\0';
+                completion.sortText = '\u0001' + (completion.sortText ?? completion.label);
                 completion.data.isComponent = true;
             }
         }

package/dist/plugins/typescript-addons/index.d.ts

@@ -0,0 +1,2 @@
+import type { Service } from '@volar/language-server';
+export declare const createTypescriptAddonsService: () => Service;

package/dist/plugins/typescript-addons/index.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTypescriptAddonsService = void 0;
+const index_js_1 = require("../../core/index.js");
+const utils_js_1 = require("../utils.js");
+const snippets_js_1 = require("./snippets.js");
+const createTypescriptAddonsService = () => (context) => {
+    return {
+        isAdditionalCompletion: true,
+        // Q: Why the empty transform and resolve functions?
+        // A: Volar will skip mapping the completion items if those functions are defined, as such we can return the snippets
+        // completions as-is, this is notably useful for snippets that insert to the frontmatter, since we don't need to map anything.
+        transformCompletionItem(item) {
+            return item;
+        },
+        provideCompletionItems(document, position, completionContext, token) {
+            if (!context ||
+                !utils_js_1.isJSDocument ||
+                token.isCancellationRequested ||
+                completionContext.triggerKind === 2)
+                return null;
+            const [_, source] = context.documents.getVirtualFileByUri(document.uri);
+            const file = source?.root;
+            if (!(file instanceof index_js_1.AstroFile))
+                return undefined;
+            if (!(0, utils_js_1.isInsideFrontmatter)(document.offsetAt(position), file.astroMeta.frontmatter))
+                return null;
+            const completionList = {
+                items: [],
+                isIncomplete: false,
+            };
+            completionList.items.push(...(0, snippets_js_1.getSnippetCompletions)(file.astroMeta.frontmatter));
+            return completionList;
+        },
+        resolveCompletionItem(item) {
+            return item;
+        },
+    };
+};
+exports.createTypescriptAddonsService = createTypescriptAddonsService;
+//# sourceMappingURL=index.js.map

package/dist/plugins/typescript-addons/snippets.d.ts

@@ -0,0 +1,3 @@
+import { type CompletionItem } from '@volar/language-server';
+import type { FrontmatterStatus } from '../../core/parseAstro.js';
+export declare function getSnippetCompletions(frontmatter: FrontmatterStatus): CompletionItem[];

package/dist/plugins/typescript-addons/snippets.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSnippetCompletions = void 0;
+const language_server_1 = require("@volar/language-server");
+function getSnippetCompletions(frontmatter) {
+    if (frontmatter.status === 'doesnt-exist')
+        return [];
+    const frontmatterStartPosition = {
+        line: frontmatter.position.start.line,
+        character: frontmatter.position.start.column - 1,
+    };
+    return [
+        {
+            label: 'interface Props',
+            kind: language_server_1.CompletionItemKind.Snippet,
+            labelDetails: { description: 'Create a new interface to type your props' },
+            documentation: {
+                kind: 'markdown',
+                value: [
+                    'Create a new interface to type your props.',
+                    '\n',
+                    '[Astro reference](https://docs.astro.build/en/guides/typescript/#component-props)',
+                ].join('\n'),
+            },
+            insertTextFormat: 2,
+            filterText: 'interface props',
+            insertText: 'interface Props {\n\t$1\n}',
+        },
+        {
+            label: 'getStaticPaths',
+            kind: language_server_1.CompletionItemKind.Snippet,
+            labelDetails: { description: 'Create a new getStaticPaths function' },
+            documentation: {
+                kind: 'markdown',
+                value: [
+                    'Create a new getStaticPaths function.',
+                    '\n',
+                    '[Astro reference](https://docs.astro.build/en/reference/api-reference/#getstaticpaths)',
+                ].join('\n'),
+            },
+            insertText: 'export const getStaticPaths = (() => {\n\t$1\n\treturn [];\n}) satisfies GetStaticPaths;',
+            additionalTextEdits: [
+                language_server_1.TextEdit.insert(frontmatterStartPosition, 'import type { GetStaticPaths } from "astro";\n'),
+            ],
+            filterText: 'getstaticpaths',
+            insertTextFormat: 2,
+        },
+        {
+            label: 'prerender',
+            kind: language_server_1.CompletionItemKind.Snippet,
+            labelDetails: { description: 'Add prerender export' },
+            documentation: {
+                kind: 'markdown',
+                value: [
+                    'Add prerender export. When [using server-side rendering](https://docs.astro.build/en/guides/server-side-rendering/#enabling-ssr-in-your-project), this value will be used to determine whether to prerender the page or not.',
+                    '\n',
+                    '[Astro reference](https://docs.astro.build/en/guides/server-side-rendering/#configuring-individual-routes)',
+                ].join('\n'),
+            },
+            insertText: 'export const prerender = ${1|true,false,import.meta.env.|}',
+            insertTextFormat: 2,
+        },
+    ];
+}
+exports.getSnippetCompletions = getSnippetCompletions;
+//# sourceMappingURL=snippets.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/language-server",
-  "version": "2.1.4",
+  "version": "2.3.0",
   "author": "withastro",
   "license": "MIT",
   "repository": {
@@ -55,7 +55,7 @@
   },
   "peerDependencies": {
     "prettier": "^3.0.0",
-    "prettier-plugin-astro": "^0.11.0"
+    "prettier-plugin-astro": ">=0.11.0"
   },
   "peerDependenciesMeta": {
     "prettier": {