Merge pull request #46 from storybookjs/feat/respect-mainjs-globs

Respect stories defined in main.js

.npmignore

@@ -0,0 +1 @@
+**/*.test.js

.storybook/main.js

@@ -1,11 +1,22 @@
 const { STRESS_TEST, STORY_STORE_V7, WITHOUT_DOCS } = process.env;
 
 const stories = [
+  '../stories/docs/**/*.stories.mdx',
+  // default title prefix
   {
-    directory: '../stories',
+    titlePrefix: 'Atoms',
+    directory: '../stories/atoms',
   },
+  // defined title prefix
+  {
+    titlePrefix: 'Molecules',
+    directory: '../stories/molecules',
+  },
+  // general glob
+  '../stories/pages/**/*.stories.*',
 ];
 
+
 if (STRESS_TEST) {
   stories.push('../stories/stress-test/*.stories.@(js|jsx|ts|tsx)');
 }

bin/test-storybook.js

@@ -6,7 +6,7 @@ const fetch = require('node-fetch');
 const fs = require('fs');
 const path = require('path');
 const tempy = require('tempy');
-const { getCliOptions, getStorybookMain } = require('../dist/cjs/util/cli');
+const { getCliOptions, getStorybookMetadata } = require('../dist/cjs/util');
 const { transformPlaywrightJson } = require('../dist/cjs/playwright/transformPlaywrightJson');
 
 // Do this as the first thing so that any code reading it knows the right env.
@@ -113,9 +113,10 @@ const main = async () => {
     process.env.TEST_MATCH = '**/*.test.js';
   }
 
-  // check if main.js exists, throw an error if not
-  getStorybookMain(runnerOptions.configDir);
   process.env.STORYBOOK_CONFIG_DIR = runnerOptions.configDir;
+
+  const { storiesPaths } = getStorybookMetadata();
+  process.env.STORYBOOK_STORIES_PATTERN = storiesPaths;
 
   await executeJestPlaywright(jestOptions);
 };

playwright/test-runner-jest.config.js

@@ -1,18 +1,9 @@
-const { TEST_ROOT, TEST_MATCH } = process.env;
-
-const roots = TEST_ROOT ? [TEST_ROOT] : undefined;
+const { getJestConfig } = require('@storybook/test-runner');
 
 module.exports = {
-  cacheDirectory: 'node_modules/.cache/storybook/test-runner',
-  rootDir: process.cwd(),
-  roots,
-  testMatch: [TEST_MATCH || '**/*.stories.[jt]s?(x)'],
-  transform: {
-    '^.+\\.stories\\.[jt]sx?$': '@storybook/test-runner/playwright/transform',
-    '^.+\\.[jt]sx?$': 'babel-jest',
-  },
-  preset: 'jest-playwright-preset',
-  globalSetup: '@storybook/test-runner/playwright/global-setup.js',
-  globalTeardown: '@storybook/test-runner/playwright/global-teardown.js',
-  testEnvironment: '@storybook/test-runner/playwright/custom-environment.js',
-};
+  // The default configuration comes from @storybook/test-runner
+  ...getJestConfig()
+  /** Add your own overrides below
+   * @see https://jestjs.io/docs/configuration
+   */
+}

src/config/jest-playwright.ts

@@ -0,0 +1,24 @@
+export const getJestConfig = () => {
+  const { TEST_ROOT, TEST_MATCH, STORYBOOK_STORIES_PATTERN } = process.env;
+
+  let config = {
+    rootDir: process.cwd(),
+    roots: TEST_ROOT ? [TEST_ROOT] : undefined,
+    testMatch: STORYBOOK_STORIES_PATTERN && STORYBOOK_STORIES_PATTERN.split(';'),
+    transform: {
+      '^.+\\.stories\\.[jt]sx?$': '@storybook/test-runner/playwright/transform',
+      '^.+\\.[jt]sx?$': 'babel-jest',
+    },
+    preset: 'jest-playwright-preset',
+    globalSetup: '@storybook/test-runner/playwright/global-setup.js',
+    globalTeardown: '@storybook/test-runner/playwright/global-teardown.js',
+    testEnvironment: '@storybook/test-runner/playwright/custom-environment.js',
+    // @TODO: setupFilesAfterEnv: ['@storybook/test-runner/setup']
+  };
+
+  if (TEST_MATCH) {
+    config.testMatch = [TEST_MATCH];
+  }
+
+  return config;
+};

src/index.ts

@@ -1 +1,2 @@
 export * from './playwright/hooks';
+export * from './config/jest-playwright';

src/playwright/transformPlaywright.test.ts

@@ -1,12 +1,11 @@
 import dedent from 'ts-dedent';
 import path from 'path';
 import * as coreCommon from '@storybook/core-common';
-import * as cli from '../util/cli';
+import * as storybookMain from '../util/getStorybookMain';
 
 import { transformPlaywright } from './transformPlaywright';
 
 jest.mock('@storybook/core-common');
