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

Server: Add json indexer #22460

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
11 changes: 11 additions & 0 deletions code/lib/cli/src/sandbox-templates.ts
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,17 @@ const internalTemplates = {
},
},
},
'internal/server-webpack5': {
name: 'Server Webpack5',
script: 'yarn init -y',
expected: {
framework: '@storybook/server-webpack5',
renderer: '@storybook/server',
builder: '@storybook/builder-webpack5',
},
isInternal: true,
inDevelopment: true,
},
// 'internal/pnp': {
// ...baseTemplates['cra/default-ts'],
// name: 'PNP (cra/default-ts)',
Expand Down
11 changes: 10 additions & 1 deletion code/renderers/server/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@
"require": "./dist/config.js",
"import": "./dist/config.mjs"
},
"./preset": {
"types": "./dist/preset.d.ts",
"require": "./dist/preset.js",
"import": "./dist/preset.mjs"
},
"./package.json": "./package.json"
},
"main": "dist/index.js",
Expand All @@ -49,9 +54,12 @@
},
"dependencies": {
"@storybook/core-client": "7.1.0-alpha.12",
"@storybook/csf": "^0.1.0",
"@storybook/global": "^5.0.0",
"@storybook/preview-api": "7.1.0-alpha.12",
"@storybook/types": "7.1.0-alpha.12",
"@types/fs-extra": "^11.0.1",
"fs-extra": "^11.1.0",
"ts-dedent": "^2.0.0"
},
"devDependencies": {
Expand All @@ -66,7 +74,8 @@
"bundler": {
"entries": [
"./src/index.ts",
"./src/config.ts"
"./src/config.ts",
"./src/preset.ts"
],
"platform": "browser"
},
Expand Down
1 change: 1 addition & 0 deletions code/renderers/server/preset.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('./dist/preset');
33 changes: 33 additions & 0 deletions code/renderers/server/src/preset.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import fs from 'fs-extra';
import { toId } from '@storybook/csf';
import type { StaticMeta } from '@storybook/csf-tools';
import type { IndexerOptions, IndexedStory, StoryIndexer } from '@storybook/types';

export const storyIndexers = (indexers: StoryIndexer[] | null) => {
const jsonIndexer = async (fileName: string, opts: IndexerOptions) => {
const json = await fs.readJson(fileName, 'utf-8');
const meta: StaticMeta = {
title: json.title,
};
const stories: IndexedStory[] = json.stories.map((story: any) => {
Copy link
Member

Choose a reason for hiding this comment

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

Is it possible to type story here?

const id = toId(meta.title, story.name);
const { name } = story;
const indexedStory: IndexedStory = {
id,
name,
};
return indexedStory;
});
return {
meta,
stories,
};
};
return [
{
test: /(stories|story)\.json$/,
indexer: jsonIndexer,
},
...(indexers || []),
];
};
5 changes: 4 additions & 1 deletion code/renderers/server/template/cli/button.stories.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"title": "Example/Button",
"parameters": {
"server": { "id": "button" }
"server": {
"url": "https://storybook-server-demo.netlify.app/api",
"id": "button"
}
},
"args": { "label": "Button" },
"argTypes": {
Expand Down
5 changes: 4 additions & 1 deletion code/renderers/server/template/cli/header.stories.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"title": "Example/Header",
"parameters": {
"server": { "id": "header" }
"server": {
"url": "https://storybook-server-demo.netlify.app/api",
"id": "header"
}
},
"stories": [
{
Expand Down
5 changes: 4 additions & 1 deletion code/renderers/server/template/cli/page.stories.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"title": "Example/Page",
"parameters": {
"server": { "id": "page" }
"server": {
"url": "https://storybook-server-demo.netlify.app/api",
"id": "page"
}
},
"stories": [
{
Expand Down
3 changes: 3 additions & 0 deletions code/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7051,9 +7051,12 @@ __metadata:
resolution: "@storybook/server@workspace:renderers/server"
dependencies:
"@storybook/core-client": 7.1.0-alpha.12
"@storybook/csf": ^0.1.0
"@storybook/global": ^5.0.0
"@storybook/preview-api": 7.1.0-alpha.12
"@storybook/types": 7.1.0-alpha.12
"@types/fs-extra": ^11.0.1
fs-extra: ^11.1.0
ts-dedent: ^2.0.0
typescript: ~4.9.3
languageName: unknown
Expand Down
4 changes: 3 additions & 1 deletion scripts/sandbox/generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,9 @@ const runGenerators = async (
await Promise.all(
generators.map(({ dirName, name, script, expected }) =>
limit(async () => {
const flags = expected.renderer === '@storybook/html' ? ['--type html'] : [];
let flags: string[] = [];
if (expected.renderer === '@storybook/html') flags = ['--type html'];
else if (expected.renderer === '@storybook/server') flags = ['--type server'];

const time = process.hrtime();
console.log(`🧬 Generating ${name}`);
Expand Down
8 changes: 6 additions & 2 deletions scripts/tasks/sandbox-parts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,9 @@ export const install: Task['run'] = async (
);
}

const extra = template.expected.renderer === '@storybook/html' ? { type: 'html' } : {};
let extra = {};
if (template.expected.renderer === '@storybook/html') extra = { type: 'html' };
else if (template.expected.renderer === '@storybook/server') extra = { type: 'server' };

await executeCLIStep(steps.init, {
cwd,
Expand Down Expand Up @@ -368,7 +370,9 @@ export const addStories: Task['run'] = async (
const packageJson = await import(join(cwd, 'package.json'));
updateStoriesField(mainConfig, detectLanguage(packageJson) === SupportedLanguage.JAVASCRIPT);

const isCoreRenderer = template.expected.renderer.startsWith('@storybook/');
const isCoreRenderer =
template.expected.renderer.startsWith('@storybook/') &&
template.expected.renderer !== '@storybook/server';

const sandboxSpecificStoriesFolder = key.replaceAll('/', '-');
const storiesVariantFolder = getStoriesFolderWithVariant(sandboxSpecificStoriesFolder);
Expand Down