@astrojs/ts-plugin 1.0.9 → 1.1.0

package/src/astro-snapshots.ts

@@ -1,285 +0,0 @@
-import { EncodedSourceMap, originalPositionFor, TraceMap } from '@jridgewell/trace-mapping';
-import type ts from 'typescript/lib/tsserverlibrary';
-import { astro2tsx } from './astro2tsx.js';
-import type { Logger } from './logger.js';
-import { isAstroFilePath } from './utils.js';
-
-export class AstroSnapshot {
-	private scriptInfo?: ts.server.ScriptInfo;
-	private lineOffsets?: number[];
-	private convertInternalCodePositions = false;
-
-	constructor(
-		private typescript: typeof ts,
-		private fileName: string,
-		private astroCode: string,
-		private traceMap: TraceMap,
-		private logger: Logger
-	) {}
-
-	update(astroCode: string, traceMap: TraceMap) {
-		this.astroCode = astroCode;
-		this.traceMap = traceMap;
-		this.lineOffsets = undefined;
-		this.log('Updated Snapshot');
-	}
-
-	getOriginalTextSpan(textSpan: ts.TextSpan): ts.TextSpan | null {
-		const start = this.getOriginalOffset(textSpan.start);
-		if (start === -1) {
-			return null;
-		}
-
-		// Assumption: We don't change identifiers itself, so we don't change ranges.
-		return {
-			start,
-			length: textSpan.length,
-		};
-	}
-
-	getOriginalOffset(generatedOffset: number) {
-		if (!this.scriptInfo) {
-			return generatedOffset;
-		}
-
-		this.toggleMappingMode(true);
-		const lineOffset = this.scriptInfo.positionToLineOffset(generatedOffset);
-		this.debug('try convert offset', generatedOffset, '/', lineOffset);
-		const original = originalPositionFor(this.traceMap, {
-			line: lineOffset.line,
-			column: lineOffset.offset,
-		});
-		this.toggleMappingMode(false);
-
-		if (!original.line) {
-			return -1;
-		}
-
-		const originalOffset = this.scriptInfo.lineOffsetToPosition(original.line, original.column);
-		this.debug('converted offset to', original, '/', originalOffset);
-		return originalOffset;
-	}
-
-	setAndPatchScriptInfo(scriptInfo: ts.server.ScriptInfo) {
-		// @ts-expect-error
-		scriptInfo.scriptKind = this.typescript.ScriptKind.TSX;
-
-		const positionToLineOffset = scriptInfo.positionToLineOffset.bind(scriptInfo);
-		scriptInfo.positionToLineOffset = (position) => {
-			if (this.convertInternalCodePositions) {
-				const lineOffset = positionToLineOffset(position);
-				this.debug('positionToLineOffset for generated code', position, lineOffset);
-				return lineOffset;
-			}
-
-			const lineOffset = this.positionAt(position);
-			this.debug('positionToLineOffset for original code', position, lineOffset);
-			return { line: lineOffset.line + 1, offset: lineOffset.character + 1 };
-		};
-
-		const lineOffsetToPosition = scriptInfo.lineOffsetToPosition.bind(scriptInfo);
-		scriptInfo.lineOffsetToPosition = (line, offset) => {
-			if (this.convertInternalCodePositions) {
-				const position = lineOffsetToPosition(line, offset);
-				this.debug('lineOffsetToPosition for generated code', { line, offset }, position);
-				return position;
-			}
-
-			const position = this.offsetAt({ line: line - 1, character: offset - 1 });
-			this.debug('lineOffsetToPosition for original code', { line, offset }, position);
-			return position;
-		};
-
-		this.scriptInfo = scriptInfo;
-		this.log('patched scriptInfo');
-	}
-
-	/**
-	 * Get the line and character based on the offset
-	 * @param offset The index of the position
-	 */
-	positionAt(offset: number): ts.LineAndCharacter {
-		offset = this.clamp(offset, 0, this.astroCode.length);
-
-		const lineOffsets = this.getLineOffsets();
-		let low = 0;
-		let high = lineOffsets.length;
-		if (high === 0) {
-			return { line: 0, character: offset };
-		}
-
-		while (low < high) {
-			const mid = Math.floor((low + high) / 2);
-			if (lineOffsets[mid] > offset) {
-				high = mid;
-			} else {
-				low = mid + 1;
-			}
-		}
-
-		// low is the least x for which the line offset is larger than the current offset
-		// or array.length if no line offset is larger than the current offset
-		const line = low - 1;
-
-		return { line, character: offset - lineOffsets[line] };
-	}
-
-	/**
-	 * Get the index of the line and character position
-	 * @param position Line and character position
-	 */
-	offsetAt(position: ts.LineAndCharacter): number {
-		const lineOffsets = this.getLineOffsets();
-
-		if (position.line >= lineOffsets.length) {
-			return this.astroCode.length;
-		} else if (position.line < 0) {
-			return 0;
-		}
-
-		const lineOffset = lineOffsets[position.line];
-		const nextLineOffset =
-			position.line + 1 < lineOffsets.length
-				? lineOffsets[position.line + 1]
-				: this.astroCode.length;
-
-		return this.clamp(nextLineOffset, lineOffset, lineOffset + position.character);
-	}
-
-	private getLineOffsets() {
-		if (this.lineOffsets) {
-			return this.lineOffsets;
-		}
-
-		const lineOffsets = [];
-		const text = this.astroCode;
-		let isLineStart = true;
-
-		for (let i = 0; i < text.length; i++) {
-			if (isLineStart) {
-				lineOffsets.push(i);
-				isLineStart = false;
-			}
-			const ch = text.charAt(i);
-			isLineStart = ch === '\r' || ch === '\n';
-			if (ch === '\r' && i + 1 < text.length && text.charAt(i + 1) === '\n') {
-				i++;
-			}
-		}
-
-		if (isLineStart && text.length > 0) {
-			lineOffsets.push(text.length);
-		}
-
-		this.lineOffsets = lineOffsets;
-		return lineOffsets;
-	}
-
-	private clamp(num: number, min: number, max: number): number {
-		return Math.max(min, Math.min(max, num));
-	}
-
-	private log(...args: any[]) {
-		this.logger.log('AstroSnapshot:', this.fileName, '-', ...args);
-	}
-
-	private debug(...args: any[]) {
-		this.logger.debug('AstroSnapshot:', this.fileName, '-', ...args);
-	}
-
-	private toggleMappingMode(convertInternalCodePositions: boolean) {
-		this.convertInternalCodePositions = convertInternalCodePositions;
-	}
-
-	private getText() {
-		const snapshot = this.scriptInfo?.getSnapshot();
-		if (!snapshot) {
-			return '';
-		}
-		return snapshot.getText(0, snapshot.getLength());
-	}
-}
-
-export class AstroSnapshotManager {
-	private snapshots = new Map<string, AstroSnapshot>();
-
-	constructor(
-		private typescript: typeof ts,
-		private projectService: ts.server.ProjectService,
-		private logger: Logger
-	) {
-		this.patchProjectServiceReadFile();
-	}
-
-	get(fileName: string) {
-		return this.snapshots.get(fileName);
-	}
-
-	create(fileName: string): AstroSnapshot | undefined {
-		if (this.snapshots.has(fileName)) {
-			return this.snapshots.get(fileName)!;
-		}
-
-		// This will trigger projectService.host.readFile which is patched below
-		const scriptInfo = this.projectService.getOrCreateScriptInfoForNormalizedPath(
-			this.typescript.server.toNormalizedPath(fileName),
-			false
-		);
-		if (!scriptInfo) {
-			this.logger.log('Was not able get snapshot for', fileName);
-			return;
-		}
-
-		try {
-			scriptInfo.getSnapshot(); // needed to trigger readFile
-		} catch (e) {
-			this.logger.log('Loading Snapshot failed', fileName);
-		}
-		const snapshot = this.snapshots.get(fileName);
-		if (!snapshot) {
-			this.logger.log(
-				'Astro snapshot was not found after trying to load script snapshot for',
-				fileName
-			);
-			return; // should never get here
-		}
-		snapshot.setAndPatchScriptInfo(scriptInfo);
-		this.snapshots.set(fileName, snapshot);
-		return snapshot;
-	}
-
-	private patchProjectServiceReadFile() {
-		const readFile = this.projectService.host.readFile;
-		this.projectService.host.readFile = (path: string) => {
-			if (isAstroFilePath(path)) {
-				this.logger.debug('Read Astro file:', path);
-				const astroCode = readFile(path) || '';
-				try {
-					const result = astro2tsx(astroCode, path);
-					const existingSnapshot = this.snapshots.get(path);
-					if (existingSnapshot) {
-						existingSnapshot.update(astroCode, new TraceMap(result.map as EncodedSourceMap));
-					} else {
-						this.snapshots.set(
-							path,
-							new AstroSnapshot(
-								this.typescript,
-								path,
-								astroCode,
-								new TraceMap(result.map as EncodedSourceMap),
-								this.logger
-							)
-						);
-					}
-					this.logger.log('Successfully read Astro file contents of', path);
-					return result.code;
-				} catch (e) {
-					this.logger.log('Error loading Astro file:', path);
-					this.logger.debug('Error:', e);
-				}
-			} else {
-				return readFile(path);
-			}
-		};
-	}
-}