-jest.mock('../util/cli');
 
 expect.addSnapshotSerializer({
   print: (val: any) => val.trim(),
@@ -17,7 +16,7 @@ describe('Playwright', () => {
   beforeEach(() => {
     const relativeSpy = jest.spyOn(path, 'relative');
     relativeSpy.mockReturnValueOnce('stories/basic/Header.stories.js');
-    jest.spyOn(cli, 'getStorybookMain').mockImplementation(() => ({
+    jest.spyOn(storybookMain, 'getStorybookMain').mockImplementation(() => ({
       stories: [
         {
           directory: '../stories/basic',

src/playwright/transformPlaywright.ts

@@ -1,9 +1,8 @@
-import { resolve, relative } from 'path';
+import { relative } from 'path';
 import template from '@babel/template';
-import { normalizeStories } from '@storybook/core-common';
 import { autoTitle } from '@storybook/store';
 
-import { getStorybookMain } from '../util/cli';
+import { getStorybookMetadata } from '../util';
 import { transformCsf } from '../csf/transformCsf';
 
 const filePrefixer = template(`
@@ -41,19 +40,7 @@ export const testPrefixer = template(
 );
 
 const getDefaultTitle = (filename: string) => {
-  const workingDir = resolve();
-  const configDir = process.env.STORYBOOK_CONFIG_DIR;
-
-  const main = getStorybookMain(configDir);
-
-  const normalizedStoriesEntries = normalizeStories(main.stories, {
-    configDir,
-    workingDir,
-  }).map((specifier) => ({
-    ...specifier,
-    importPathMatcher: new RegExp(specifier.importPathMatcher),
-  }));
-
+  const { workingDir, normalizedStoriesEntries } = getStorybookMetadata();
   const filePath = './' + relative(workingDir, filename);
 
   return autoTitle(filePath, normalizedStoriesEntries);

src/util/getCliOptions.test.ts

@@ -0,0 +1,18 @@
+import { defaultRunnerOptions, getCliOptions } from './getCliOptions';
+import * as cliHelper from './getParsedCliOptions';
+
+describe('getCliOptions', () => {
+  it('returns default options if no extra option is passed', () => {
+    const opts = getCliOptions();
+    expect(opts.runnerOptions).toMatchObject(defaultRunnerOptions);
+  });
+
+  it('returns custom options if passed', () => {
+    const customConfig = { configDir: 'custom', storiesJson: true };
+    jest
+      .spyOn(cliHelper, 'getParsedCliOptions')
+      .mockReturnValue({ options: customConfig, extraArgs: [] });
+    const opts = getCliOptions();
+    expect(opts.runnerOptions).toMatchObject(customConfig);
+  });
+});

src/util/cli.ts → src/util/getCliOptions.ts

@@ -1,6 +1,4 @@
-import { join, resolve } from 'path';
-import { serverRequire, StorybookConfig } from '@storybook/core-common';
-import { getParsedCliOptions } from './helpers';
+import { getParsedCliOptions } from './getParsedCliOptions';
 
 type CliOptions = {
   runnerOptions: {
@@ -19,17 +17,15 @@ export const defaultRunnerOptions: CliOptions['runnerOptions'] = {
   storiesJson: false,
 };
 
-let storybookMainConfig: StorybookConfig;
-
 export const getCliOptions = () => {
-  const allOptions = getParsedCliOptions();
+  const { options: allOptions, extraArgs } = getParsedCliOptions();
 
   const defaultOptions: CliOptions = {
     runnerOptions: { ...defaultRunnerOptions },
     jestOptions: process.argv.splice(0, 2),
   };
 
-  return Object.keys(allOptions).reduce((acc, key: any) => {
+  const finalOptions = Object.keys(allOptions).reduce((acc, key: any) => {
     if (STORYBOOK_RUNNER_COMMANDS.includes(key)) {
       //@ts-ignore
       acc.runnerOptions[key] = allOptions[key];
@@ -45,19 +41,10 @@ export const getCliOptions = () => {
 
     return acc;
   }, defaultOptions);
-};
-
-export const getStorybookMain = (configDir: string) => {
-  if (storybookMainConfig) {
-    return storybookMainConfig;
-  }
 
-  storybookMainConfig = serverRequire(join(resolve(configDir), 'main'));
-  if (!storybookMainConfig) {
-    throw new Error(
-      `Could not load main.js in ${configDir}. Is the config directory correct? You can change it by using --config-dir <path-to-dir>`
-    );
+  if (extraArgs.length) {
+    finalOptions.jestOptions.push(...extraArgs);
   }
 
-  return storybookMainConfig;
+  return finalOptions;
 };

src/util/helpers.ts → src/util/getParsedCliOptions.ts

@@ -37,5 +37,8 @@ export const getParsedCliOptions = () => {
     }
   }
 
-  return program.opts();
+  return {
+    options: program.opts(),
+    extraArgs: program.args,
+  };
 };

src/util/getStorybookMain.test.ts

@@ -0,0 +1,26 @@
+import { getStorybookMain } from './getStorybookMain';
+import * as coreCommon from '@storybook/core-common';
+
+jest.mock('@storybook/core-common');
+
+describe('getStorybookMain', () => {
+  it('should throw an error if no configuration is found', () => {
+    expect(() => getStorybookMain('.storybook')).toThrow();
+  });
+
+  it('should return mainjs', () => {
+    const mockedMain = {
+      stories: [
+        {
+          directory: '../stories/basic',
+          titlePrefix: 'Example',
+        },
+      ],
+    };
+
+    jest.spyOn(coreCommon, 'serverRequire').mockImplementation(() => mockedMain);
+
+    const res = getStorybookMain('.storybook');
+    expect(res).toMatchObject(mockedMain);
+  });
+});

src/util/getStorybookMain.ts

@@ -0,0 +1,20 @@
+import { join, resolve } from 'path';
+import { serverRequire } from '@storybook/core-common';
+import type { StorybookConfig } from '@storybook/core-common';
+
+let storybookMainConfig: StorybookConfig;
+
+export const getStorybookMain = (configDir: string) => {
+  if (storybookMainConfig) {
+    return storybookMainConfig;
+  }
+
+  storybookMainConfig = serverRequire(join(resolve(configDir), 'main'));
+  if (!storybookMainConfig) {
+    throw new Error(
+      `Could not load main.js in ${configDir}. Is the config directory correct? You can change it by using --config-dir <path-to-dir>`
+    );
+  }
+
+  return storybookMainConfig;
+};