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

Jump to bottom

Story Index: Fix storySort parsing for parameters variable #21481

Merged
merged 1 commit into from Mar 8, 2023
Merged

Story Index: Fix storySort parsing for parameters variable #21481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
68 changes: 53 additions & 15 deletions code/lib/csf-tools/src/getStorySortParameter.test.ts
View file
Open in desktop
Expand Up @@ -154,21 +154,11 @@ describe('getStorySortParameter', () => {

describe('unsupported', () => {
it('invalid parameters', () => {
expect(() =>
expect(
getStorySortParameter(dedent`
export const parameters = [];
`)
).toThrowErrorMatchingInlineSnapshot(`
"Unexpected 'parameters'. Parameter 'options.storySort' should be defined inline e.g.:

export default {
parameters = {
options: {
storySort: <array | object | function>
},
},
};"
`);
).toBeUndefined();
});

it('parameters var', () => {
Expand Down Expand Up @@ -206,7 +196,7 @@ describe('getStorySortParameter', () => {
"Unexpected 'options'. Parameter 'options.storySort' should be defined inline e.g.:

export default {
parameters = {
parameters: {
options: {
storySort: <array | object | function>
},
Expand All @@ -233,7 +223,7 @@ describe('getStorySortParameter', () => {
"Unexpected 'storySort'. Parameter 'options.storySort' should be defined inline e.g.:

export default {
parameters = {
parameters: {
options: {
storySort: <array | object | function>
},
Expand All @@ -260,7 +250,7 @@ describe('getStorySortParameter', () => {
"Unexpected 'order'. Parameter 'options.storySort' should be defined inline e.g.:

export default {
parameters = {
parameters: {
options: {
storySort: <array | object | function>
},
Expand Down Expand Up @@ -315,6 +305,54 @@ describe('getStorySortParameter', () => {
).toBeUndefined();
});

it('variable parameters without storysort', () => {
expect(
getStorySortParameter(dedent`
const parameters = {
actions: { argTypesRegex: '^on[A-Z].*' },
controls: {
matchers: {
color: /(background|color)$/i,
date: /Date$/,
},
},
};

const preview = {
parameters,
};
export default preview;
`)
).toBeUndefined();
});

it('variable parameters with storysort', () => {
expect(
getStorySortParameter(dedent`
const parameters = {
options: {
storySort: [
"Intro",
"*",
"WIP",
]
}
};

const preview = {
parameters,
};
export default preview;
`)
).toMatchInlineSnapshot(`
Array [
"Intro",
"*",
"WIP",
]
`);
});

it('inline typescript', () => {
expect(
getStorySortParameter(dedent`
Expand Down
13 changes: 8 additions & 5 deletions code/lib/csf-tools/src/getStorySortParameter.ts
View file
Open in desktop
Expand Up @@ -48,7 +48,7 @@ const unsupported = (unexpectedVar: string, isError: boolean) => {
Unexpected '${unexpectedVar}'. Parameter 'options.storySort' should be defined inline e.g.:

export default {
parameters = {
parameters: {
options: {
storySort: <array | object | function>
},
Expand Down Expand Up @@ -76,15 +76,18 @@ const parseParameters = (params: t.Expression): t.Expression | undefined => {
unsupported('options', true);
}
} else {
unsupported('parameters', true);
console.log({ paramsObject });
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shilman is this log intentional?

}
return undefined;
};

const parseDefault = (defaultExpr: t.Expression): t.Expression | undefined => {
const parseDefault = (defaultExpr: t.Expression, program: t.Program): t.Expression | undefined => {
const defaultObj = stripTSModifiers(defaultExpr);
if (t.isObjectExpression(defaultObj)) {
const params = getValue(defaultObj, 'parameters');
let params = getValue(defaultObj, 'parameters');
if (t.isIdentifier(params)) {
params = findVarInitialization(params.name, program);
}
if (params) {
return parseParameters(params);
}
Expand Down Expand Up @@ -127,7 +130,7 @@ export const getStorySortParameter = (previewCode: string) => {
}
defaultObj = stripTSModifiers(defaultObj);
if (t.isObjectExpression(defaultObj)) {
storySort = parseDefault(defaultObj);
storySort = parseDefault(defaultObj, ast.program);
} else {
unsupported('default', false);
}
Expand Down