@atelier-wb/toolshot

Atelier - Jest Toolshot

Weclome to the Atelier!

Toolshot allows you to make snapshots of your components as part of your Jest test suite.

---

• Getting started
• Configuration API

---

Getting started

You'll need first to write some "tools" files for your UI components.

Please refer to your UI framework binding API:

• for svelte

Then, assuming you already installed Jest and configured it to support your favorite UI framework:

1. create a test file (atelier.test.js for example) _in the same folder as your *.tools.* files:

   import { configureToolshot } from '@atelier-wb/toolshot'
   
   configureToolshot()

2. run jest... it'll create a snapshot for each of your tools.

These snapshots work the same way as regular Jest snapshots.

---

Configuration API

The atelier plugin function takes the following settings:

• folder (detaults to .): root folder under which toolshot will search for *.tools.* files.

• include (defaults to /\.tools(?!\.shot$).+$/, any files endinf with .tools. but .tools.shot): the regular expression used to find your tool files.

• snapshotFolder (defaults to __snapshots__): name of the folder storing the snapshot files.

• suite (defaults to Toolshot): name used in Jest report

• timeout (default to 5000): timeout, in milliseconds, for each individual tool.

For example:

configureToolshot({
  folder: join(__dirname, '..'),
  include: '^((?!Dialogue|SystemNotifier).)*\\.tools\\.svelte$',
  timeout: 10e3
})