refactor(vscode): refresh e2e test fixtures and test names (#406)

mizdra · claude · web-flow · commit 4511b0f10bee · 2026-05-27T01:10:59.000+09:00
* refactor(vscode): replace examples-based e2e fixtures with dedicated fixtures

The examples directory is intended only as user-facing examples, not as
test fixtures. Move vscode e2e test workspaces to a package-local
fixtures directory containing only the files needed by each test.

Co-Authored-By: Claude Opus 4.7 &lt;noreply@anthropic.com&gt;

* test(vscode): rename e2e cases to describe expected behavior

Replace vague test names like "works in other projects" and "affects
corresponding .tsx file" with names that state the behavior under test.
Group cases by the VSCode feature they exercise (Rename Symbol /
Document Link) so each test's role in covering the "Request Forwarding
to tsserver" technique is explicit.

Co-Authored-By: Claude Opus 4.7 &lt;noreply@anthropic.com&gt;

---------

Co-authored-by: Claude Opus 4.7 &lt;noreply@anthropic.com&gt;
diff --git a/.vscode-test.js b/.vscode-test.js
@@ -17,18 +17,18 @@ export default defineConfig([
     ...baseConfig,
     label: 'open-css-file',
     files: 'packages/vscode/vscode-test/open-css-file.test.ts',
-    workspaceFolder: 'examples/1-basic',
+    workspaceFolder: 'packages/vscode/vscode-test/fixtures/basic',
   },
   {
     ...baseConfig,
     label: 'open-ts-file',
     files: 'packages/vscode/vscode-test/open-ts-file.test.ts',
-    workspaceFolder: 'examples/1-basic',
+    workspaceFolder: 'packages/vscode/vscode-test/fixtures/basic',
   },
   {
     ...baseConfig,
     label: 'request-forwarding-to-tsserver',
     files: 'packages/vscode/vscode-test/request-forwarding-to-tsserver.test.ts',
-    workspaceFolder: 'examples/4-multiple-tsconfig',
+    workspaceFolder: 'packages/vscode/vscode-test/fixtures/multiple-tsconfig',
   },
 ]);
