@astrojs/ts-plugin 1.0.9 → 1.1.0

package/README.md

@@ -1,3 +1,27 @@
 # @astrojs/ts-plugin
 
-Work in progress TypeScript plugin adding support for `.astro` imports in `.ts` files
+> Using the Astro VS Code extension? This plugin is automatically installed and configured for you.
+
+TypeScript plugin adding support for `.astro` imports in `.ts` files. This plugin also adds support for renaming symbols and finding references across `.ts` and `.astro` files.
+
+## Installation
+
+```bash
+npm install --save-dev @astrojs/ts-plugin
+```
+
+## Usage
+
+Add the plugin to your `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "plugins": [
+      {
+        "name": "@astrojs/ts-plugin"
+      }
+    ]
+  }
+}
+```

package/dist/astro2tsx.d.ts

@@ -1,2 +1,15 @@
-import type { TSXResult } from '@astrojs/compiler/types';
-export declare function astro2tsx(content: string, fileName: string): TSXResult;
+import { VirtualFile } from '@volar/language-core';
+export declare function astro2tsx(input: string, fileName: string, ts: typeof import('typescript/lib/tsserverlibrary.js')): {
+    virtualFile: VirtualFile;
+    diagnostics: import("@astrojs/compiler").DiagnosticMessage[] | {
+        code: 1000;
+        location: {
+            file: string;
+            line: number;
+            column: number;
+            length: number;
+        };
+        severity: 1;
+        text: string;
+    }[];
+};

package/dist/astro2tsx.js

