@astrojs/language-server 2.2.0 → 2.3.0

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.2.0",
+  "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": {