diff --git a/packages/vscode/vscode-test/fixtures/basic/src/a.module.css b/packages/vscode/vscode-test/fixtures/basic/src/a.module.css
@@ -0,0 +1 @@
+.a_1 {}
diff --git a/packages/vscode/vscode-test/fixtures/basic/src/a.tsx b/packages/vscode/vscode-test/fixtures/basic/src/a.tsx
@@ -0,0 +1,3 @@
+import styles from './a.module.css';
+
+styles.a_1;
diff --git a/packages/vscode/vscode-test/fixtures/basic/tsconfig.json b/packages/vscode/vscode-test/fixtures/basic/tsconfig.json
@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "es2015",
+    "lib": ["ES2015"],
+    "module": "Preserve",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "types": []
+  },
+  "cmkOptions": {
+    "enabled": true
+  }
+}
diff --git a/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-1/a.module.css b/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-1/a.module.css
@@ -0,0 +1,3 @@
+.a_1 { color: red; }
+
+@import '@/src/dir-1/b.module.css';
diff --git a/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-1/a.tsx b/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-1/a.tsx
@@ -0,0 +1,2 @@
+import styles from './a.module.css';
+styles.a_1;
diff --git a/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-1/b.module.css b/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-1/b.module.css
@@ -0,0 +1 @@
+.b_1 {}
diff --git a/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-1/c.module.css b/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-1/c.module.css
@@ -0,0 +1,3 @@
+.c_1 { background: url('https://test.example/image.png'); }
+
+@import '@/src/dir-1/b.module.css';
diff --git a/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-2/a.module.css b/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-2/a.module.css
@@ -0,0 +1,3 @@
+.a_1 { color: red; }
+
+@import '@/src/dir-2/b.module.css';
diff --git a/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-2/a.tsx b/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-2/a.tsx
@@ -0,0 +1,2 @@
+import styles from './a.module.css';
+styles.a_1;
diff --git a/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-2/b.module.css b/packages/vscode/vscode-test/fixtures/multiple-tsconfig/src/dir-2/b.module.css
@@ -0,0 +1 @@
+.b_1 {}
diff --git a/packages/vscode/vscode-test/fixtures/multiple-tsconfig/tsconfig.dir-1.json b/packages/vscode/vscode-test/fixtures/multiple-tsconfig/tsconfig.dir-1.json
@@ -0,0 +1,18 @@
+{
+  "include": ["src/dir-1"],
+  "compilerOptions": {
+    "target": "es2015",
+    "lib": ["ES2015"],
+    "module": "Preserve",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "types": [],
+    "paths": { "@/*": ["./*"] }
+  },
+  "cmkOptions": {
+    "enabled": true
+  }
+}
diff --git a/packages/vscode/vscode-test/fixtures/multiple-tsconfig/tsconfig.dir-2.json b/packages/vscode/vscode-test/fixtures/multiple-tsconfig/tsconfig.dir-2.json
@@ -0,0 +1,18 @@
+{
+  "include": ["src/dir-2"],
+  "compilerOptions": {
+    "target": "es2015",
+    "lib": ["ES2015"],
+    "module": "Preserve",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "types": [],
+    "paths": { "@/*": ["./*"] }
+  },
+  "cmkOptions": {
+    "enabled": true
+  }
+}
diff --git a/packages/vscode/vscode-test/fixtures/multiple-tsconfig/tsconfig.json b/packages/vscode/vscode-test/fixtures/multiple-tsconfig/tsconfig.json
@@ -0,0 +1,4 @@
+{
+  "files": [],
+  "references": [{ "path": "./tsconfig.dir-1.json" }, { "path": "./tsconfig.dir-2.json" }]
+}
diff --git a/packages/vscode/vscode-test/request-forwarding-to-tsserver.test.ts b/packages/vscode/vscode-test/request-forwarding-to-tsserver.test.ts
@@ -6,7 +6,7 @@
  * - https://github.com/mizdra/css-modules-kit/issues/121
  * - https://github.com/mizdra/css-modules-kit/issues/206
  *
- * The workspace used is `examples/4-multiple-tsconfig` to ensure that these issues do not occur in a workspace
+ * The workspace used is the `multiple-tsconfig` fixture to ensure that these issues do not occur in a workspace
  * with multiple tsconfig.json files.
  *
  */
@@ -32,8 +32,8 @@ before(async () => {
   await cmkExtension.activate();
 });
 