@@ -0,0 +1,142 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.astro2tsx = void 0;
+const sync_1 = require("@astrojs/compiler/sync");
+const sourcemap_codec_1 = require("@jridgewell/sourcemap-codec");
+const language_core_1 = require("@volar/language-core");
+const node_path_1 = __importDefault(require("node:path"));
+const vscode_languageserver_textdocument_1 = require("vscode-languageserver-textdocument");
+function safeConvertToTSX(content, options) {
+    try {
+        const tsx = (0, sync_1.convertToTSX)(content, { filename: options.filename });
+        return tsx;
+    }
+    catch (e) {
+        console.error(`There was an error transforming ${options.filename} to TSX. An empty file will be returned instead. Please create an issue: https://github.com/withastro/language-tools/issues\nError: ${e}.`);
+        return {
+            code: '',
+            map: {
+                file: options.filename ?? '',
+                sources: [],
+                sourcesContent: [],
+                names: [],
+                mappings: '',
+                version: 0,
+            },
+            diagnostics: [
+                {
+                    code: 1000,
+                    location: { file: options.filename, line: 1, column: 1, length: content.length },
+                    severity: 1,
+                    text: `The Astro compiler encountered an unknown error while parsing this file. Please create an issue with your code and the error shown in the server's logs: https://github.com/withastro/language-tools/issues`,
+                },
+            ],
+        };
+    }
+}
+function astro2tsx(input, fileName, ts) {
+    const tsx = safeConvertToTSX(input, { filename: fileName });
+    return {
+        virtualFile: getVirtualFileTSX(input, tsx, fileName, ts),
+        diagnostics: tsx.diagnostics,
+    };
+}
+exports.astro2tsx = astro2tsx;
+function getVirtualFileTSX(input, tsx, fileName, ts) {
+    tsx.code = patchTSX(tsx.code, fileName);
+    const v3Mappings = (0, sourcemap_codec_1.decode)(tsx.map.mappings);
+    const sourcedDoc = vscode_languageserver_textdocument_1.TextDocument.create(fileName, 'astro', 0, input);
+    const genDoc = vscode_languageserver_textdocument_1.TextDocument.create(fileName + '.tsx', 'typescriptreact', 0, tsx.code);
+    const mappings = [];
+    let current;
+    for (let genLine = 0; genLine < v3Mappings.length; genLine++) {
+        for (const segment of v3Mappings[genLine]) {
+            const genCharacter = segment[0];
+            const genOffset = genDoc.offsetAt({ line: genLine, character: genCharacter });
+            if (current) {
+                let length = genOffset - current.genOffset;
+                const sourceText = input.substring(current.sourceOffset, current.sourceOffset + length);
+                const genText = tsx.code.substring(current.genOffset, current.genOffset + length);
+                if (sourceText !== genText) {
+                    length = 0;
+                    for (let i = 0; i < genOffset - current.genOffset; i++) {
+                        if (sourceText[i] === genText[i]) {
+                            length = i + 1;
+                        }
+                        else {
+                            break;
+                        }
+                    }
+                }
+                if (length > 0) {
+                    const lastMapping = mappings.length ? mappings[mappings.length - 1] : undefined;
+                    if (lastMapping &&
+                        lastMapping.generatedRange[1] === current.genOffset &&
+                        lastMapping.sourceRange[1] === current.sourceOffset) {
+                        lastMapping.generatedRange[1] = current.genOffset + length;
+                        lastMapping.sourceRange[1] = current.sourceOffset + length;
+                    }
+                    else {
+                        mappings.push({
+                            sourceRange: [current.sourceOffset, current.sourceOffset + length],
+                            generatedRange: [current.genOffset, current.genOffset + length],
+                            data: language_core_1.FileRangeCapabilities.full,
+                        });
+                    }
+                }
+                current = undefined;
+            }
+            if (segment[2] !== undefined && segment[3] !== undefined) {
+                const sourceOffset = sourcedDoc.offsetAt({ line: segment[2], character: segment[3] });
+                current = {
+                    genOffset,
+                    sourceOffset,
+                };
+            }
+        }
+    }
+    const ast = ts.createSourceFile('/a.tsx', tsx.code, ts.ScriptTarget.ESNext);
+    if (ast.statements[0]) {
+        mappings.push({
+            sourceRange: [0, input.length],
+            generatedRange: [ast.statements[0].getStart(ast), tsx.code.length],
+            data: {},
+        });
+    }
+    return {
+        fileName: fileName + '.tsx',
+        kind: language_core_1.FileKind.TypeScriptHostFile,
+        capabilities: {
+            codeAction: true,
+            documentFormatting: false,
+            diagnostic: true,
+            documentSymbol: true,
+            inlayHint: true,
+            foldingRange: true,
+        },
+        codegenStacks: [],
+        snapshot: {
+            getText: (start, end) => tsx.code.substring(start, end),
+            getLength: () => tsx.code.length,
+            getChangeRange: () => undefined,
+        },
+        mappings: mappings,
+        embeddedFiles: [],
+    };
+}
+function patchTSX(code, fileName) {
+    const basename = node_path_1.default.basename(fileName, node_path_1.default.extname(fileName));
+    const isDynamic = basename.startsWith('[') && basename.endsWith(']');
+    return code.replace(/\b(\S*)__AstroComponent_/gm, (fullMatch, m1) => {
+        // If we don't have a match here, it usually means the file has a weird name that couldn't be expressed with valid identifier characters
+        if (!m1) {
+            if (basename === '404')
+                return 'FourOhFour';
+            return fullMatch;
+        }
+        return isDynamic ? `_${m1}_` : m1[0].toUpperCase() + m1.slice(1);
+    });
+}

package/dist/index.d.ts

@@ -1,8 +1,3 @@
 import type ts from 'typescript/lib/tsserverlibrary';
