Skip to content
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

Add tags to story and index #19625

Merged
merged 17 commits into from
Oct 27, 2022
+515 −42
Merged

Add tags to story and index #19625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
15a68c5
Handle tags in prepareStory and add to index generated from facade
tmeasday Oct 26, 2022
2911f55
Add tag story
tmeasday Oct 26, 2022
0385965
Add tags to manager type
tmeasday Oct 26, 2022
3a1a90a
Add `story` | `docs` tags to all entries
tmeasday Oct 26, 2022
b373ed9
Ensure story tags *override* component tags
tmeasday Oct 26, 2022
5c3ad2d
Merge remote-tracking branch 'origin/next' into tom/sb-829-add-story-…
tmeasday Oct 26, 2022
de302a7
Generate tags in v7 store
tmeasday Oct 26, 2022
ad7b151
Fix tags stories
tmeasday Oct 26, 2022
02a0cb3
Remove unused import
tmeasday Oct 26, 2022
e88e270
Fix StoryRender typing issue
tmeasday Oct 26, 2022
84790b9
Don't import from csf package
tmeasday Oct 26, 2022
fcb52e1
Update snapshots
tmeasday Oct 26, 2022
c3c059a
Merge remote-tracking branch 'origin/next' into tom/sb-829-add-story-…
tmeasday Oct 26, 2022
00d7cdf
Fix decorators test and export types
tmeasday Oct 26, 2022
40c6062
Merge remote-tracking branch 'origin/next' into tom/sb-829-add-story-…
tmeasday Oct 27, 2022
baafde3
Remove incorrect import from renderers type tests
tmeasday Oct 27, 2022
824c682
Replace use of CSF in template stories
tmeasday Oct 27, 2022
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
2 changes: 1 addition & 1 deletion code/addons/controls/template/stories/basics.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import globalThis from 'global';
import { PartialStoryFn, StoryContext } from '@storybook/csf';
import { PartialStoryFn, StoryContext } from '@storybook/types';

