creevey 0.7.39 → 0.8.0-beta.1

package/CHANGELOG.md

@@ -1,11 +1,42 @@
-## [0.7.39](https://github.com/wKich/creevey/compare/v0.7.38...v0.7.39) (2021-11-04)
+# [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
 
+- **addon:** restore IE11 support ([94f452f](https://github.com/wKich/creevey/commit/94f452fff4225e974c9efdff21f982d5155de4f8))
+- allow setting timeouts via capabilities ([72de9e5](https://github.com/wKich/creevey/commit/72de9e50b818587309f665c782637ae43c3e4864))
+- infinite UI loading ([4f7b47d](https://github.com/wKich/creevey/commit/4f7b47db3ff1274217b044ce608e34d22148fe32))
+- **addon:** restore and move ie11 support to separate addon ([3ba2cc7](https://github.com/wKich/creevey/commit/3ba2cc7fde281037406f1705c0abc616c576e641))
+- browser-node regexp parameters transfering ([737670e](https://github.com/wKich/creevey/commit/737670e18aa5d0ce416fe12b765406116b453e31))
+- correct call of the test fn ([98c03ad](https://github.com/wKich/creevey/commit/98c03ad1700486bfd75170f4517970717250f6d8))
+- handle null from selectStory ([1895602](https://github.com/wKich/creevey/commit/1895602143b3236ab195e11fcfa162df2a01af03))
+- ie11 support ([523e35b](https://github.com/wKich/creevey/commit/523e35b6950d978ca3aaa77dd4f072a835053687))
+- move addon to the separate entry point ([f3fc59f](https://github.com/wKich/creevey/commit/f3fc59f980a56f87f882507c3a0367ed6a356d33))
+- prevent importing browser-specific code to node ([37706ef](https://github.com/wKich/creevey/commit/37706efbb49dd5bd1d6ec06821fac52480a0e132))
+- **selenium-webdriver:** bump [@types](https://github.com/types) package version ([ca4b369](https://github.com/wKich/creevey/commit/ca4b369046e2c56e0548f5cbb6f98c17b0125228))
 
 ### Features
 
-* 🎸 add ability to update story arguments from test cases ([18d8ecb](https://github.com/wKich/creevey/commit/18d8ecb909097b585282a04bfb0b0c721ad45e22))
+- 🎸 add support `play()` story method ([318ac62](https://github.com/wKich/creevey/commit/318ac628cb14fb0de7a89c088ae241df520df1e7))
+- drop support for storybook < 6.4 ([fb8c0f5](https://github.com/wKich/creevey/commit/fb8c0f5158ab7c0495949eaa61ba52049c3d66cf))
+
+# [0.8.0-beta.0](https://github.com/wKich/creevey/compare/v0.7.39...v0.8.0-beta.0) (2022-03-17)
+
+### Bug Fixes
+
+- 🐛 revert cross-env scripts, as they not work in unix ([92b04a5](https://github.com/wKich/creevey/commit/92b04a5bed56191b7ee6bd169f5327e30a1c2232))
 
+### Features
+
+- 🎸 change format for `skip` parameter ([f244b7c](https://github.com/wKich/creevey/commit/f244b7cd344b276762408a1df841e5afc3853fad))
+- 🎸 Improve skip options ([2fcc624](https://github.com/wKich/creevey/commit/2fcc624a9b2ab1dcdce3927779c8f58bb0a0d02c))
+- new creevey params: "global" and "kind" ([7d7c885](https://github.com/wKich/creevey/commit/7d7c88521a28c91586bfdd663500bea576845292))
+- support storybook 6.4 ([74010e5](https://github.com/wKich/creevey/commit/74010e53d93ff1815427cd7ee818481ce6e21288))
+
+## [0.7.39](https://github.com/wKich/creevey/compare/v0.7.38...v0.7.39) (2021-11-04)
+
+### Features
 
+- 🎸 add ability to update story arguments from test cases ([18d8ecb](https://github.com/wKich/creevey/commit/18d8ecb909097b585282a04bfb0b0c721ad45e22))
 
 ## [0.7.38](https://github.com/wKich/creevey/compare/v0.7.37...v0.7.38) (2021-09-28)
 

package/README.md

@@ -1,9 +1,12 @@
 # 📸+👦🏼 [Creevey](https://harrypotter.fandom.com/wiki/Colin_Creevey)
 
+**IMPORTANT** _Looking for any help with maintaining_
+
 Cross-browser screenshot testing tool for [Storybook](https://storybook.js.org/) with fancy UI Runner.
 
 [![Creevey downloads](https://img.shields.io/npm/dt/creevey)](https://www.npmjs.com/package/creevey)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FwKich%2Fcreevey.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FwKich%2Fcreevey?ref=badge_shield)
 
 ![Creevey Demo](https://user-images.githubusercontent.com/6397708/100863723-cd6b8500-34b6-11eb-94e1-849590bc8066.gif)
 
@@ -29,7 +32,7 @@ It named after [Colin Creevey](https://harrypotter.fandom.com/wiki/Colin_Creevey
 - [Examples](https://github.com/wKich/creevey-examples)
 - Advanced usage
   - [Write tests](docs/tests.md)
-  - [Use your Selenium Grid (BrowserStack/SauceLabs/etc)](docs/grid.md)
+  - [Use your Selenium Grid (LambdaTest/BrowserStack/SauceLabs/etc)](docs/grid.md)
 - [Future plans](#future-plans)
 - [Known issues](#known-issues)
 - [Used by](#used-by)
@@ -37,6 +40,7 @@ It named after [Colin Creevey](https://harrypotter.fandom.com/wiki/Colin_Creevey
 ## Pre-requisites
 
 - Make sure you have installed [Docker](https://www.docker.com/products/docker-desktop). But if you going to use your own separate Selenium Grid, you don't need `Docker`.
+- Supported Storybook versions: `^6.4.0`.
 
 ## How to start
 
@@ -145,3 +149,7 @@ Because tests defined in story parameters and `selenium-webdriver` depends on no
 
 | [![Whisk](https://raw.githubusercontent.com/wKich/creevey/master/.github/images/whisk.svg)](https://whisk.com/) | [![SKB Kontur](https://kontur.ru/Files/userfiles/image/brandbook/logo-skb-kontur-eng.png)](https://kontur.ru/) | [![ABBYY](https://raw.githubusercontent.com/wKich/creevey/master/.github/images/abbyy.svg)](https://www.abbyy.com/) |
 | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+
+## License
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FwKich%2Fcreevey.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FwKich%2Fcreevey?ref=badge_large)

package/addon/README.md

@@ -0,0 +1,3 @@
+This is a fallback for package.json's `exports.addon` field. It's required for outdated environments (like node 11 and typescript with the "node" moduleResolution) to resolve imports from `creevey/addon` properly.
+
+See https://github.com/andrewbranch/example-subpath-exports-ts-compat. The fallback uses the "package-json-redirects" startegy.

package/addon/package.json

@@ -0,0 +1,4 @@
+{
+  "main": "../lib/cjs/client/addon/index.js",
+  "types": "../lib/types/client/addon/index.d.ts"
+}

package/docs/config.md

@@ -112,7 +112,19 @@ module.exports = {
 
 ### Storybook parameters
 
-Also you could define parameters on `kind` or `story` levels. All these parameters are deeply merged by storybook for each story.
+Also you could define parameters on `global`, `kind` or `story` levels. All these parameters are deeply merged by Storybook for each story. But bear in mind when you define skip option as an array Storybook treats it as primitive value and doesn't merge with other skip options.
+
+```tsx
+// .storybook/preview.tsx
+export const parameters = {
+  creevey: {
+    // Skip all *hover tests in IE11 on the global level
+    skip: {
+      ie11: { in: 'ie11', tests: /.*hover$/ },
+    },
+  },
+};
+```
 
 ```tsx
 import React from 'react';
@@ -126,12 +138,12 @@ export default {
     creevey: {
       // You could skip some browsers/stories or even specific tests
       skip: [
-        { in: 'ie11', reason: '`MyComponent` do not support IE11' },
-        { in: 'firefox', stories: 'Loading' },
+        { in: 'ie11', reason: "`MyComponent` doesn't support ie11" },
+        { in: 'firefox', stories: 'Loading', reason: "Loading stories are flaky in firefox" },
         {
           in: ['firefox', 'chrome'],
           tests: /.*hover$/,
-          reason: 'For some reason `MyComponent` hovering do not work correctly',
+          reason: "For some reason `MyComponent` hovering doesn't work correctly",
         },
       ],
     },
@@ -155,6 +167,18 @@ Basic.parameters = {
 
 ### `skip` option examples:
 
+```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[]>;
+```
+
 - Skip all stories for all browsers:
   - `skip: true`
   - `skip: 'Skip reason message'`
@@ -175,6 +199,14 @@ Basic.parameters = {
   - `skip: { tests: 'click' }`
   - `skip: { tests: ['hover', 'click'] }`
   - `skip: { tests: /^press.*$/ }`
-- Multiple skip options: `skip: [{ /* ... */ }]`
+- Multiple skip options:
+  - as an array `skip: [{ /* ... */ }]`
+  - as an object
+    ```
+    skip: {
+      foo: { /* ... */ },
+      bar: { /* ... */ },
+    }
+    ```
 
 NOTE: If you try to skip stories by story name, the storybook name format will be used (For more info see [storybook-export-vs-name-handling](https://storybook.js.org/docs/formats/component-story-format/#storybook-export-vs-name-handling))

package/docs/grid.md

@@ -1,7 +1,8 @@
 ## Use your Selenium Grid (BrowserStack/SauceLabs/etc)
 
-Sometimes you already have Selenium Grid on one of many different e2e testing services, like BrowserStack or SauceLabs , or use self-hosted one. You could use these services. If your Selenium Grid located in same network where you going to start Creevey, you will need to define `gridUrl` parameter in Creevey config. Overwise you need to start tunneling tool depends of what Grid you use:
+Sometimes you already have Selenium Grid on one of many different e2e testing services, like LambdaTest, BrowserStack, or SauceLabs , or use a self-hosted one. You could use these services. If your Selenium Grid is located in the same network where you going to start Creevey, you will need to define `gridUrl` parameter in Creevey config. Overwise you need to start tunneling tool depending on what Grid you use:
 
+- [LambdaTest] (https://www.npmjs.com/package/@lambdatest/node-tunnel)
 - [browserstack-local](https://www.npmjs.com/package/browserstack-local)
 - [sauce-connect-launcher](https://www.npmjs.com/package/sauce-connect-launcher)
 - [open-ssh-tunnel](https://www.npmjs.com/package/open-ssh-tunnel)

package/jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  moduleNameMapper: {
+    '#(.*)': '<rootDir>/node_modules/$1',
+  },
+  transformIgnorePatterns: [],
+};