-declare function init(modules: {
-    typescript: typeof import('typescript/lib/tsserverlibrary');
-}): {
-    create: (info: ts.server.PluginCreateInfo) => ts.LanguageService;
-    getExternalFiles: (project: ts.server.ConfiguredProject) => string[];
-};
+declare const init: ts.server.PluginModuleFactory;
 export = init;

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+const language_core_1 = require("@volar/language-core");
+const typescript_1 = require("@volar/typescript");
+const language_js_1 = require("./language.js");
+const externalFiles = new WeakMap();
+const init = (modules) => {
+    const { typescript: ts } = modules;
+    const pluginModule = {
+        create(info) {
+            const virtualFiles = (0, language_core_1.createVirtualFiles)([(0, language_js_1.getLanguageModule)(ts)]);
+            (0, typescript_1.decorateLanguageService)(virtualFiles, info.languageService, true);
+            (0, typescript_1.decorateLanguageServiceHost)(virtualFiles, info.languageServiceHost, ts, ['.astro']);
+            return info.languageService;
+        },
+        getExternalFiles(project) {
+            if (!externalFiles.has(project)) {
+                externalFiles.set(project, (0, typescript_1.getExternalFiles)(ts, project, ['.astro']));
+            }
+            return externalFiles.get(project);
+        },
+    };
+    return pluginModule;
+};
+module.exports = init;

package/dist/language.d.ts

@@ -0,0 +1,17 @@
+import { FileCapabilities, FileKind, type Language, type VirtualFile } from '@volar/language-core';
+import type ts from 'typescript/lib/tsserverlibrary.js';
+export declare function getLanguageModule(ts: typeof import('typescript/lib/tsserverlibrary.js')): Language<AstroFile>;
+export declare class AstroFile implements VirtualFile {
+    sourceFileName: string;
+    snapshot: ts.IScriptSnapshot;
+    private readonly ts;
+    kind: FileKind;
+    capabilities: FileCapabilities;
+    fileName: string;
+    mappings: VirtualFile['mappings'];
+    embeddedFiles: VirtualFile['embeddedFiles'];
+    codegenStacks: never[];
+    constructor(sourceFileName: string, snapshot: ts.IScriptSnapshot, ts: typeof import('typescript/lib/tsserverlibrary.js'));
+    update(newSnapshot: ts.IScriptSnapshot): void;
+    onSnapshotUpdated(): void;
+}

package/dist/language.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AstroFile = exports.getLanguageModule = void 0;
+const language_core_1 = require("@volar/language-core");
+const astro2tsx_js_1 = require("./astro2tsx.js");
+function getLanguageModule(ts) {
+    return {
+        createVirtualFile(fileName, snapshot) {
+            if (fileName.endsWith('.astro')) {
+                return new AstroFile(fileName, snapshot, ts);
+            }
+        },
+        updateVirtualFile(astroFile, snapshot) {
+            astroFile.update(snapshot);
+        },
+    };
+}
+exports.getLanguageModule = getLanguageModule;
+class AstroFile {
+    constructor(sourceFileName, snapshot, ts) {
+        this.sourceFileName = sourceFileName;
+        this.snapshot = snapshot;
+        this.ts = ts;
+        this.kind = language_core_1.FileKind.TextFile;
+        this.capabilities = language_core_1.FileCapabilities.full;
+        this.codegenStacks = [];
+        this.fileName = sourceFileName;
+        this.onSnapshotUpdated();
+    }
+    update(newSnapshot) {
+        this.snapshot = newSnapshot;
+        this.onSnapshotUpdated();
+    }
+    onSnapshotUpdated() {
+        this.mappings = [
+            {
+                sourceRange: [0, this.snapshot.getLength()],
+                generatedRange: [0, this.snapshot.getLength()],
+                data: language_core_1.FileRangeCapabilities.full,
+            },
+        ];
+        this.embeddedFiles = [];
+        const tsx = (0, astro2tsx_js_1.astro2tsx)(this.snapshot.getText(0, this.snapshot.getLength()), this.fileName, this.ts);
+        this.embeddedFiles.push(tsx.virtualFile);
+    }
+}
+exports.AstroFile = AstroFile;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/ts-plugin",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "description": "A TypeScript Plugin providing Astro intellisense",
   "main": "dist/index.js",
   "type": "commonjs",
