Merge pull request #30257 from storybookjs/valentin/remove-a11y-test-…

…tag-comment-in-preview

Addon A11y: Don't set a11y tag as comment in automigrations

code/lib/cli-storybook/src/automigrate/fixes/addon-a11y-addon-test.test.ts

@@ -1,9 +1,5 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
-import { formatFileContent } from '@storybook/core/common';
-
-import { formatConfig, loadConfig } from '@storybook/core/csf-tools';
-
 import { existsSync, readFileSync, writeFileSync } from 'fs';
 import * as jscodeshift from 'jscodeshift';
 import path from 'path';
@@ -157,12 +153,12 @@ describe('addonA11yAddonTest', () => {
         previewFile: null,
         transformedPreviewCode: null,
         transformedSetupCode: expect.any(String),
-        skipPreviewTransformation: false,
+        skipPreviewTransformation: true,
         skipVitestSetupTransformation: false,
       });
     });
 
-    it('should return previewFile and transformedPreviewCode if preview file exists', async () => {
+    it.skip('should return previewFile and transformedPreviewCode if preview file exists', async () => {
       vi.mocked(getAddonNames).mockReturnValue([
         '@storybook/addon-a11y',
         '@storybook/experimental-addon-test',
@@ -229,7 +225,7 @@ describe('addonA11yAddonTest', () => {
         previewFile: null,
         transformedPreviewCode: null,
         transformedSetupCode: null,
-        skipPreviewTransformation: false,
+        skipPreviewTransformation: true,
         skipVitestSetupTransformation: false,
       });
     });
@@ -265,7 +261,7 @@ describe('addonA11yAddonTest', () => {
         previewFile: path.join(configDir, 'preview.js'),
         transformedPreviewCode: null,
         transformedSetupCode: null,
-        skipPreviewTransformation: false,
+        skipPreviewTransformation: true,
         skipVitestSetupTransformation: false,
       });
     });
@@ -345,14 +341,7 @@ describe('addonA11yAddonTest', () => {
         },
         configDir,
       } as any);
-      expect(result).toEqual({
-        setupFile: path.join(configDir, 'vitest.setup.js'),
-        previewFile: path.join(configDir, 'preview.js'),
-        transformedPreviewCode: expect.any(String),
-        transformedSetupCode: null,
-        skipPreviewTransformation: false,
-        skipVitestSetupTransformation: true,
-      });
+      expect(result).toEqual(null);
     });
   });
 

code/lib/cli-storybook/src/automigrate/fixes/addon-a11y-addon-test.ts

@@ -90,14 +90,15 @@ export const addonA11yAddonTest: Fix<AddonA11yAddonTestOptions> = {
         .find((filePath) => existsSync(filePath)) ?? null;
 
     let skipVitestSetupTransformation = false;
-    let skipPreviewTransformation = false;
+    // TODO: Set it to false after we have decided how to deal with a11y:test tag.
+    const skipPreviewTransformation = true;
 
     if (vitestSetupFile && previewFile) {
       const vitestSetupSource = readFileSync(vitestSetupFile, 'utf8');
-      const previewSetupSource = readFileSync(previewFile, 'utf8');
+      // const previewSetupSource = readFileSync(previewFile, 'utf8');
 
       skipVitestSetupTransformation = vitestSetupSource.includes('@storybook/addon-a11y');
-      skipPreviewTransformation = previewSetupSource.includes('a11y-test');
+      // skipPreviewTransformation = previewSetupSource.includes('a11y-test');
 
       if (skipVitestSetupTransformation && skipPreviewTransformation) {
         return null;