-describe('Renaming class in .module.css', () => {
-  it('affects corresponding .tsx file', async () => {
+describe('Rename Symbol in a CSS module', () => {
+  it('renames a class across the CSS module and the importing TS file', async () => {
     const aModuleCSSDocument = await vscode.workspace.openTextDocument(aModuleCSS1Path);
     const aTSXDocument = await vscode.workspace.openTextDocument(aTSX1Path);
     const position = new vscode.Position(0, 1); // `a_1`
@@ -60,7 +60,7 @@ describe('Renaming class in .module.css', () => {
     assert.ok(aModuleCSSDocument.getText().includes('.a_1_renamed'));
     assert.ok(aTSXDocument.getText().includes('a_1_renamed'));
   });
-  it('works in other projects', async () => {
+  it('renames a class regardless of which tsconfig project the CSS module belongs to', async () => {
     const aModuleCSSDocument = await vscode.workspace.openTextDocument(aModuleCSS2Path);
     const aTSXDocument = await vscode.workspace.openTextDocument(aTSX2Path);
     const position = new vscode.Position(0, 1); // `a_1`
@@ -87,7 +87,7 @@ describe('Renaming class in .module.css', () => {
     assert.ok(aModuleCSSDocument.getText().includes('.a_1_renamed'));
     assert.ok(aTSXDocument.getText().includes('a_1_renamed'));
   });
-  it('can rename by standard CSS Language Server', async () => {
+  it('falls back to the standard CSS Language Server for non-class symbols (e.g. CSS properties)', async () => {
     const aModuleCSSDocument = await vscode.workspace.openTextDocument(aModuleCSS1Path);
     const position = new vscode.Position(0, 7); // `color`
 
@@ -106,8 +106,8 @@ describe('Renaming class in .module.css', () => {
   });
 });
 
-describe('Go to Definition for specifiers with import alias', () => {
-  it('resolves to the correct .module.css file', async () => {
+describe('Document Link for an import specifier in a CSS module', () => {
+  it('resolves a path-aliased import specifier to the target CSS module', async () => {
     await vscode.workspace.openTextDocument(aModuleCSS1Path);
     const links = await vscode.commands.executeCommand<vscode.DocumentLink[]>(
       'vscode.executeLinkProvider',
@@ -121,7 +121,7 @@ describe('Go to Definition for specifiers with import alias', () => {
       toObject(new vscode.Range(2, 9, 2, 33)), // `@/src/dir-1/b.module.css`
     );
   });
-  it('works in other projects', async () => {
+  it('resolves a path-aliased import specifier regardless of which tsconfig project the importer belongs to', async () => {
     await vscode.workspace.openTextDocument(aModuleCSS2Path);
     const links = await vscode.commands.executeCommand<vscode.DocumentLink[]>(
       'vscode.executeLinkProvider',
@@ -135,7 +135,7 @@ describe('Go to Definition for specifiers with import alias', () => {
       toObject(new vscode.Range(2, 9, 2, 33)), // `@/src/dir-2/b.module.css`
     );
   });
-  it('`executeLinkProvider` also returns links from standard CSS Language Server', async () => {
+  it('coexists with URL links provided by the standard CSS Language Server', async () => {
     await vscode.workspace.openTextDocument(cModuleCSS1Path);
     const links = await vscode.commands.executeCommand<vscode.DocumentLink[]>(
       'vscode.executeLinkProvider',
@@ -156,8 +156,8 @@ describe('Go to Definition for specifiers with import alias', () => {
   });
 });
 
-describe('Renaming a CSS module via import specifier', () => {
-  it('renames the file and rewrites the import while preserving the `./` prefix', async () => {
+describe('Rename Symbol on an import specifier in a CSS module', () => {
+  it('renames the imported file and updates the import path while preserving the relative prefix', async () => {
     const iff = await createFixture({
       'tsconfig.json': JSON.stringify({ cmkOptions: { enabled: true } }),
       'd.module.css': `@import './e.module.css';\n`,
diff --git a/vite.config.ts b/vite.config.ts
@@ -10,7 +10,7 @@ export default defineConfig({
   },
   lint: {
     extends: [mizdraOxlintConfig.base, mizdraOxlintConfig.typescript, mizdraOxlintConfig.node],
-    ignorePatterns: ['**/dist', 'examples', 'crates', 'target', '.vscode-test'],
+    ignorePatterns: ['examples', 'crates', 'packages/vscode/vscode-test/fixtures'],
     rules: {
       'no-restricted-globals': [
         'error',
@@ -54,6 +54,7 @@ export default defineConfig({
       'examples/*/src',
       'docs/ts-plugin-internals.md',
       'docs/ts-plugin-internals.ja.md',
+      'packages/vscode/vscode-test/fixtures',
     ],
   },
   test: {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import styles from './a.module.css';`
	`2`	`+`
	`3`	`+styles.a_1;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+.a_1 { color: red; }`
	`2`	`+`
	`3`	`+@import '@/src/dir-1/b.module.css';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+import styles from './a.module.css';`
	`2`	`+styles.a_1;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+.c_1 { background: url('https://test.example/image.png'); }`
	`2`	`+`
	`3`	`+@import '@/src/dir-1/b.module.css';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+.a_1 { color: red; }`
	`2`	`+`
	`3`	`+@import '@/src/dir-2/b.module.css';`