creevey 0.8.0-beta.1 → 0.8.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [0.8.0](https://github.com/wKich/creevey/compare/v0.8.0-beta.1...v0.8.0) (2023-03-07)
+
+### Bug Fixes
+
+- drop support of SkipOption on root skip level ([31be1bf](https://github.com/wKich/creevey/commit/31be1bf4d67f464ea6790e6e218ca75674366711))
+
 # [0.8.0-beta.1](https://github.com/wKich/creevey/compare/v0.8.0-beta.0...v0.8.0-beta.1) (2023-01-18)
 
 ### Bug Fixes

package/README.md

@@ -1,4 +1,4 @@
-# 📸+👦🏼 [Creevey](https://harrypotter.fandom.com/wiki/Colin_Creevey)
+[<img width="274" alt="Creevey" src="https://user-images.githubusercontent.com/4607770/220418756-89cf4f54-ccb7-4086-a74c-a044ea1d2a61.png">](https://harrypotter.fandom.com/wiki/Colin_Creevey)
 
 **IMPORTANT** _Looking for any help with maintaining_
 

package/docs/config.md

@@ -120,7 +120,7 @@ export const parameters = {
   creevey: {
     // Skip all *hover tests in IE11 on the global level
     skip: {
-      ie11: { in: 'ie11', tests: /.*hover$/ },
+      "hovers don't work in ie11": { in: 'ie11', tests: /.*hover$/ },
     },
   },
 };
@@ -137,15 +137,14 @@ export default {
   parameters: {
     creevey: {
       // You could skip some browsers/stories or even specific tests
-      skip: [
-        { in: 'ie11', reason: "`MyComponent` doesn't support ie11" },
-        { in: 'firefox', stories: 'Loading', reason: "Loading stories are flaky in firefox" },
-        {
+      skip: {
+        "`MyComponent` doesn't support ie11": { in: 'ie11' },
+        "Loading stories are flaky in firefox": { in: 'firefox', stories: 'Loading' },
+        "`MyComponent` hovering doesn't work correctly": {
           in: ['firefox', 'chrome'],
           tests: /.*hover$/,
-          reason: "For some reason `MyComponent` hovering doesn't work correctly",
         },
-      ],
+      },
     },
   },
 } as Meta & CreeveyMeta;
@@ -169,43 +168,47 @@ Basic.parameters = {
 
 ```ts
 interface SkipOption {
-  reason?: string;
   in?: string | string[] | RegExp;
   kinds?: string | string[] | RegExp;
   stories?: string | string[] | RegExp;
   tests?: string | string[] | RegExp;
 }
 
-type SkipOptions = SkipOption | SkipOption[] | Record<string, SkipOption | SkipOption[]>;
+type SkipOptions = boolean | string | Record<string, SkipOption | SkipOption[]>;
 ```
 
 - Skip all stories for all browsers:
   - `skip: true`
   - `skip: 'Skip reason message'`
-  - `skip: { reason: 'Skip reason message' }`
+  - `skip: { 'Skip reason message': true }`
 - Skip all stories for specific browsers:
-  - `skip: { in: 'ie11' }`
-  - `skip: { in: ['ie11', 'chrome'] }`
-  - `skip: { in: /^fire.*/ }`
+  - `skip: { 'Skip reason message': { in: 'ie11' } }`
+  - `skip: { 'Skip reason message': { in: ['ie11', 'chrome'] } }`
+  - `skip: { 'Skip reason message': { in: /^fire.*/ } }`
 - Skip all stories in specific kinds:
-  - `skip: { kinds: 'Button' }`
-  - `skip: { kinds: ['Button', 'Input'] }`
-  - `skip: { kinds: /.*Modal$/ }`
+  - `skip: { 'Skip reason message': { kinds: 'Button' } }`
+  - `skip: { 'Skip reason message': { kinds: ['Button', 'Input'] } }`
+  - `skip: { 'Skip reason message': { kinds: /.*Modal$/ } }`
 - Skip all tests in specific stories:
-  - `skip: { stories: 'simple' }`
-  - `skip: { stories: ['simple', 'special'] }`
-  - `skip: { stories: /.*large$/ }`
+  - `skip: { 'Skip reason message': { stories: 'simple' } }`
+  - `skip: { 'Skip reason message': { stories: ['simple', 'special'] } }`
+  - `skip: { 'Skip reason message': { stories: /.*large$/ } }`
 - Skip specific tests:
-  - `skip: { tests: 'click' }`
-  - `skip: { tests: ['hover', 'click'] }`
-  - `skip: { tests: /^press.*$/ }`
+  - `skip: { 'Skip reason message': { tests: 'click' } }`
+  - `skip: { 'Skip reason message': { tests: ['hover', 'click'] } }`
+  - `skip: { 'Skip reason message': { tests: /^press.*$/ } }`
 - Multiple skip options:
-  - as an array `skip: [{ /* ... */ }]`
-  - as an object
+  - for one reason
+    ```
+    skip: {
+      "reason": [{ /* ... */ }, { /* ... */ }],
+    }
+    ```
+  - for several reasons
     ```
     skip: {
-      foo: { /* ... */ },
-      bar: { /* ... */ },
+      "reason 1": { /* ... */ },
+      "reason 2": { /* ... */ },
     }
     ```
 

package/lib/cjs/server/loaders/webpack/compile.js

@@ -244,7 +244,7 @@ async function compile(config, {
     allowlist: /(webpack|dummy-hmr|generated-stories-entry|generated-config-entry|generated-other-entry)/
   }), // TODO Don't work well with monorepos
   (0, _webpackNodeExternals.default)({
-    modulesDir: (0, _helpers.resolveFromStorybook)('@storybook/core').split('@storybook')[0],
+    modulesDir: (0, _helpers.resolveFromStorybook)('@storybook/core-client').split('@storybook')[0],
     includeAbsolutePaths: true,
     allowlist: /(webpack|dummy-hmr|generated-stories-entry|generated-config-entry|generated-other-entry)/
   })]; // NOTE Exclude some plugins

package/lib/cjs/server/storybook/entry.js

@@ -11,7 +11,7 @@ var _helpers = require("./helpers");
 
 const framework = (0, _helpers.getStorybookFramework)(); // eslint-disable-next-line @typescript-eslint/no-var-requires
 
-const core = require((0, _helpers.resolveFromStorybook)('@storybook/core'));
+const core = require((0, _helpers.resolveFromStorybook)('@storybook/core-client'));
 
 const start = core.start;
 const api = start(() => void 0);

package/lib/cjs/server/storybook/helpers.js

@@ -14,7 +14,7 @@ exports.isCSFv3Enabled = isCSFv3Enabled;
 exports.isStorybookVersion = isStorybookVersion;
 exports.isStorybookVersionGreaterThan = isStorybookVersionGreaterThan;
 exports.isStorybookVersionLessThan = isStorybookVersionLessThan;
-exports.storybookDirRef = exports.storybookConfigRef = exports.resolveFromStorybookCoreServer = exports.resolveFromStorybookCore = exports.resolveFromStorybookBuilderWebpack4 = exports.resolveFromStorybookAddonDocs = exports.resolveFromStorybook = void 0;
+exports.storybookDirRef = exports.storybookConfigRef = exports.resolveFromStorybookCoreServer = exports.resolveFromStorybookCoreClient = exports.resolveFromStorybookBuilderWebpack4 = exports.resolveFromStorybookAddonDocs = exports.resolveFromStorybook = void 0;
 
 var _path = _interopRequireDefault(require("path"));
 
@@ -44,9 +44,9 @@ const resolveFromStorybookBuilderWebpack4 = modulePath => (0, _resolveFrom.defau
 
 exports.resolveFromStorybookBuilderWebpack4 = resolveFromStorybookBuilderWebpack4;
 
-const resolveFromStorybookCore = modulePath => (0, _resolveFrom.default)(resolveFromStorybook('@storybook/core'), modulePath);
+const resolveFromStorybookCoreClient = modulePath => (0, _resolveFrom.default)(resolveFromStorybook('@storybook/core-client'), modulePath);
 
-exports.resolveFromStorybookCore = resolveFromStorybookCore;
+exports.resolveFromStorybookCoreClient = resolveFromStorybookCoreClient;
 
 const resolveFromStorybookCoreServer = modulePath => (0, _resolveFrom.default)(resolveFromStorybook('@storybook/core-server'), modulePath);
 

package/lib/cjs/server/utils.js

@@ -9,6 +9,7 @@ exports.isShuttingDown = exports.isInsideDocker = void 0;
 exports.removeProps = removeProps;
 exports.runSequence = runSequence;
 exports.shouldSkip = shouldSkip;
+exports.shouldSkipByOption = shouldSkipByOption;
 exports.shutdown = shutdown;
 exports.shutdownWorkers = shutdownWorkers;
 exports.skipOptionKeys = void 0;
@@ -48,38 +49,30 @@ function shouldSkip(browser, meta, skipOptions, test) {
     return skipOptions;
   }
 
-  if (Array.isArray(skipOptions)) {
-    for (const skip of skipOptions) {
-      const reason = shouldSkip(browser, meta, skip, test);
-      if (reason) return reason;
-    }
-
-    return false;
+  for (const skipKey in skipOptions) {
+    const reason = shouldSkipByOption(browser, meta, skipOptions[skipKey], skipKey, test);
+    if (reason) return reason;
   }
 
-  let hasSkipOptionKeys = false;
+  return false;
+}
 
-  for (const skipKey in skipOptions) {
-    if (skipOptionKeys.includes(skipKey)) {
-      hasSkipOptionKeys = true;
-      continue;
+function shouldSkipByOption(browser, meta, skipOption, reason, test) {
+  if (Array.isArray(skipOption)) {
+    for (const skip of skipOption) {
+      const result = shouldSkipByOption(browser, meta, skip, reason, test);
+      if (result) return result;
     }
 
-    const reason = shouldSkip(browser, meta, {
-      reason: skipKey,
-      ...skipOptions[skipKey]
-    }, test);
-    if (reason) return reason;
+    return false;
   }
 
-  if (!hasSkipOptionKeys) return false;
   const {
     in: browsers,
     kinds,
     stories,
-    tests,
-    reason = true
-  } = skipOptions;
+    tests
+  } = skipOption;
   const {
     kind,
     story

package/lib/esm/server/loaders/webpack/compile.js

@@ -221,7 +221,7 @@ export default async function compile(config, {
     allowlist: /(webpack|dummy-hmr|generated-stories-entry|generated-config-entry|generated-other-entry)/
   }), // TODO Don't work well with monorepos
   nodeExternals({
-    modulesDir: resolveFromStorybook('@storybook/core').split('@storybook')[0],
+    modulesDir: resolveFromStorybook('@storybook/core-client').split('@storybook')[0],
     includeAbsolutePaths: true,
     allowlist: /(webpack|dummy-hmr|generated-stories-entry|generated-config-entry|generated-other-entry)/
   })]; // NOTE Exclude some plugins

package/lib/esm/server/storybook/entry.js

@@ -2,7 +2,7 @@ import { addons } from '@storybook/addons';
 import { getStorybookFramework, resolveFromStorybook } from './helpers';
 const framework = getStorybookFramework(); // eslint-disable-next-line @typescript-eslint/no-var-requires
 
-const core = require(resolveFromStorybook('@storybook/core'));
+const core = require(resolveFromStorybook('@storybook/core-client'));
 
 const start = core.start;
 const api = start(() => void 0);

package/lib/esm/server/storybook/helpers.js

@@ -7,7 +7,7 @@ export const storybookDirRef = {
 export const resolveFromStorybook = modulePath => resolveFrom(storybookDirRef.current, modulePath);
 export const resolveFromStorybookAddonDocs = modulePath => resolveFrom(resolveFromStorybook('@storybook/addon-docs'), modulePath);
 export const resolveFromStorybookBuilderWebpack4 = modulePath => resolveFrom(resolveFromStorybook('@storybook/builder-webpack4'), modulePath);
-export const resolveFromStorybookCore = modulePath => resolveFrom(resolveFromStorybook('@storybook/core'), modulePath);
+export const resolveFromStorybookCoreClient = modulePath => resolveFrom(resolveFromStorybook('@storybook/core-client'), modulePath);
 export const resolveFromStorybookCoreServer = modulePath => resolveFrom(resolveFromStorybook('@storybook/core-server'), modulePath);
 
 const importFromStorybook = modulePath => import(resolveFromStorybook(modulePath));

package/lib/esm/server/utils.js

@@ -20,38 +20,29 @@ export function shouldSkip(browser, meta, skipOptions, test) {
     return skipOptions;
   }
 
-  if (Array.isArray(skipOptions)) {
-    for (const skip of skipOptions) {
-      const reason = shouldSkip(browser, meta, skip, test);
-      if (reason) return reason;
-    }
-
-    return false;
+  for (const skipKey in skipOptions) {
+    const reason = shouldSkipByOption(browser, meta, skipOptions[skipKey], skipKey, test);
+    if (reason) return reason;
   }
 
-  let hasSkipOptionKeys = false;
-
-  for (const skipKey in skipOptions) {
-    if (skipOptionKeys.includes(skipKey)) {
-      hasSkipOptionKeys = true;
-      continue;
+  return false;
+}
+export function shouldSkipByOption(browser, meta, skipOption, reason, test) {
+  if (Array.isArray(skipOption)) {
+    for (const skip of skipOption) {
+      const result = shouldSkipByOption(browser, meta, skip, reason, test);
+      if (result) return result;
     }
 
-    const reason = shouldSkip(browser, meta, {
-      reason: skipKey,
-      ...skipOptions[skipKey]
-    }, test);
-    if (reason) return reason;
+    return false;
   }
 
-  if (!hasSkipOptionKeys) return false;
   const {
     in: browsers,
     kinds,
     stories,
-    tests,
-    reason = true
-  } = skipOptions;
+    tests
+  } = skipOption;
   const {
     kind,
     story

package/lib/types/server/storybook/entry.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 /// <reference types="webpack-env" />
 import type { StoryApi } from '@storybook/addons';
-declare const start: typeof import("@storybook/core").start;
+declare const start: typeof import("@storybook/core-client").start;
 export declare const channel: import("@storybook/channels").Channel;
 declare type ClientApi = ReturnType<typeof start>['clientApi'];
 export declare const clientApi: ClientApi;

package/lib/types/server/storybook/helpers.d.ts

@@ -5,7 +5,7 @@ export declare const storybookDirRef: {
 export declare const resolveFromStorybook: (modulePath: string) => string;
 export declare const resolveFromStorybookAddonDocs: (modulePath: string) => string;
 export declare const resolveFromStorybookBuilderWebpack4: (modulePath: string) => string;
-export declare const resolveFromStorybookCore: (modulePath: string) => string;
+export declare const resolveFromStorybookCoreClient: (modulePath: string) => string;
 export declare const resolveFromStorybookCoreServer: (modulePath: string) => string;
 export declare const importStorybookClientLogger: <T = typeof import("@storybook/client-logger")>() => Promise<T>;
 export declare const importStorybookCoreCommon: <T = typeof import("@storybook/core-common")>() => Promise<T>;

package/lib/types/server/utils.d.ts

@@ -1,4 +1,4 @@
-import { SkipOptions, TestData } from '../types';
+import { SkipOptions, SkipOption, TestData } from '../types';
 export declare const isShuttingDown: {
     current: boolean;
 };
@@ -9,6 +9,10 @@ export declare function shouldSkip(browser: string, meta: {
     kind: string;
     story: string;
 }, skipOptions: SkipOptions, test?: string): string | boolean;
+export declare function shouldSkipByOption(browser: string, meta: {
+    kind: string;
+    story: string;
+}, skipOption: SkipOption | SkipOption[], reason: string, test?: string): string | boolean;
 export declare function shutdownWorkers(): Promise<void>;
 export declare function shutdown(): void;
 export declare function getCreeveyCache(): string;

package/lib/types/types.d.ts

@@ -400,13 +400,12 @@ export interface CreeveyUpdate {
     removedTests?: TestMeta[];
 }
 export interface SkipOption {
-    reason?: string;
     in?: string | string[] | RegExp;
     kinds?: string | string[] | RegExp;
     stories?: string | string[] | RegExp;
     tests?: string | string[] | RegExp;
 }
-export declare type SkipOptions = boolean | string | SkipOption | SkipOption[] | Record<string, SkipOption | SkipOption[]>;
+export declare type SkipOptions = boolean | string | Record<string, SkipOption | SkipOption[]>;
 export declare type CreeveyTestFunction = (this: {
     browser: WebDriver;
     until: typeof until;

package/package.json

@@ -13,7 +13,7 @@
     "addon",
     "test"
   ],
-  "version": "0.8.0-beta.1",
+  "version": "0.8.0",
   "bin": {
     "creevey": "./lib/cjs/cli.js"
   },
@@ -149,7 +149,6 @@
     "@storybook/channels": "^6.5.9",
     "@storybook/client-api": "^6.5.9",
     "@storybook/client-logger": "^6.5.9",
-    "@storybook/core": "^6.5.9",
     "@storybook/core-client": "^6.5.9",
     "@storybook/core-common": "^6.5.9",
     "@storybook/core-events": "^6.5.9",