Skip to content

test(ts-plugin): return normalized results from the e2e tsserver client #443

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.

Sign up for GitHub

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

Merged
mizdra merged 1 commit into from
Sep 9, 2026
Merged

test(ts-plugin): return normalized results from the e2e tsserver client #443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
270 changes: 127 additions & 143 deletions packages/ts-plugin/e2e-test/code-fix.test.ts
View file
Open in desktop

Large diffs are not rendered by default.

106 changes: 48 additions & 58 deletions packages/ts-plugin/e2e-test/completion.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ import ts from 'typescript';
import { describe, expect, test } from 'vite-plus/test';
import { buildStylesImport, buildTSConfigJSON } from '../src/test/builder.js';
import { setupFixture } from './test-util/fixture.js';
import { launchTsserver, normalizeCompletionDetails, normalizeCompletionEntry } from './test-util/tsserver.js';
import { launchTsserver } from './test-util/tsserver.js';

const reactDtsPath = join(require.resolve('@types/react/package.json'), '../index.d.ts');
const tsserver = launchTsserver();

describe.each([{ namedExports: false }, { namedExports: true }])('namedExports: $namedExports', ({ namedExports }) => {
describe('styles binding suggestion', () => {
test('prioritizes the CSS module corresponding to the current component file', async () => {
const { iff, getRange } = await setupFixture({
const { iff, getFileSpan } = await setupFixture({
'tsconfig.json': buildTSConfigJSON({ cmkOptions: { namedExports } }),
'a.tsx': `styles;`,
'a.module.css': '',
Expand All @@ -26,23 +26,19 @@ describe.each([{ namedExports: false }, { namedExports: true }])('namedExports:
},
});

const res = await tsserver.sendCompletionInfo({
const entries = await tsserver.sendCompletionInfo({
file: iff.paths['a.tsx'],
...getRange('a.tsx', 'styles').end,
...getFileSpan('a.tsx', 'styles').end,
});

expect(
normalizeCompletionEntry(res.body?.entries.filter((entry) => entry.name === 'styles') ?? []),
).toStrictEqual(
normalizeCompletionEntry([
{ name: 'styles', sortText: '0', source: './a.module.css' },
{ name: 'styles', sortText: '16', source: './b.module.css' },
]),
);
expect(entries.filter((entry) => entry.name === 'styles')).toStrictEqual([
{ name: 'styles', sortText: '0', source: './a.module.css' },
{ name: 'styles', sortText: '16', source: './b.module.css' },
]);
});

test('excludes generated files from suggestions', async () => {
const { iff, getRange } = await setupFixture({
const { iff, getFileSpan } = await setupFixture({
'tsconfig.json': buildTSConfigJSON({
cmkOptions: { namedExports, dtsOutDir: 'generated' },
}),
Expand All @@ -61,18 +57,18 @@ describe.each([{ namedExports: false }, { namedExports: true }])('namedExports:
},
});

const res = await tsserver.sendCompletionInfo({
const entries = await tsserver.sendCompletionInfo({
file: iff.paths['a.tsx'],
...getRange('a.tsx', 'styles').end,
...getFileSpan('a.tsx', 'styles').end,
});

expect(
normalizeCompletionEntry(res.body?.entries.filter((entry) => entry.name === 'styles') ?? []),
).toStrictEqual(normalizeCompletionEntry([{ name: 'styles', sortText: '0', source: './a.module.css' }]));
expect(entries.filter((entry) => entry.name === 'styles')).toStrictEqual([
{ name: 'styles', sortText: '0', source: './a.module.css' },
]);
});

test('inserts the import statement when accepted', async () => {
const { iff, getRange } = await setupFixture({
const { iff, getFileSpan } = await setupFixture({
'tsconfig.json': buildTSConfigJSON({ cmkOptions: { namedExports } }),
'index.ts': `styles;`,
'a.module.css': '',
Expand All @@ -82,9 +78,9 @@ describe.each([{ namedExports: false }, { namedExports: true }])('namedExports:
preferences: { quotePreference: 'single' },
});

const res = await tsserver.sendCompletionDetails({
const details = await tsserver.sendCompletionDetails({
file: iff.paths['index.ts'],
...getRange('index.ts', 'styles').end,
...getFileSpan('index.ts', 'styles').end,
entryNames: [
{
name: 'styles',
Expand All @@ -99,7 +95,7 @@ describe.each([{ namedExports: false }, { namedExports: true }])('namedExports:
});

const importStatement = buildStylesImport('./a.module.css', { namedExports });
expect(normalizeCompletionDetails(res.body!)).toStrictEqual([
expect(details).toStrictEqual([
{
codeActions: [
{
Expand All @@ -122,7 +118,7 @@ describe.each([{ namedExports: false }, { namedExports: true }])('namedExports:
});

test('suggests the styles entry with an import-alias source', async () => {
const { iff, getRange } = await setupFixture({
const { iff, getFileSpan } = await setupFixture({
'tsconfig.json': buildTSConfigJSON({
compilerOptions: { paths: { '@/*': ['./*'] } },
cmkOptions: { namedExports },
Expand All @@ -138,22 +134,22 @@ describe.each([{ namedExports: false }, { namedExports: true }])('namedExports:
},
});

const res = await tsserver.sendCompletionInfo({
const entries = await tsserver.sendCompletionInfo({
file: iff.paths['index.ts'],
...getRange('index.ts', 'styles').end,
...getFileSpan('index.ts', 'styles').end,
});

expect(
normalizeCompletionEntry(res.body?.entries.filter((entry) => entry.name === 'styles') ?? []),
).toStrictEqual(normalizeCompletionEntry([{ name: 'styles', sortText: '16', source: '@/a.module.css' }]));
expect(entries.filter((entry) => entry.name === 'styles')).toStrictEqual([
{ name: 'styles', sortText: '16', source: '@/a.module.css' },
]);
});
});

describe('className attribute snippet', () => {
test.each([{ quotePreference: 'single' as const }, { quotePreference: 'double' as const }])(
'completes as className={$$1} with quotePreference: $quotePreference',
async ({ quotePreference }) => {
const { iff, getRange } = await setupFixture({
const { iff, getFileSpan } = await setupFixture({
'tsconfig.json': buildTSConfigJSON({
compilerOptions: { jsx: 'react-jsx', types: [reactDtsPath] },
cmkOptions: { namedExports },
Expand All @@ -174,16 +170,14 @@ describe.each([{ namedExports: false }, { namedExports: true }])('namedExports:
},
});

const res = await tsserver.sendCompletionInfo({
const entries = await tsserver.sendCompletionInfo({
file: iff.paths['a.tsx'],
...getRange('a.tsx', 'className').end,
...getFileSpan('a.tsx', 'className').end,
});

expect(
normalizeCompletionEntry(res.body?.entries.filter((entry) => entry.name === 'className') ?? []),
).toStrictEqual(
normalizeCompletionEntry([{ name: 'className', insertText: 'className={$1}', sortText: expect.anything() }]),
);
expect(entries.filter((entry) => entry.name === 'className')).toStrictEqual([
{ name: 'className', insertText: 'className={$1}', sortText: expect.anything() },
]);
},
);
});
Expand All @@ -192,7 +186,7 @@ describe.each([{ namedExports: false }, { namedExports: true }])('namedExports:
describe('prioritizeNamedImports (namedExports: true)', () => {
describe('prioritizeNamedImports: false', () => {
test('omits named token auto-imports', async () => {
const { iff, getRange } = await setupFixture({
const { iff, getFileSpan } = await setupFixture({
'tsconfig.json': buildTSConfigJSON({
cmkOptions: { namedExports: true, prioritizeNamedImports: false },
}),
Expand All @@ -204,18 +198,16 @@ describe('prioritizeNamedImports (namedExports: true)', () => {
preferences: { includeCompletionsForModuleExports: true },
});

const res = await tsserver.sendCompletionInfo({
const entries = await tsserver.sendCompletionInfo({
file: iff.paths['index.ts'],
...getRange('index.ts', 'a_1').end,
...getFileSpan('index.ts', 'a_1').end,
});

expect(normalizeCompletionEntry(res.body?.entries.filter((entry) => entry.name === 'a_1') ?? [])).toStrictEqual(
[],
);
expect(entries.filter((entry) => entry.name === 'a_1')).toStrictEqual([]);
});

test('omits the default export from namespace member completion', async () => {
const { iff, getRange } = await setupFixture({
const { iff, getFileSpan } = await setupFixture({
'tsconfig.json': buildTSConfigJSON({
cmkOptions: { namedExports: true, prioritizeNamedImports: false },
}),
Expand All @@ -230,20 +222,20 @@ describe('prioritizeNamedImports (namedExports: true)', () => {
preferences: { includeCompletionsForModuleExports: true },
});

const res = await tsserver.sendCompletionInfo({
const entries = await tsserver.sendCompletionInfo({
file: iff.paths['index.ts'],
...getRange('index.ts', 'styles.').end,
...getFileSpan('index.ts', 'styles.').end,
});

const names = res.body?.entries.map((entry) => entry.name) ?? [];
const names = entries.map((entry) => entry.name);
expect(names).toContain('a_1');
expect(names).not.toContain('default');
});
});

describe('prioritizeNamedImports: true', () => {
test('omits the styles binding auto-import', async () => {
const { iff, getRange } = await setupFixture({
const { iff, getFileSpan } = await setupFixture({
'tsconfig.json': buildTSConfigJSON({
cmkOptions: { namedExports: true, prioritizeNamedImports: true },
}),
Expand All @@ -255,18 +247,16 @@ describe('prioritizeNamedImports (namedExports: true)', () => {
preferences: { includeCompletionsForModuleExports: true },
});

const res = await tsserver.sendCompletionInfo({
const entries = await tsserver.sendCompletionInfo({
file: iff.paths['index.ts'],
...getRange('index.ts', 'styles').end,
...getFileSpan('index.ts', 'styles').end,
});

expect(
normalizeCompletionEntry(res.body?.entries.filter((entry) => entry.name === 'styles') ?? []),
).toStrictEqual([]);
expect(entries.filter((entry) => entry.name === 'styles')).toStrictEqual([]);
});

test('suggests named token auto-imports', async () => {
const { iff, getRange } = await setupFixture({
const { iff, getFileSpan } = await setupFixture({
'tsconfig.json': buildTSConfigJSON({
cmkOptions: { namedExports: true, prioritizeNamedImports: true },
}),
Expand All @@ -278,14 +268,14 @@ describe('prioritizeNamedImports (namedExports: true)', () => {
preferences: { includeCompletionsForModuleExports: true },
});

const res = await tsserver.sendCompletionInfo({
const entries = await tsserver.sendCompletionInfo({
file: iff.paths['index.ts'],
...getRange('index.ts', 'a_1').end,
...getFileSpan('index.ts', 'a_1').end,
});

expect(normalizeCompletionEntry(res.body?.entries.filter((entry) => entry.name === 'a_1') ?? [])).toStrictEqual(
normalizeCompletionEntry([{ name: 'a_1', sortText: '16', source: './a.module.css' }]),
);
expect(entries.filter((entry) => entry.name === 'a_1')).toStrictEqual([
{ name: 'a_1', sortText: '16', source: './a.module.css' },
]);
});
});
});
11 changes: 4 additions & 7 deletions packages/ts-plugin/e2e-test/enabled.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import dedent from 'dedent';
import { expect, test } from 'vite-plus/test';
import { setupFixture } from './test-util/fixture.js';
import { launchTsserver, normalizeDefinitions } from './test-util/tsserver.js';
import { launchTsserver } from './test-util/tsserver.js';

const tsserver = launchTsserver();

test('returns no Go to Definition results when cmkOptions.enabled is false', async () => {
const { iff, getLoc } = await setupFixture({
const { iff, getFileLocation } = await setupFixture({
'tsconfig.json': `{ "cmkOptions": { "enabled": false } }`,
'index.ts': dedent`
import styles from './a.module.css';
Expand All @@ -16,10 +16,7 @@ test('returns no Go to Definition results when cmkOptions.enabled is false', asy
});
await tsserver.sendUpdateOpen({ openFiles: [{ file: iff.paths['index.ts'] }] });

const res = await tsserver.sendDefinitionAndBoundSpan({
file: iff.paths['index.ts'],
...getLoc('index.ts', 'a_1'),
});
const definitions = await tsserver.sendDefinitionAndBoundSpan(getFileLocation('index.ts', 'a_1'));

expect(normalizeDefinitions(res.body?.definitions ?? [])).toStrictEqual([]);
expect(definitions).toStrictEqual([]);
});
15 changes: 10 additions & 5 deletions packages/ts-plugin/e2e-test/file-events.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const tsserver = launchTsserver();
describe.each([{ namedExports: false }, { namedExports: true }])('namedExports: $namedExports', ({ namedExports }) => {
describe('when adding a CSS module', () => {
test("updates the importer's diagnostic when a CSS module is added", async () => {
const { iff, getRange } = await setupFixture({
const { iff, getFileSpan } = await setupFixture({
'tsconfig.json': buildTSConfigJSON({ cmkOptions: { namedExports } }),
'index.ts': dedent`
${buildStylesImport('./a.module.css', { namedExports })}
Expand All @@ -19,12 +19,14 @@ describe.each([{ namedExports: false }, { namedExports: true }])('namedExports:
await tsserver.sendUpdateOpen({ openFiles: [{ file: iff.paths['index.ts'] }] });

const before = await tsserver.sendSemanticDiagnosticsSync({ file: iff.paths['index.ts'] });
const { start, end } = getFileSpan('index.ts', "'./a.module.css'");
expect(before.body).toStrictEqual([
{
category: 'error',
code: 2307,
text: "Cannot find module './a.module.css' or its corresponding type declarations.",
...getRange('index.ts', "'./a.module.css'"),
start,
end,
},
]);

Expand All @@ -40,15 +42,16 @@ describe.each([{ namedExports: false }, { namedExports: true }])('namedExports:
category: 'error',
code: 2307,
text: "Cannot find module './a.module.css' or its corresponding type declarations.",
...getRange('index.ts', "'./a.module.css'"),
start,
end,
},
]);
});
});

describe('when updating a CSS module', () => {
test("updates the importer's diagnostic when a CSS module is modified", async () => {
const { iff, getRange } = await setupFixture({
const { iff, getFileSpan } = await setupFixture({
'tsconfig.json': buildTSConfigJSON({ cmkOptions: { namedExports } }),
'index.ts': dedent`
${buildStylesImport('./a.module.css', { namedExports })}
Expand All @@ -59,11 +62,13 @@ describe.each([{ namedExports: false }, { namedExports: true }])('namedExports:
await tsserver.sendUpdateOpen({ openFiles: [{ file: iff.paths['index.ts'] }] });

const before = await tsserver.sendSemanticDiagnosticsSync({ file: iff.paths['index.ts'] });
const { start, end } = getFileSpan('index.ts', 'a_1');
expect(before.body).toStrictEqual([
{
category: 'error',
code: 2339,
...getRange('index.ts', 'a_1'),
start,
end,
text: expect.any(String),
},
]);
Expand Down
Loading
Loading