package/src/astro-sys.ts

@@ -1,35 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { Logger } from './logger.js';
-import { ensureRealAstroFilePath, isVirtualAstroFilePath, toRealAstroFilePath } from './utils.js';
-
-/**
- * This should only be accessed by TS astro module resolution.
- */
-export function createAstroSys(
-	logger: Logger,
-	typescript: typeof import('typescript/lib/tsserverlibrary')
-) {
-	const astroSys: ts.System = {
-		...typescript.sys,
-		fileExists(path: string) {
-			return typescript.sys.fileExists(ensureRealAstroFilePath(path));
-		},
-		readDirectory(path, extensions, exclude, include, depth) {
-			const extensionsWithAstro = (extensions ?? []).concat('.astro');
-
-			return typescript.sys.readDirectory(path, extensionsWithAstro, exclude, include, depth);
-		},
-	};
-
-	if (typescript.sys.realpath) {
-		const realpath = typescript.sys.realpath;
-		astroSys.realpath = function (path) {
-			if (isVirtualAstroFilePath(path)) {
-				return realpath(toRealAstroFilePath(path)) + '.ts';
-			}
-			return realpath(path);
-		};
-	}
-
-	return astroSys;
-}

package/src/astro2tsx.ts

@@ -1,26 +0,0 @@
-import { convertToTSX } from '@astrojs/compiler/sync';
-import type { TSXResult } from '@astrojs/compiler/types';
-
-export function astro2tsx(content: string, fileName: string): TSXResult {
-	try {
-		const tsx = convertToTSX(content, { filename: fileName });
-		return tsx;
-	} catch (e) {
-		console.error(
-			`There was an error transforming ${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: fileName,
-				sources: [],
-				sourcesContent: [],
-				names: [],
-				mappings: '',
-				version: 0,
-			},
-			diagnostics: [],
-		};
-	}
-}

package/src/index.ts

@@ -1,84 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import { AstroSnapshotManager } from './astro-snapshots.js';
-import { decorateLanguageService, isPatched } from './language-service/index.js';
-import { Logger } from './logger.js';
-import { patchModuleLoader } from './module-loader.js';
-import { ProjectAstroFilesManager } from './project-astro-files.js';
-import { getConfigPathForProject, readProjectAstroFilesFromFs } from './utils.js';
-
-function init(modules: { typescript: typeof import('typescript/lib/tsserverlibrary') }) {
-	const ts = modules.typescript;
-
-	function create(info: ts.server.PluginCreateInfo): ts.LanguageService {
-		const logger = new Logger(info.project.projectService.logger);
-		const parsedCommandLine = info.languageServiceHost.getParsedCommandLine?.(
-			getConfigPathForProject(info.project)
-		);
-
-		if (!isAstroProject(info.project, parsedCommandLine)) {
-			logger.log('Detected that this is not an Astro project, abort patching TypeScript');
-			return info.languageService;
-		}
-
-		if (isPatched(info.languageService)) {
-			return info.languageService;
-		}
-
-		logger.log('Starting Astro plugin');
-
-		const snapshotManager = new AstroSnapshotManager(
-			modules.typescript,
-			info.project.projectService,
-			logger
-		);
-		if (parsedCommandLine) {
-			new ProjectAstroFilesManager(
-				modules.typescript,
-				info.project,
-				info.serverHost,
-				snapshotManager,
-				parsedCommandLine
-			);
-		}
-
-		patchModuleLoader(
-			logger,
-			snapshotManager,
-			modules.typescript,
-			info.languageServiceHost,
-			info.project
-		);
-		return decorateLanguageService(info.languageService, snapshotManager, ts, logger);
-	}
-
-	function getExternalFiles(project: ts.server.ConfiguredProject) {
-		return ProjectAstroFilesManager.getInstance(project.getProjectName())?.getFiles() ?? [];
-	}
-
-	function isAstroProject(
-		project: ts.server.Project,
-		parsedCommandLine: ts.ParsedCommandLine | undefined
-	) {
-		if (parsedCommandLine) {
-			const astroFiles = readProjectAstroFilesFromFs(ts, project, parsedCommandLine);
-
-			if (astroFiles.length > 0) return true;
-		}
-
-		try {
-			const compilerOptions = project.getCompilerOptions();
-			const hasAstroInstalled =
-				typeof compilerOptions.configFilePath !== 'string' ||
-				require.resolve('astro', { paths: [compilerOptions.configFilePath] });
-
-			return hasAstroInstalled;
-		} catch (e) {
-			project.projectService.logger.info(e as string);
-			return false;
-		}
-	}
-
-	return { create, getExternalFiles };
-}
-
-export = init;

package/src/language-service/completions.ts

@@ -1,73 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { Logger } from '../logger.js';
-import { isAstroFilePath, replaceDeep } from '../utils.js';
-
-const componentPostfix = '__AstroComponent_';
-
-export function decorateCompletions(ls: ts.LanguageService, logger: Logger): void {
-	const getCompletionsAtPosition = ls.getCompletionsAtPosition;
-	ls.getCompletionsAtPosition = (fileName, position, options) => {
-		const completions = getCompletionsAtPosition(fileName, position, options);
-		if (!completions) {
-			return completions;
-		}
-		return {
-			...completions,
-			entries: completions.entries.map((entry) => {
-				if (!isAstroFilePath(entry.source || '') || !entry.name.endsWith(componentPostfix)) {
-					return entry;
-				}
-				return {
-					...entry,
-					name: entry.name.slice(0, -componentPostfix.length),
-				};
-			}),
-		};
-	};
-
-	const getCompletionEntryDetails = ls.getCompletionEntryDetails;
-	ls.getCompletionEntryDetails = (
-		fileName,
-		position,
-		entryName,
-		formatOptions,
-		source,
-		preferences,
-		data
-	) => {
-		if (!isAstroFilePath(source || '')) {
-			const details = getCompletionEntryDetails(
-				fileName,
-				position,
-				entryName,
-				formatOptions,
-				source,
-				preferences,
-				data
-			);
-
-			if (details) {
-				return details;
-			}
-		}
-
-		// In the completion list we removed the component postfix. Internally,
-		// the language service saved the list with the postfix, so details
-		// won't match anything. Therefore add it back and remove it afterwards again.
-		const astroDetails = getCompletionEntryDetails(
-			fileName,
-			position,
-			entryName + componentPostfix,
-			formatOptions,
-			source,
-			preferences,
-			data
-		);
-		if (!astroDetails) {
-			return undefined;
-		}
-		logger.debug('Found Astro Component import completion details');
-
-		return replaceDeep(astroDetails, componentPostfix, '');
-	};
-}

package/src/language-service/definition.ts

@@ -1,42 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { AstroSnapshotManager } from '../astro-snapshots';
-import { isAstroFilePath, isNotNullOrUndefined } from '../utils';
-
-export function decorateGetDefinition(
-	ls: ts.LanguageService,
-	snapshotManager: AstroSnapshotManager
-): void {
-	const getDefinitionAndBoundSpan = ls.getDefinitionAndBoundSpan;
-	ls.getDefinitionAndBoundSpan = (fileName, position) => {
-		const definition = getDefinitionAndBoundSpan(fileName, position);
-		if (!definition?.definitions) {
-			return definition;
-		}
-
-		return {
-			...definition,
-			definitions: definition.definitions
-				.map((def) => {
-					if (!isAstroFilePath(def.fileName)) {
-						return def;
-					}
-
-					let textSpan = snapshotManager.get(def.fileName)?.getOriginalTextSpan(def.textSpan);
-					if (!textSpan) {
-						// Unmapped positions are for example the default export.
-						// Fall back to the start of the file to at least go to the correct file.
-						textSpan = { start: 0, length: 1 };
-					}
-					return {
-						...def,
-						textSpan,
-						// Spare the work for now
-						originalTextSpan: undefined,
-						contextSpan: undefined,
-						originalContextSpan: undefined,
-					};
-				})
-				.filter(isNotNullOrUndefined),
-		};
-	};
-}

package/src/language-service/diagnostics.ts

@@ -1,73 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import { isAstroFilePath } from '../utils.js';
-
-type _ts = typeof ts;
-
-export enum DiagnosticCodes {
-	CANNOT_FIND_MODULE = 2307, // Cannot find module '{0}' or its corresponding type declarations.
-}
-
-export function decorateDiagnostics(ls: ts.LanguageService, typescript: _ts): void {
-	decorateSyntacticDiagnostics(ls);
-	decorateSemanticDiagnostics(ls, typescript);
-	decorateSuggestionDiagnostics(ls);
-}
-
-function decorateSyntacticDiagnostics(ls: ts.LanguageService): void {
-	const getSyntacticDiagnostics = ls.getSyntacticDiagnostics;
-	ls.getSyntacticDiagnostics = (fileName: string) => {
-		// Diagnostics inside Astro files are done
-		// by the @astrojs/language-server / Astro for VS Code extension
-		if (isAstroFilePath(fileName)) {
-			return [];
-		}
-		return getSyntacticDiagnostics(fileName);
-	};
-}
-
-function decorateSemanticDiagnostics(ls: ts.LanguageService, typescript: _ts): void {
-	const getSemanticDiagnostics = ls.getSemanticDiagnostics;
-	ls.getSemanticDiagnostics = (fileName: string) => {
-		// Diagnostics inside Astro files are done
-		// by the @astrojs/language-server / Astro for VS Code extension
-		if (isAstroFilePath(fileName)) {
-			return [];
-		}
-
-		let diagnostics = getSemanticDiagnostics(fileName);
-		diagnostics = diagnostics.map((diag) => {
-			const message = typescript.flattenDiagnosticMessageText(
-				diag.messageText,
-				typescript.sys.newLine
-			);
-			if (
-				diag.code === DiagnosticCodes.CANNOT_FIND_MODULE &&
-				message.includes('astro:content') &&
-				// TypeScript will keep the diagnostics here in cache, so if we just blindly always add to it, our added message will be there twice
-				// Not sure if there's a generic way to ensure that we only add it once, so for now we'll just check for the message we want to add
-				!message.includes('content collections')
-			) {
-				diag.messageText =
-					message +
-					`${typescript.sys.newLine}${typescript.sys.newLine}` +
-					"If you're using content collections, make sure to run `astro dev`, `astro build` or `astro sync` to first generate the types so you can import from them. If you already ran one of those commands, restarting the TS Server might be necessary in order for the change to take effect.";
-			}
-
-			return diag;
-		});
-
-		return diagnostics;
-	};
-}
-
-function decorateSuggestionDiagnostics(ls: ts.LanguageService): void {
-	const getSuggestionDiagnostics = ls.getSuggestionDiagnostics;
-	ls.getSuggestionDiagnostics = (fileName: string) => {
-		// Diagnostics inside Astro files are done
-		// by the @astrojs/language-server / Astro for VS Code extension
-		if (isAstroFilePath(fileName)) {
-			return [];
-		}
-		return getSuggestionDiagnostics(fileName);
-	};
-}

package/src/language-service/file-references.ts

@@ -1,34 +0,0 @@
-import type ts from 'typescript/lib/tsserverlibrary';
-import type { AstroSnapshotManager } from '../astro-snapshots.js';
-import { isAstroFilePath, isNotNullOrUndefined } from '../utils.js';
-
-export function decorateGetFileReferences(
-	ls: ts.LanguageService,
-	snapshotManager: AstroSnapshotManager
-): void {
-	const getFileReferences = ls.getFileReferences;
-	ls.getFileReferences = (fileName) => {
-		const references = getFileReferences(fileName);
-		return references
-			?.map((ref) => {
-				if (!isAstroFilePath(ref.fileName)) {
-					return ref;
-				}
-
-				const textSpan = snapshotManager.get(ref.fileName)?.getOriginalTextSpan(ref.textSpan);
-				if (!textSpan) {
-					return undefined;
-				}
-
-				return {
-					...ref,
-					textSpan,
-					// Spare the work for now
-					contextSpan: undefined,
-					originalTextSpan: undefined,
-					originalContextSpan: undefined,
-				};
-			})
-			.filter(isNotNullOrUndefined);
-	};
-}