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

Csf-plugin: Move source to docs.source.originalSource #20665

Merged
merged 2 commits into from
Jan 19, 2023
Merged

Csf-plugin: Move source to docs.source.originalSource #20665

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
d5f4ab1
Csf-plugin: Move source to docs.source.originalSource
shilman Jan 18, 2023
899c6c3
Merge branch 'tom/sb-1147-update-api-of-source-block' into shilman/up…
tmeasday Jan 19, 2023
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
168 changes: 108 additions & 60 deletions code/lib/csf-tools/src/enrichCsf.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand All @@ -64,9 +67,12 @@ describe('enrichCsf', () => {
};
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "args => <Button {...args} />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "args => <Button {...args} />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand All @@ -92,9 +98,12 @@ describe('enrichCsf', () => {
};
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "{\\n parameters: {\\n foo: 'bar'\\n }\\n}",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "{\\n parameters: {\\n foo: 'bar'\\n }\\n}",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand All @@ -116,16 +125,22 @@ describe('enrichCsf', () => {
export const B = {};
A.parameters = {
...A.parameters,
storySource: {
source: "{}",
...A.parameters?.storySource
docs: {
...A.parameters?.docs,
source: {
originalSource: "{}",
...A.parameters?.docs?.source
}
}
};
B.parameters = {
...B.parameters,
storySource: {
source: "{}",
...B.parameters?.storySource
docs: {
...B.parameters?.docs,
source: {
originalSource: "{}",
...B.parameters?.docs?.source
}
}
};
`);
Expand All @@ -150,9 +165,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand All @@ -175,9 +193,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand All @@ -200,12 +221,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
},
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
},
description: {
story: "The most basic button",
...Basic.parameters?.docs?.description
Expand Down Expand Up @@ -240,12 +261,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
},
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
},
description: {
story: "The most basic button\\n\\nIn a block!",
...Basic.parameters?.docs?.description
Expand Down Expand Up @@ -280,12 +301,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
},
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
},
description: {
story: "- A bullet list\\n - A sub-bullet\\n- A second bullet",
...Basic.parameters?.docs?.description
Expand Down Expand Up @@ -314,9 +335,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand All @@ -339,9 +363,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand Down Expand Up @@ -371,9 +398,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand Down Expand Up @@ -411,9 +441,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand Down Expand Up @@ -451,9 +484,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand Down Expand Up @@ -489,9 +525,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand Down Expand Up @@ -528,9 +567,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand Down Expand Up @@ -564,9 +606,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand Down Expand Up @@ -625,9 +670,12 @@ describe('enrichCsf', () => {
export const Basic = () => <Button />;
Basic.parameters = {
...Basic.parameters,
storySource: {
source: "() => <Button />",
...Basic.parameters?.storySource
docs: {
...Basic.parameters?.docs,
source: {
originalSource: "() => <Button />",
...Basic.parameters?.docs?.source
}
}
};
`);
Expand Down
52 changes: 26 additions & 26 deletions code/lib/csf-tools/src/enrichCsf.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,60 +16,60 @@ export const enrichCsfStory = (csf: CsfFile, key: string, options?: EnrichCsfOpt
const parameters = [];
const originalParameters = t.memberExpression(t.identifier(key), t.identifier('parameters'));
parameters.push(t.spreadElement(originalParameters));
const optionalDocs = t.optionalMemberExpression(
originalParameters,
t.identifier('docs'),
false,
true
);
const extraDocsParameters = [];

// docs: { source: { originalSource: %%source%% } },
if (source) {
const optionalStorySource = t.optionalMemberExpression(
originalParameters,
t.identifier('storySource'),
const optionalSource = t.optionalMemberExpression(
optionalDocs,
t.identifier('source'),
false,
true
);

parameters.push(
extraDocsParameters.push(
t.objectProperty(
t.identifier('storySource'),
t.identifier('source'),
t.objectExpression([
t.objectProperty(t.identifier('source'), t.stringLiteral(source)),
t.spreadElement(optionalStorySource),
t.objectProperty(t.identifier('originalSource'), t.stringLiteral(source)),
t.spreadElement(optionalSource),
])
)
);
}

// docs: { description: { story: %%description%% } },
if (description) {
const optionalDocs = t.optionalMemberExpression(
originalParameters,
t.identifier('docs'),
false,
true
);

const optionalDescription = t.optionalMemberExpression(
optionalDocs,
t.identifier('description'),
false,
true
);

parameters.push(
extraDocsParameters.push(
t.objectProperty(
t.identifier('docs'),
t.identifier('description'),
t.objectExpression([
t.spreadElement(optionalDocs),
t.objectProperty(
t.identifier('description'),
t.objectExpression([
t.objectProperty(t.identifier('story'), t.stringLiteral(description)),
t.spreadElement(optionalDescription),
])
),
t.objectProperty(t.identifier('story'), t.stringLiteral(description)),
t.spreadElement(optionalDescription),
])
)
);
}
if (parameters.length > 1) {

if (extraDocsParameters.length > 0) {
parameters.push(
t.objectProperty(
t.identifier('docs'),
t.objectExpression([t.spreadElement(optionalDocs), ...extraDocsParameters])
)
);
const addParameter = t.expressionStatement(
t.assignmentExpression('=', originalParameters, t.objectExpression(parameters))
);
Expand Down