Replace docs tag by autodocs

storybookjs · May 6, 2024 · 149dd06 · 149dd06
1 parent d89ff2e
commit 149dd06
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 14 deletions.
diff --git a/code/addons/docs/src/preview.ts b/code/addons/docs/src/preview.ts
@@ -22,7 +22,7 @@ export const parameters: any = {
       filter: (story: PreparedStory) => {
         const tags = story.tags || [];
         return (
-          tags.includes('docs') &&
+          tags.includes('autodocs') &&
           tags.filter((tag) => excludeTags[tag]).length === 0 &&
           !story.parameters.docs?.disable
         );

diff --git a/code/lib/core-server/src/utils/StoryIndexGenerator.ts b/code/lib/core-server/src/utils/StoryIndexGenerator.ts
@@ -666,7 +666,7 @@ export class StoryIndexGenerator {
 
   getProjectTags(previewCode: string) {
     const projectAnnotations = loadConfig(previewCode).parse();
-    const defaultTags = ['dev', 'docs', 'test'];
+    const defaultTags = ['dev', 'test'];
     const extraTags = this.options.docs.autodocs === true ? [AUTODOCS_TAG] : [];
     const projectTags = projectAnnotations.getFieldValue(['tags']) ?? [];
     return [...defaultTags, ...projectTags, ...extraTags];

diff --git a/code/lib/preview-api/src/modules/store/csf/prepareStory.test.ts b/code/lib/preview-api/src/modules/store/csf/prepareStory.test.ts
@@ -44,15 +44,7 @@ describe('prepareStory', () => {
         { render }
       );
 
-      expect(tags).toEqual([
-        'dev',
-        'docs',
-        'test',
-        'component-1',
-        'component-2',
-        'story-1',
-        'story-2',
-      ]);
+      expect(tags).toEqual(['dev', 'test', 'component-1', 'component-2', 'story-1', 'story-2']);
     });
 
     it('component tags work if story are unset', () => {
@@ -66,13 +58,13 @@ describe('prepareStory', () => {
         { render }
       );
 
-      expect(tags).toEqual(['dev', 'docs', 'test', 'component-1', 'component-2']);
+      expect(tags).toEqual(['dev', 'test', 'component-1', 'component-2']);
     });
 
     it('sets a value even if annotations do not have tags', () => {
       const { tags } = prepareStory({ id, name, moduleExport }, { id, title }, { render });
 
-      expect(tags).toEqual(['dev', 'docs', 'test']);
+      expect(tags).toEqual(['dev', 'test']);
     });
   });
 

diff --git a/code/lib/preview-api/src/modules/store/csf/prepareStory.ts b/code/lib/preview-api/src/modules/store/csf/prepareStory.ts
@@ -143,7 +143,7 @@ function preparePartialAnnotations<TRenderer extends Renderer>(
   // anything at render time. The assumption is that as we don't load all the stories at once, this
   // will have a limited cost. If this proves misguided, we can refactor it.
 
-  const defaultTags = ['dev', 'docs', 'test'];
+  const defaultTags = ['dev', 'test'];
   if (typeof globalThis.DOCS_OPTIONS?.autodocs !== 'undefined') {
     once.warn(dedent`
       The \`docs.autodocs\` setting in '.storybook/main.js' is deprecated. Use \`tags: ['autodocs']\` in \`.storybook/preview.js\` instead.