Merge pull request #30258 from storybookjs/shilman/add-a11y-test-caveat

CLI: Update a11y-test comment with experimental caveat
storybookjs · Jan 14, 2025 · af73cba · af73cba
2 parents 426586d + 924aad1
commit af73cba
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/code/lib/cli-storybook/src/automigrate/fixes/addon-a11y-addon-test.test.ts b/code/lib/cli-storybook/src/automigrate/fixes/addon-a11y-addon-test.test.ts
@@ -679,7 +679,8 @@ describe('addonA11yAddonTest', () => {
           },
 
           // The \`a11y-test\` tag controls whether accessibility tests are run as part of a standalone Vitest test run
-          // For more information please visit: https://storybook.js.org/docs/writing-tests/accessibility-testing#configure-accessibility-tests-with-the-test-addon
+          // The tag and its behavior are experimental and subject to change.
+          // For more information please see: https://storybook.js.org/docs/writing-tests/accessibility-testing#configure-accessibility-tests-with-the-test-addon
           tags: [/*'a11y-test'*/]
         };
 
@@ -740,7 +741,8 @@ describe('addonA11yAddonTest', () => {
 
         const preview: Preview = {
           // The \`a11y-test\` tag controls whether accessibility tests are run as part of a standalone Vitest test run
-          // For more information please visit: https://storybook.js.org/docs/writing-tests/accessibility-testing#configure-accessibility-tests-with-the-test-addon
+          // The tag and its behavior are experimental and subject to change.
+          // For more information please see: https://storybook.js.org/docs/writing-tests/accessibility-testing#configure-accessibility-tests-with-the-test-addon
           tags: ["existingTag"/*, "a11y-test"*/],
           parameters: {
             controls: {
@@ -824,7 +826,8 @@ describe('addonA11yAddonTest', () => {
           },
 
           // The \`a11y-test\` tag controls whether accessibility tests are run as part of a standalone Vitest test run
-          // For more information please visit: https://storybook.js.org/docs/writing-tests/accessibility-testing#configure-accessibility-tests-with-the-test-addon
+          // The tag and its behavior are experimental and subject to change.
+          // For more information please see: https://storybook.js.org/docs/writing-tests/accessibility-testing#configure-accessibility-tests-with-the-test-addon
           tags: [/*"a11y-test"*/]
         };"
       `);
@@ -850,7 +853,8 @@ describe('addonA11yAddonTest', () => {
       expect(transformed).toMatchInlineSnapshot(`
         "export default {
           // The \`a11y-test\` tag controls whether accessibility tests are run as part of a standalone Vitest test run
-          // For more information please visit: https://storybook.js.org/docs/writing-tests/accessibility-testing#configure-accessibility-tests-with-the-test-addon
+          // The tag and its behavior are experimental and subject to change.
+          // For more information please see: https://storybook.js.org/docs/writing-tests/accessibility-testing#configure-accessibility-tests-with-the-test-addon
           tags: ["existingTag"/*, "a11y-test"*/],
           parameters: {
             controls: {

diff --git a/code/lib/cli-storybook/src/automigrate/fixes/addon-a11y-addon-test.ts b/code/lib/cli-storybook/src/automigrate/fixes/addon-a11y-addon-test.ts
@@ -318,7 +318,7 @@ export async function transformPreviewFile(source: string, filePath: string) {
   const indentation = lines[tagsLineIndex]?.match(/^\s*/)?.[0];
 
   // Add the comment with the same indentation level
-  const comment = `${indentation}// The \`a11y-test\` tag controls whether accessibility tests are run as part of a standalone Vitest test run\n${indentation}// For more information please visit: https://storybook.js.org/docs/writing-tests/accessibility-testing#configure-accessibility-tests-with-the-test-addon`;
+  const comment = `${indentation}// The \`a11y-test\` tag controls whether accessibility tests are run as part of a standalone Vitest test run\n${indentation}// The tag and its behavior are experimental and subject to change.\n${indentation}// For more information please see: https://storybook.js.org/docs/writing-tests/accessibility-testing#configure-accessibility-tests-with-the-test-addon`;
   lines.splice(tagsLineIndex, 0, comment);
 
   return formatFileContent(filePath, lines.join('\n'));