npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@atelier-wb/toolshot

v0.12.0-beta.4

Published

Creates snapshots out of Atelier tools

Downloads

88

Readme

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

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

Please refer to your UI framework binding API:

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
})