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

CSFFile: Fix function exports #16829

Merged
merged 2 commits into from Nov 30, 2021
Merged

CSFFile: Fix function exports #16829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2493e2
CSFFile: Fix function exports
shilman Nov 29, 2021
4a1c8cc
Ignore function exports in csf-2-to-3 codemod
shilman Nov 29, 2021
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
59 changes: 32 additions & 27 deletions lib/codemod/src/transforms/csf-2-to-3.ts
View file
Open in desktop
Expand Up @@ -104,36 +104,41 @@ function transform({ source }: { source: string }, api: any, options: { parser?:
return t.objectProperty(t.identifier(_rename(annotation)), val as t.Expression);
});

const { init, id } = decl;
// only replace arrow function expressions && template
// ignore no-arg stories without annotations
const template = getTemplateBindVariable(init);
if ((!t.isArrowFunctionExpression(init) && !template) || isSimpleCSFStory(init, annotations)) {
return;
}
if (t.isVariableDeclarator(decl)) {
const { init, id } = decl;
// only replace arrow function expressions && template
// ignore no-arg stories without annotations
const template = getTemplateBindVariable(init);
if (
(!t.isArrowFunctionExpression(init) && !template) ||
isSimpleCSFStory(init, annotations)
) {
return;
}

// Remove the render function when we can hoist the template
// const Template = (args) => <Cat {...args} />;
// export const A = Template.bind({});
let storyFn = template && csf._templates[template];
if (!storyFn) storyFn = init;

const keyId = t.identifier(key);
// @ts-ignore
const { typeAnnotation } = id;
if (typeAnnotation) {
keyId.typeAnnotation = typeAnnotation;
}
// Remove the render function when we can hoist the template
// const Template = (args) => <Cat {...args} />;
// export const A = Template.bind({});
let storyFn = template && csf._templates[template];
if (!storyFn) storyFn = init;

const keyId = t.identifier(key);
// @ts-ignore
const { typeAnnotation } = id;
if (typeAnnotation) {
keyId.typeAnnotation = typeAnnotation;
}

const renderAnnotation = isReactGlobalRenderFn(csf, storyFn)
? []
: [t.objectProperty(t.identifier('render'), storyFn)];
const renderAnnotation = isReactGlobalRenderFn(csf, storyFn)
? []
: [t.objectProperty(t.identifier('render'), storyFn)];

objectExports[key] = t.exportNamedDeclaration(
t.variableDeclaration('const', [
t.variableDeclarator(keyId, t.objectExpression([...renderAnnotation, ...annotations])),
])
);
objectExports[key] = t.exportNamedDeclaration(
t.variableDeclaration('const', [
t.variableDeclarator(keyId, t.objectExpression([...renderAnnotation, ...annotations])),
])
);
}
});

const updatedBody = csf._ast.program.body.reduce((acc, stmt) => {
Expand Down
20 changes: 20 additions & 0 deletions lib/csf-tools/src/CsfFile.test.ts
View file
Open in desktop
Expand Up @@ -405,6 +405,26 @@ describe('CsfFile', () => {
)
).toThrow('CSF: unexpected storiesOf call');
});

it('function exports', () => {
expect(
parse(
dedent`
export default { title: 'foo/bar' };
export function A() {}
export function B() {}
`
)
).toMatchInlineSnapshot(`
meta:
title: foo/bar
stories:
- id: foo-bar--a
name: A
- id: foo-bar--b
name: B
`);
});
});

// NOTE: this does not have a public API, but we can still test it
Expand Down
24 changes: 17 additions & 7 deletions lib/csf-tools/src/CsfFile.ts
View file
Open in desktop
Expand Up @@ -70,7 +70,7 @@ const formatLocation = (node: t.Node, fileName?: string) => {
return `${fileName || ''} (line ${line}, col ${column})`.trim();
};

const isArgsStory = (init: t.Expression, parent: t.Node, csf: CsfFile) => {
const isArgsStory = (init: t.Node, parent: t.Node, csf: CsfFile) => {
let storyFn: t.Node = init;
// export const Foo = Bar.bind({})
if (t.isCallExpression(init)) {
Expand Down Expand Up @@ -98,6 +98,9 @@ const isArgsStory = (init: t.Expression, parent: t.Node, csf: CsfFile) => {
if (t.isArrowFunctionExpression(storyFn)) {
return storyFn.params.length > 0;
}
if (t.isFunctionDeclaration(storyFn)) {
return storyFn.params.length > 0;
}
return false;
};

Expand Down Expand Up @@ -149,7 +152,7 @@ export class CsfFile {

_metaAnnotations: Record<string, t.Node> = {};

_storyExports: Record<string, t.VariableDeclarator> = {};
_storyExports: Record<string, t.VariableDeclarator | t.FunctionDeclaration> = {};

_storyAnnotations: Record<string, Record<string, t.Node>> = {};

Expand Down Expand Up @@ -231,12 +234,18 @@ export class CsfFile {
},
ExportNamedDeclaration: {
enter({ node, parent }) {
let declarations;
if (t.isVariableDeclaration(node.declaration)) {
declarations = node.declaration.declarations.filter((d) => t.isVariableDeclarator(d));
} else if (t.isFunctionDeclaration(node.declaration)) {
declarations = [node.declaration];
}
if (declarations) {
// export const X = ...;
node.declaration.declarations.forEach((decl) => {
if (t.isVariableDeclarator(decl) && t.isIdentifier(decl.id)) {
declarations.forEach((decl: t.VariableDeclarator | t.FunctionDeclaration) => {
if (t.isIdentifier(decl.id)) {
const { name: exportName } = decl.id;
if (exportName === '__namedExportsOrder') {
if (exportName === '__namedExportsOrder' && t.isVariableDeclarator(decl)) {
self._namedExportsOrder = parseExportsOrder(decl.init);
return;
}
Expand All @@ -250,7 +259,7 @@ export class CsfFile {
self._storyAnnotations[exportName] = {};
}
let parameters;
if (t.isObjectExpression(decl.init)) {
if (t.isVariableDeclarator(decl) && t.isObjectExpression(decl.init)) {
let __isArgsStory = true; // assume default render is an args story
// CSF3 object export
decl.init.properties.forEach((p: t.ObjectProperty) => {
Expand All @@ -265,10 +274,11 @@ export class CsfFile {
});
parameters = { __isArgsStory };
} else {
const fn = t.isVariableDeclarator(decl) ? decl.init : decl;
parameters = {
// __id: toId(self._meta.title, name),
// FIXME: Template.bind({});
__isArgsStory: isArgsStory(decl.init, parent, self),
__isArgsStory: isArgsStory(fn, parent, self),
};
}
self._stories[exportName] = {
Expand Down