@@ -15,11 +15,18 @@
     "javascript",
     "plugin"
   ],
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
   "author": "withastro",
   "license": "MIT",
   "dependencies": {
-    "@astrojs/compiler": "^1.5.1",
-    "@jridgewell/trace-mapping": "^0.3.18"
+    "@volar/language-core": "~1.9.0",
+    "@volar/typescript": "~1.9.0",
+    "@astrojs/compiler": "1.5.7",
+    "@jridgewell/sourcemap-codec": "^1.4.15",
+    "vscode-languageserver-textdocument": "^1.0.8"
   },
   "devDependencies": {
     "@types/chai": "^4.3.5",

package/.turbo/turbo-build.log

@@ -1,4 +0,0 @@
-
-> @astrojs/ts-plugin@1.0.9 build /home/runner/work/language-tools/language-tools/packages/ts-plugin
-> tsc
-

package/CHANGELOG.md

@@ -1,113 +0,0 @@
-# @astrojs/ts-plugin
-
-## 1.0.9
-
-### Patch Changes
-
-- b6a98e0: Better handle when the Astro compiler fails to parse a file
-
-## 1.0.8
-
-### Patch Changes
-
-- 170a193: Update dependencies
-
-## 1.0.7
-
-### Patch Changes
-
-- c6cf1d7: Update Prettier plugin version
-
-## 1.0.6
-
-### Patch Changes
-
-- 3fcbc1a: Fix TypeScript plugin crashing at start in certain circumstances
-
-## 1.0.5
-
-### Patch Changes
-
-- ae15420: Fix importing `.astro` files in `.ts` files not working with TypeScript 5.0+
-
-## 1.0.4
-
-### Patch Changes
-
-- eaefe96: Fix packaging error
-
-## 1.0.3
-
-### Patch Changes
-
-- 685513b: Improve stability related to converting files to TSX
-
-## 1.0.0
-
-### Major Changes
-
-- 39a7669: 1.0! This release includes no new changes by itself, but symbolize the official release of what was previously the pre-release version of the extension. For changelogs, please refer to the changelog from `0.29.0` to now.
-
-## 0.4.5
-
-### Patch Changes
-
-- 8ff8bdf: Update compiler version to fix Windows mapping issue
-
-## 0.4.4
-
-### Patch Changes
-
-- c04adf3: Upgrade compiler version to 1.1.1
-
-## 0.4.3
-
-### Patch Changes
-
-- 6b81412: Added an explanation on how to generate types for content collections to the error message for the `astro:content` import
-
-## 0.4.2
-
-### Patch Changes
-
-- 94a9b61: Add proper support for renaming symbols inside Astro (.astro) files
-
-## 0.4.1
-
-### Patch Changes
-
-- 985515d: Update `@astrojs/compiler`, fixing a few bugs
-
-## 0.4.0
-
-### Minor Changes
-
-- c8cdef9: Improved support for `.astro` imports inside JavaScript/TypeScript files:
-  - Added support for finding file references inside Astro files
-  - Added support for path completions for .astro, .md and .mdx files
-  - Fixed cases where our TypeScript plugin would fail to load under certain circumstance
-  - Fixed certain cases where Go to definition / implementation would fail
-
-## 0.3.0
-
-### Minor Changes
-
-- b66ae70: Update the VS Code extension to use a bundled version of the language server for better performance and compatibility with running the extension in the web
-
-## 0.2.1
-
-### Patch Changes
-
-- d056cd5: Fixes production bugs in extension
-
-## 0.2.0
-
-### Minor Changes
-
-- 6b6b47a: Remove internal astro.d.ts files, instead prefer the one provided by Astro itself
-
-## 0.1.1
-
-### Patch Changes
-
-- f1f3091: Fix commenting, namespaced elements, and Fragment typings

package/dist/astro-snapshots.d.ts

@@ -1,44 +0,0 @@
-import { TraceMap } from '@jridgewell/trace-mapping';
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { Logger } from './logger.js';
-export declare class AstroSnapshot {
-    private typescript;
-    private fileName;
-    private astroCode;
-    private traceMap;
-    private logger;
-    private scriptInfo?;
-    private lineOffsets?;
-    private convertInternalCodePositions;
-    constructor(typescript: typeof ts, fileName: string, astroCode: string, traceMap: TraceMap, logger: Logger);
-    update(astroCode: string, traceMap: TraceMap): void;
-    getOriginalTextSpan(textSpan: ts.TextSpan): ts.TextSpan | null;
-    getOriginalOffset(generatedOffset: number): number;
-    setAndPatchScriptInfo(scriptInfo: ts.server.ScriptInfo): void;
-    /**
-     * Get the line and character based on the offset
-     * @param offset The index of the position
-     */
-    positionAt(offset: number): ts.LineAndCharacter;
-    /**
-     * Get the index of the line and character position
-     * @param position Line and character position
-     */
-    offsetAt(position: ts.LineAndCharacter): number;
-    private getLineOffsets;
-    private clamp;
-    private log;
-    private debug;
-    private toggleMappingMode;
-    private getText;
-}
-export declare class AstroSnapshotManager {
-    private typescript;
-    private projectService;
-    private logger;
-    private snapshots;
-    constructor(typescript: typeof ts, projectService: ts.server.ProjectService, logger: Logger);
-    get(fileName: string): AstroSnapshot | undefined;
-    create(fileName: string): AstroSnapshot | undefined;
-    private patchProjectServiceReadFile;
-}

package/dist/astro-sys.d.ts

@@ -1,6 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { Logger } from './logger.js';
-/**
- * This should only be accessed by TS astro module resolution.
- */
-export declare function createAstroSys(logger: Logger, typescript: typeof import('typescript/lib/tsserverlibrary')): ts.System;

package/dist/language-service/completions.d.ts

@@ -1,3 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { Logger } from '../logger.js';
-export declare function decorateCompletions(ls: ts.LanguageService, logger: Logger): void;

package/dist/language-service/definition.d.ts

@@ -1,3 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { AstroSnapshotManager } from '../astro-snapshots';
-export declare function decorateGetDefinition(ls: ts.LanguageService, snapshotManager: AstroSnapshotManager): void;

package/dist/language-service/diagnostics.d.ts

@@ -1,7 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-type _ts = typeof ts;
-export declare enum DiagnosticCodes {
-    CANNOT_FIND_MODULE = 2307
-}
-export declare function decorateDiagnostics(ls: ts.LanguageService, typescript: _ts): void;
-export {};

package/dist/language-service/file-references.d.ts

@@ -1,3 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { AstroSnapshotManager } from '../astro-snapshots.js';
-export declare function decorateGetFileReferences(ls: ts.LanguageService, snapshotManager: AstroSnapshotManager): void;

package/dist/language-service/find-references.d.ts

@@ -1,4 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { AstroSnapshotManager } from '../astro-snapshots.js';
-import type { Logger } from '../logger';
-export declare function decorateFindReferences(ls: ts.LanguageService, snapshotManager: AstroSnapshotManager, logger: Logger): void;

package/dist/language-service/implementation.d.ts

@@ -1,3 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { AstroSnapshotManager } from '../astro-snapshots.js';
-export declare function decorateGetImplementation(ls: ts.LanguageService, snapshotManager: AstroSnapshotManager): void;

package/dist/language-service/index.d.ts

@@ -1,5 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { AstroSnapshotManager } from '../astro-snapshots.js';
-import type { Logger } from '../logger';
-export declare function isPatched(ls: ts.LanguageService): boolean;
-export declare function decorateLanguageService(ls: ts.LanguageService, snapshotManager: AstroSnapshotManager, ts: typeof import('typescript/lib/tsserverlibrary'), logger: Logger): ts.LanguageService;

package/dist/language-service/line-column-offset.d.ts

@@ -1,3 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { AstroSnapshotManager } from '../astro-snapshots';
-export declare function decorateLineColumnOffset(ls: ts.LanguageService, snapshotManager: AstroSnapshotManager): void;

package/dist/language-service/rename.d.ts

@@ -1,4 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { AstroSnapshotManager } from '../astro-snapshots.js';
-import type { Logger } from '../logger.js';
-export declare function decorateRename(ls: ts.LanguageService, snapshotManager: AstroSnapshotManager, logger: Logger): void;

package/dist/logger.d.ts

@@ -1,8 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-export declare class Logger {
-    private tsLogService;
-    private logDebug;
-    constructor(tsLogService: ts.server.Logger, suppressNonAstroLogs?: boolean, logDebug?: boolean);
-    log(...args: any[]): void;
-    debug(...args: any[]): void;
-}

package/dist/module-loader.d.ts

@@ -1,13 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { AstroSnapshotManager } from './astro-snapshots.js';
-import type { Logger } from './logger.js';
-/**
- * Creates a module loader than can also resolve `.astro` files.
- *
- * The typescript language service tries to look up other files that are referenced in the currently open astro file.
- * For `.ts`/`.js` files this works, for `.astro` files it does not by default.
- * Reason: The typescript language service does not know about the `.astro` file ending,
- * so it assumes it's a normal typescript file and searches for files like `../Component.astro.ts`, which is wrong.
- * In order to fix this, we need to wrap typescript's module resolution and reroute all `.astro.ts` file lookups to .astro.
- */
-export declare function patchModuleLoader(logger: Logger, snapshotManager: AstroSnapshotManager, typescript: typeof ts, lsHost: ts.LanguageServiceHost, project: ts.server.Project): void;

package/dist/project-astro-files.d.ts

@@ -1,28 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { AstroSnapshotManager } from './astro-snapshots';
-export declare class ProjectAstroFilesManager {
-    private readonly typescript;
-    private readonly project;
-    private readonly serverHost;
-    private readonly snapshotManager;
-    private parsedCommandLine;
-    private files;
-    private directoryWatchers;
-    private static instances;
-    static getInstance(projectName: string): ProjectAstroFilesManager | undefined;
-    constructor(typescript: typeof ts, project: ts.server.Project, serverHost: ts.server.ServerHost, snapshotManager: AstroSnapshotManager, parsedCommandLine: ts.ParsedCommandLine);
-    updateProjectConfig(serviceHost: ts.LanguageServiceHost): void;
-    getFiles(): string[];
-    /**
-     * Create directory watcher for include and exclude
-     * The watcher in tsserver doesn't support astro file
-     * It won't add new created astro file to root
-     */
-    private setupWatchers;
-    private watcherCallback;
-    private updateProjectAstroFiles;
-    private addFileToProject;
-    private removeFileFromProject;
-    private disposeWatchersAndFiles;
-    dispose(): void;
-}

package/dist/utils.d.ts

@@ -1,16 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-export declare function isAstroFilePath(filePath: string): boolean;
-export declare function isVirtualAstroFilePath(filePath: string): boolean;
-export declare function toRealAstroFilePath(filePath: string): string;
-export declare function ensureRealAstroFilePath(filePath: string): string;
-export declare function isNotNullOrUndefined<T>(val: T | undefined | null): val is T;
-/**
- * Replace all occurrences of a string within an object with another string,
- */
-export declare function replaceDeep<T extends Record<string, any>>(obj: T, searchStr: string | RegExp, replacementStr: string): T;
-export declare function getConfigPathForProject(project: ts.server.Project): ts.server.NormalizedPath;
-export declare function readProjectAstroFilesFromFs(ts: typeof import('typescript/lib/tsserverlibrary'), project: ts.server.Project, parsedCommandLine: ts.ParsedCommandLine): ts.server.NormalizedPath[];
-export interface TsFilesSpec {
-    include?: readonly string[];
-    exclude?: readonly string[];
-}