export default {
component: null,
Expand Down
2 changes: 1 addition & 1 deletion code/addons/controls/template/stories/conditional.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import globalThis from 'global';
import { PartialStoryFn, StoryContext } from '@storybook/csf';
import { PartialStoryFn, StoryContext } from '@storybook/types';

export default {
component: null,
Expand Down
2 changes: 1 addition & 1 deletion code/addons/controls/template/stories/disable.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import globalThis from 'global';
import { PartialStoryFn, StoryContext } from '@storybook/csf';
import { PartialStoryFn, StoryContext } from '@storybook/types';

export default {
component: null,
Expand Down
2 changes: 1 addition & 1 deletion code/addons/controls/template/stories/filters.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import globalThis from 'global';
import { PartialStoryFn, StoryContext } from '@storybook/csf';
import { PartialStoryFn, StoryContext } from '@storybook/types';

export default {
component: null,
Expand Down
2 changes: 1 addition & 1 deletion code/addons/controls/template/stories/issues.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import globalThis from 'global';
import { PartialStoryFn, StoryContext } from '@storybook/csf';
import { PartialStoryFn, StoryContext } from '@storybook/types';

export default {
component: null,
Expand Down
2 changes: 1 addition & 1 deletion code/addons/controls/template/stories/matchers.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import globalThis from 'global';
import { PartialStoryFn, StoryContext } from '@storybook/csf';
import { PartialStoryFn, StoryContext } from '@storybook/types';

export default {
component: null,
Expand Down
2 changes: 1 addition & 1 deletion code/addons/controls/template/stories/sorting.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import globalThis from 'global';
import { PartialStoryFn, StoryContext } from '@storybook/csf';
import { PartialStoryFn, StoryContext } from '@storybook/types';

export default {
component: null,
Expand Down
2 changes: 1 addition & 1 deletion code/addons/toolbars/template/stories/globals.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import globalThis from 'global';
import { PartialStoryFn, StoryContext } from '@storybook/csf';
import { PartialStoryFn, StoryContext } from '@storybook/types';

const greetingForLocale = (locale: string) => {
switch (locale) {
Expand Down
1 change: 1 addition & 0 deletions code/frameworks/angular/src/client/decorators.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const defaultContext: Addon_StoryContext = {
id: 'unspecified',
name: 'unspecified',
story: 'unspecified',
tags: [],
parameters: {},
initialArgs: {},
args: {},
Expand Down
7 changes: 4 additions & 3 deletions code/frameworks/angular/src/client/docs/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import { SourceType, enhanceArgTypes } from '@storybook/docs-tools';
import type { Parameters, DecoratorFunction, ArgTypesEnhancer } from '@storybook/types';
import { extractArgTypes, extractComponentDescription } from './compodoc';
import { sourceDecorator } from './sourceDecorator';

export const parameters = {
export const parameters: Parameters = {
docs: {
// probably set this to true by default once it's battle-tested
inlineStories: false,
Expand All @@ -15,6 +16,6 @@ export const parameters = {
},
};

export const decorators = [sourceDecorator];
export const decorators: DecoratorFunction[] = [sourceDecorator];

export const argTypesEnhancers = [enhanceArgTypes];
export const argTypesEnhancers: ArgTypesEnhancer[] = [enhanceArgTypes];
4 changes: 3 additions & 1 deletion code/lib/client-api/src/StoryStoreFacade.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,7 @@ export class StoryStoreFacade<TFramework extends AnyFramework> {
title,
importPath: fileName,
componentId,
tags: [...(storyExport.tags || defaultExport.tags || []), 'story'],
};
}
});
Expand All @@ -223,8 +224,9 @@ export class StoryStoreFacade<TFramework extends AnyFramework> {
title,
name,
importPath: fileName,
storiesImports: [],
componentId,
tags: [...(defaultExport.tags || []), 'docs'],
storiesImports: [],
};
}
}
Expand Down
94 changes: 92 additions & 2 deletions code/lib/core-client/src/preview/start.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,9 @@ describe('start', () => {
"fileName": "file1",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component A",
"type": "story",
},
Expand All @@ -140,6 +143,9 @@ describe('start', () => {
"fileName": "file1",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component A",
"type": "story",
},
Expand All @@ -157,6 +163,9 @@ describe('start', () => {
"fileName": "file2",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component B",
"type": "story",
},
Expand Down Expand Up @@ -402,6 +411,9 @@ describe('start', () => {
"fileName": "file1",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component A",
"type": "story",
},
Expand All @@ -419,6 +431,9 @@ describe('start', () => {
"fileName": "file1",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component A",
"type": "story",
},
Expand Down Expand Up @@ -467,6 +482,9 @@ describe('start', () => {
"fileName": "file1",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component A",
"type": "story",
},
Expand All @@ -484,6 +502,9 @@ describe('start', () => {
"fileName": "file2",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component B",
"type": "story",
},
Expand Down Expand Up @@ -513,6 +534,9 @@ describe('start', () => {
"fileName": "file1",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component A",
"type": "story",
},
Expand All @@ -526,8 +550,12 @@ describe('start', () => {
const componentCExports = {
default: {
title: 'Component C',
tags: ['component-tag'],
},
StoryOne: {
render: jest.fn(),
tags: ['story-tag'],
},
StoryOne: jest.fn(),
StoryTwo: jest.fn(),
};

Expand Down Expand Up @@ -556,6 +584,10 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"story-tag",
"story",
],
"title": "Component C",
"type": "story",
},
Expand All @@ -572,6 +604,10 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"component-tag",
"story",
],
"title": "Component C",
"type": "story",
},
Expand Down Expand Up @@ -611,7 +647,7 @@ describe('start', () => {

await waitForRender();
expect(mockChannel.emit).toHaveBeenCalledWith(STORY_RENDERED, 'component-c--story-one');
expect(componentCExports.StoryOne).toHaveBeenCalled();
expect(componentCExports.StoryOne.render).toHaveBeenCalled();
expect(module.hot.accept).toHaveBeenCalled();
expect(disposeCallback).toBeDefined();

Expand Down Expand Up @@ -670,6 +706,10 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"story-tag",
"story",
],
"title": "Component C",
"type": "story",
},
Expand All @@ -686,6 +726,10 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"component-tag",
"story",
],
"title": "Component C",
"type": "story",
},
Expand All @@ -702,6 +746,10 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"component-tag",
"story",
],
"title": "Component C",
"type": "story",
},
Expand Down Expand Up @@ -750,6 +798,10 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"story-tag",
"story",
],
"title": "Component C",
"type": "story",
},
Expand All @@ -766,6 +818,10 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"component-tag",
"story",
],
"title": "Component C",
"type": "story",
},
Expand All @@ -782,6 +838,9 @@ describe('start', () => {
"fileName": "exports-map-1",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component D",
"type": "story",
},
Expand Down Expand Up @@ -813,6 +872,10 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"story-tag",
"story",
],
"title": "Component C",
"type": "story",
},
Expand All @@ -829,6 +892,10 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"component-tag",
"story",
],
"title": "Component C",
"type": "story",
},
Expand Down Expand Up @@ -900,6 +967,9 @@ describe('start', () => {
"name": undefined,
"standalone": false,
"storiesImports": Array [],
"tags": Array [
"docs",
],
"title": "Introduction",
"type": "docs",
},
Expand Down Expand Up @@ -951,6 +1021,9 @@ describe('start', () => {
"fileName": "file1",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component A",
"type": "story",
},
Expand All @@ -968,6 +1041,9 @@ describe('start', () => {
"fileName": "file1",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component A",
"type": "story",
},
Expand All @@ -985,6 +1061,9 @@ describe('start', () => {
"fileName": "file2",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "Component B",
"type": "story",
},
Expand All @@ -1001,6 +1080,10 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"story-tag",
"story",
],
"title": "Component C",
"type": "story",
},
Expand All @@ -1017,6 +1100,10 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"component-tag",
"story",
],
"title": "Component C",
"type": "story",
},
Expand Down Expand Up @@ -1076,6 +1163,9 @@ describe('start', () => {
"fileName": "exports-map-0",
"framework": "test",
},
"tags": Array [
"story",
],
"title": "auto-title",
"type": "story",
},
Expand Down
Loading