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.

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

fix(storybook): handle main.js file correctly in storybook plugin #22081

Merged
merged 1 commit into from
Mar 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 66 additions & 0 deletions packages/storybook/src/plugins/plugin.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ describe('@nx/storybook/plugin', () => {
'my-ng-app/project.json',
JSON.stringify({ name: 'my-ng-app' })
);
tempFs.createFileSync(
'my-react-lib/project.json',
JSON.stringify({ name: 'my-react-lib' })
);
});

afterEach(() => {
Expand Down Expand Up @@ -176,4 +180,66 @@ describe('@nx/storybook/plugin', () => {
command: 'test-storybook',
});
});

it('should support main.js', () => {
tempFs.createFileSync(
'my-react-lib/.storybook/main.js',
`const config = {
stories: ['../src/lib/**/*.stories.@(js|jsx|ts|tsx|mdx)'],
addons: ['@storybook/addon-essentials'],
framework: {
name: '@storybook/react-vite',
options: {
builder: {
viteConfigPath: 'vite.config.js',
},
},
},
};
export default config;`
);
const nodes = createNodesFunction(
'my-react-lib/.storybook/main.js',
{
buildStorybookTargetName: 'build-storybook',
staticStorybookTargetName: 'static-storybook',
serveStorybookTargetName: 'serve-storybook',
testStorybookTargetName: 'test-storybook',
},
context
);

expect(nodes?.['projects']?.['my-react-lib']?.targets).toBeDefined();
expect(
nodes?.['projects']?.['my-react-lib']?.targets?.['build-storybook']
).toMatchObject({
command: 'storybook build',
options: {
cwd: 'my-react-lib',
},
cache: true,
outputs: [
'{workspaceRoot}/{projectRoot}/storybook-static',
'{options.output-dir}',
'{options.outputDir}',
'{options.o}',
],
inputs: [
'production',
'^production',
{ externalDependencies: ['storybook', '@storybook/test-runner'] },
],
});

expect(
nodes?.['projects']?.['my-react-lib']?.targets?.['storybook']
).toMatchObject({
command: 'storybook dev',
});
expect(
nodes?.['projects']?.['my-react-lib']?.targets?.['test-storybook']
).toMatchObject({
command: 'test-storybook',
});
});
});
67 changes: 35 additions & 32 deletions packages/storybook/src/plugins/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ function buildStorybookTargets(

const namedInputs = getNamedInputs(projectRoot, context);

const storybookFramework = getStorybookConfig(configFilePath, context);
const storybookFramework = getStorybookFramework(configFilePath, context);

const frameworkIsAngular = storybookFramework === "'@storybook/angular'";

Expand Down Expand Up @@ -262,7 +262,7 @@ function serveStaticTarget(
return targetConfig;
}

function getStorybookConfig(
function getStorybookFramework(
configFilePath: string,
context: CreateNodesContext
): string {
Expand All @@ -273,47 +273,50 @@ function getStorybookConfig(
'ImportDeclaration:has(ImportSpecifier:has([text="StorybookConfig"]))'
)?.[0];

if (!importDeclarations) {
return parseFrameworkName(mainTsJs);
}

const storybookConfigImportPackage = tsquery.query(
importDeclarations,
'StringLiteral'
)?.[0];

let frameworkName: string | undefined;

if (storybookConfigImportPackage?.getText() === `'@storybook/core-common'`) {
const frameworkPropertyAssignment = tsquery.query(
mainTsJs,
`PropertyAssignment:has(Identifier:has([text="framework"]))`
)?.[0];
return parseFrameworkName(mainTsJs);
}

if (!frameworkPropertyAssignment) {
return;
}
return storybookConfigImportPackage?.getText();
}

const propertyAssignments = tsquery.query(
frameworkPropertyAssignment,
`PropertyAssignment:has(Identifier:has([text="name"]))`
);
function parseFrameworkName(mainTsJs: string) {
const frameworkPropertyAssignment = tsquery.query(
mainTsJs,
`PropertyAssignment:has(Identifier:has([text="framework"]))`
)?.[0];

const namePropertyAssignment = propertyAssignments?.find((expression) => {
return expression.getText().startsWith('name');
});
if (!frameworkPropertyAssignment) {
return undefined;
}

if (!namePropertyAssignment) {
const storybookConfigImportPackage = tsquery.query(
frameworkPropertyAssignment,
'StringLiteral'
)?.[0];
frameworkName = storybookConfigImportPackage?.getText();
} else {
frameworkName = tsquery
.query(namePropertyAssignment, `StringLiteral`)?.[0]
?.getText();
}
} else {
frameworkName = storybookConfigImportPackage?.getText();
const propertyAssignments = tsquery.query(
frameworkPropertyAssignment,
`PropertyAssignment:has(Identifier:has([text="name"]))`
);

const namePropertyAssignment = propertyAssignments?.find((expression) => {
return expression.getText().startsWith('name');
});

if (!namePropertyAssignment) {
const storybookConfigImportPackage = tsquery.query(
frameworkPropertyAssignment,
'StringLiteral'
)?.[0];
return storybookConfigImportPackage?.getText();
}
return frameworkName;

return tsquery.query(namePropertyAssignment, `StringLiteral`)?.[0]?.getText();
}

function getOutputs(projectRoot: string): string[] {
Expand Down