All files / blong-browser/src storybookMain.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/**
 * Reusable Storybook main configuration factory for blong suites.
 *
 * Provides the common setup (framework, addons, viteFinal) so each
 * package only needs to declare its own stories paths and any extra
 * realm packages whose stories should be included.
 *
 * Usage in a suite's .storybook/main.ts:
 * ```ts
 * import {defineBlongStorybookMain} from '@feasibleone/blong-browser/storybookMain';
 * export default defineBlongStorybookMain({
 *     importMetaDirname: __dirname,
 *     realmPackages: ['@feasibleone/blong-marine'],
 * });
 * ```
 *
 * Usage in a realm's own .storybook/main.ts (standalone):
 * ```ts
 * import {defineBlongStorybookMain} from '@feasibleone/blong-browser/storybookMain';
 * export default defineBlongStorybookMain({importMetaDirname: __dirname});
 * ```
 *
 * Adding another realm to a suite is as simple as appending its package name
 * to the `realmPackages` array — the helper resolves story paths automatically.
 */
import type {StorybookConfig} from '@storybook/react-vite';
import {createRequire} from 'node:module';
import {dirname, resolve} from 'node:path';

export interface IBlongStorybookMainOptions {
    /**
     * Absolute path of the `.storybook/` directory — pass `__dirname`.
     * Used to build the relative story globs and monorepo fs.allow paths.
     */
    importMetaDirname: string;
    /**
     * Additional stories globs relative to the package root (one level up from
     * `.storybook/`). Defaults to `['../src/**\/*.stories.@(ts|tsx)']`.
     */
    localStories?: string[];
    /**
     * npm package names whose `src/stories/` (or resolved story paths) should
     * be included. The helper resolves each package's location and appends its
     * stories to the `stories` array with correct absolute paths.
     *
     * Adding a realm to a suite:
     * ```ts
     * realmPackages: ['@feasibleone/blong-marine', '@feasibleone/my-realm'],
     * ```
     */
    realmPackages?: string[];
    /**
     * Additional Storybook addons. Merged after the defaults
     * (`@storybook/addon-a11y`).
     */
    extraAddons?: string[];
}

function getAbsolutePath(value: string, fromDir: string): string {
    return dirname(createRequire(fromDir + '/package.json').resolve(`${value}/package.json`));
}

function resolveRealmStories(packageName: string, fromDir: string): string[] {
    try {
        const pkgPath = createRequire(fromDir + '/package.json').resolve(`${packageName}/package.json`);
        const realmRoot = dirname(pkgPath);
        return [`${realmRoot}/src/stories/**/*.stories.@(ts|tsx)`];
    } catch {
        console.warn(`[blong-browser/storybookMain] Could not resolve stories for ${packageName}`);
        return [];
    }
}

export function defineBlongStorybookMain(
    options: IBlongStorybookMainOptions,
): StorybookConfig {
    const {
        importMetaDirname,
        localStories = ['../src/**/*.stories.@(ts|tsx)'],
        realmPackages = [],
        extraAddons = [],
    } = options;

    const realmStories = realmPackages.flatMap(pkg =>
        resolveRealmStories(pkg, importMetaDirname),
    );

    const monorepoNodeModules = resolve(importMetaDirname, '../../../common/temp/node_modules');

    // Extra fs.allow entries for realm story file roots
    const realmRoots = realmPackages.flatMap(pkg => {
        try {
            const pkgPath = createRequire(importMetaDirname + '/package.json').resolve(`${pkg}/package.json`);
            return [dirname(pkgPath)];
        } catch {
            return [];
        }
    });

    return {
        stories: [...localStories, ...realmStories],
        addons: [
            getAbsolutePath('@storybook/addon-a11y', importMetaDirname),
            ...extraAddons.map(a => getAbsolutePath(a, importMetaDirname)),
        ],
        framework: {
            name: getAbsolutePath('@storybook/react-vite', importMetaDirname) as '@storybook/react-vite',
            options: {},
        },
        typescript: {
            reactDocgen: 'react-docgen-typescript',
        },
        viteFinal(config) {
            return {
                ...config,
                define: {
                    ...config.define,
                    'process.env': {},
                },
                resolve: {
                    ...config.resolve,
                    conditions: ['development', ...(config.resolve?.conditions ?? [])],
                    dedupe: ['react', 'react-dom'],
                },
                server: {
                    ...config.server,
                    fs: {
                        allow: [
                            resolve(importMetaDirname, '..'),
                            monorepoNodeModules,
                            ...realmRoots,
                        ],
                    },
                },
            };
        },
    };
}