Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: resolve Svelte components using TS from exports map #2478

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/language-server/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
dist/
.vscode/
node_modules/
!test/plugins/typescript/features/diagnostics/fixtures/exports-map-svelte/node_modules/
2 changes: 1 addition & 1 deletion packages/language-server/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"./bin/server.js": "./bin/server.js"
},
"scripts": {
"test": "cross-env TS_NODE_TRANSPILE_ONLY=true mocha --require ts-node/register \"test/**/*.ts\" --exclude \"test/**/*.d.ts\"",
"test": "cross-env TS_NODE_TRANSPILE_ONLY=true mocha --require ts-node/register \"test/**/*.test.ts\"",
"build": "tsc",
"prepublishOnly": "npm run build",
"watch": "tsc -w"
Expand Down
17 changes: 16 additions & 1 deletion packages/language-server/src/plugins/typescript/module-loader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ class ImpliedNodeFormatResolver {
return undefined;
}

let mode = undefined;
let mode: ReturnType<typeof ts.getModeForResolutionAtIndex> = undefined;
if (sourceFile) {
this.cacheImpliedNodeFormat(sourceFile, compilerOptions);
mode = ts.getModeForResolutionAtIndex(sourceFile, importIdxInFile, compilerOptions);
Expand Down Expand Up @@ -293,6 +293,21 @@ export function createSvelteModuleLoader(

const snapshot = getSnapshot(resolvedFileName);

// Align with TypeScript behavior: If the Svelte file is not using TypeScript,
// mark it as unresolved so that people need to provide a .d.ts file.
// For backwards compatibility we're not doing this for files from packages
// without an exports map, because that may break too many existing projects.
if (
resolvedModule.isExternalLibraryImport &&
resolvedModule.extension === '.d.svelte.ts' && // this tells us it's from an exports map
snapshot.scriptKind !== ts.ScriptKind.TS
) {
return {
...resolvedModuleWithFailedLookup,
resolvedModule: undefined
};
}

const resolvedSvelteModule: ts.ResolvedModuleFull = {
extension: getExtensionFromScriptKind(snapshot && snapshot.scriptKind),
resolvedFileName,
Expand Down
7 changes: 7 additions & 0 deletions packages/language-server/src/plugins/typescript/service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,13 @@ async function createLanguageService(
}
}

// Necessary to be able to resolve export maps that only contain a "svelte" condition without an accompanying "types" condition
// https://www.typescriptlang.org/tsconfig/#customConditions
if (!compilerOptions.customConditions?.includes('svelte')) {
compilerOptions.customConditions = compilerOptions.customConditions ?? [];
compilerOptions.customConditions.push('svelte');
}

const svelteConfigDiagnostics = checkSvelteInput(parsedConfig);
if (svelteConfigDiagnostics.length > 0) {
docContext.reportConfigError?.({
Expand Down
20 changes: 16 additions & 4 deletions packages/language-server/src/plugins/typescript/svelte-sys.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,17 @@ export function createSvelteSys(tsSystem: ts.System) {
function svelteFileExists(path: string) {
if (isVirtualSvelteFilePath(path)) {
const sveltePath = toRealSvelteFilePath(path);

// First check if there's a `.svelte.d.ts` or `.d.svelte.ts` file, which should take precedence
const dtsPath = sveltePath.slice(0, -7) + '.svelte.d.ts';
const dtsPathExists = fileExistsCache.get(dtsPath) ?? tsSystem.fileExists(dtsPath);
fileExistsCache.set(dtsPath, dtsPathExists);
if (dtsPathExists) return false;

const svelteDtsPathExists = fileExistsCache.get(path) ?? tsSystem.fileExists(path);
fileExistsCache.set(path, svelteDtsPathExists);
if (svelteDtsPathExists) return false;

const sveltePathExists =
fileExistsCache.get(sveltePath) ?? tsSystem.fileExists(sveltePath);
fileExistsCache.set(sveltePath, sveltePathExists);
Expand All @@ -33,10 +44,11 @@ export function createSvelteSys(tsSystem: ts.System) {
svelteFileExists,
getRealSveltePathIfExists,
fileExists(path: string) {
// We need to check both .svelte and .svelte.ts/js because that's how Svelte 5 will likely mark files with runes in them
// We need to check if this is a virtual svelte file
const sveltePathExists = svelteFileExists(path);
const exists =
sveltePathExists || (fileExistsCache.get(path) ?? tsSystem.fileExists(path));
if (sveltePathExists) return true;

const exists = fileExistsCache.get(path) ?? tsSystem.fileExists(path);
fileExistsCache.set(path, exists);
return exists;
},
Expand Down Expand Up @@ -66,7 +78,7 @@ export function createSvelteSys(tsSystem: ts.System) {
const realpath = tsSystem.realpath;
svelteSys.realpath = function (path) {
if (svelteFileExists(path)) {
return realpath(toRealSvelteFilePath(path)) + '.ts';
return realpath(toRealSvelteFilePath(path));
}
return realpath(path);
};
Expand Down
10 changes: 6 additions & 4 deletions packages/language-server/src/plugins/typescript/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,17 @@ export function isSvelteFilePath(filePath: string) {
}

export function isVirtualSvelteFilePath(filePath: string) {
return filePath.endsWith('.svelte.ts');
return filePath.endsWith('.d.svelte.ts');
}

export function toRealSvelteFilePath(filePath: string) {
return filePath.slice(0, -'.ts'.length);
return filePath.slice(0, -11 /* 'd.svelte.ts'.length */) + 'svelte';
}

export function toVirtualSvelteFilePath(filePath: string) {
return filePath.endsWith('.ts') ? filePath : filePath + '.ts';
export function toVirtualSvelteFilePath(svelteFilePath: string) {
return isVirtualSvelteFilePath(svelteFilePath)
? svelteFilePath
: svelteFilePath.slice(0, -6 /* 'svelte'.length */) + 'd.svelte.ts';
}

export function ensureRealSvelteFilePath(filePath: string) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[
{
"code": -1,
"message": "Unexpected token",
"range": {
"end": {
"character": 47,
"line": 12
},
"start": {
"character": 47,
"line": 12
}
},
"severity": 1,
"source": "ts"
}
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[
{
"code": 2307,
"message": "Cannot find module 'package/y' or its corresponding type declarations.",
"range": {
"start": {
"character": 38,
"line": 3
},
"end": {
"character": 49,
"line": 3
}
},
"severity": 1,
"source": "ts",
"tags": []
}
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<script lang="ts">
import DefaultSvelteWithTS from 'package';
import SubWithDTS from 'package/x';
import SubWithoutDTSAndNotTS from 'package/y';
</script>

<DefaultSvelteWithTS />
<SubWithDTS />
<SubWithoutDTSAndNotTS />

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"compilerOptions": {
"module": "esnext",
"target": "esnext",
"moduleResolution": "Bundler"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<script>
export let foo = true;
</script>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export declare const a: boolean;
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<script>
export let foo = true;
</script>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export const b = true;
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export declare const c: boolean;
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<script>
export let foo = true;
</script>
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<script>
export let foo = true;
</script>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export const d = true;
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<script lang="ts">
import { a } from './a.svelte';
import B from './b.svelte';
import { b } from './b.svelte.js';
import { c } from './c.svelte';
import D from './d.svelte';
import { d } from './d.svelte.js';
a;
b;
c;
d;
</script>

<B />
<D />
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"compilerOptions": {
"strict": true,
"allowJs": true,
"target": "ESNext",
/**
This is actually not needed, but makes the tests faster
because TS does not look up other types.
*/
"types": ["svelte"],
"allowArbitraryExtensions": true // else .d.svelte.ts will be an error
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ describe('createSvelteModuleLoader', () => {
it('uses svelte script kind if resolved module is svelte file', async () => {
const resolvedModule: ts.ResolvedModuleFull = {
extension: ts.Extension.Ts,
resolvedFileName: 'filename.svelte.ts'
resolvedFileName: 'filename.d.svelte.ts'
};
const { getSvelteSnapshotStub, moduleResolver, svelteSys } = setup(resolvedModule);

svelteSys.getRealSveltePathIfExists = (filename: string) =>
filename === 'filename.svelte.ts' ? 'filename.svelte' : filename;
filename === 'filename.d.svelte.ts' ? 'filename.svelte' : filename;

const result = moduleResolver.resolveModuleNames(
['./normal.ts'],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ describe('service', () => {
strict: true,
module: ts.ModuleKind.ESNext,
moduleResolution: ts.ModuleResolutionKind.Node10,
target: ts.ScriptTarget.ESNext
target: ts.ScriptTarget.ESNext,
customConditions: ['svelte']
});
});

Expand Down Expand Up @@ -185,7 +186,8 @@ describe('service', () => {
moduleResolution: ts.ModuleResolutionKind.Node10,
noEmit: true,
skipLibCheck: true,
target: ts.ScriptTarget.ESNext
target: ts.ScriptTarget.ESNext,
customConditions: ['svelte']
});
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,24 @@ describe('Svelte Sys', () => {
}

describe('#fileExists', () => {
it('should leave files with no .svelte.ts-ending as is', async () => {
it('should leave files with no .d.svelte.ts-ending as is', async () => {
const { loader, fileExistsStub } = setupLoader();
loader.fileExists('../file.ts');

assert.strictEqual(fileExistsStub.getCall(0).args[0], '../file.ts');
});

it('should convert .svelte.ts-endings', async () => {
it('should convert .d.svelte.ts-endings', async () => {
const { loader, fileExistsStub } = setupLoader();
loader.fileExists('../file.svelte.ts');
fileExistsStub.onCall(0).returns(false);
fileExistsStub.onCall(1).returns(false);
fileExistsStub.onCall(2).returns(true);

assert.strictEqual(fileExistsStub.getCall(0).args[0], '../file.svelte');
loader.fileExists('../file.d.svelte.ts');

assert.strictEqual(fileExistsStub.getCall(0).args[0], '../file.svelte.d.ts');
assert.strictEqual(fileExistsStub.getCall(1).args[0], '../file.d.svelte.ts');
assert.strictEqual(fileExistsStub.getCall(2).args[0], '../file.svelte');
});
});
});
2 changes: 1 addition & 1 deletion packages/typescript-plugin/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "typescript-svelte-plugin",
"version": "0.2.0",
"version": "0.3.0",
"description": "A TypeScript Plugin providing Svelte intellisense",
"main": "dist/src/index.js",
"scripts": {
Expand Down
Loading