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

@pulsex/jest-environment-hardhat

v1.0.0

Published

A jest environment with hardhat built in

Downloads

3

Readme

jest-environment-hardhat

npm Tests Lint

A jest environment with hardhat built in.

jest-environment-hardhat is a drop-in jest environment for running hardhat inline with your tests. Instead of running a separate hardhat node, this environment runs a node and exposes a global Hardhat interface - with some helper utilities - to interact with it.

Installation

First, install jest-environment-hardhat and its dependencies (using yarn or npm).

The environment needs @nomiclabs/hardhat-ethers, ethers, and hardhat installed as well. These are installed as peer dependencies to ensure that you retain control over versioning, so you'll need to install them explicitly:

yarn add -D @nomiclabs/hardhat-ethers ethers hardhat
yarn add -D jest-environment-hardhat

Then, set up your hardhat.config.js file. You'll need to require @nomiclabs/hardhat-ethers from your hardhat.config.js file in order to install it as a hardhat plugin. You'll also need to configure mainnet forking to set the initial state of the hardhat network within jest.

NOTE: You should set the accounts field to include as few accounts as possible to reduce startup time for your tests' hardhat network.

Then, use the runner either using a doc-comment, or using jest configuration (see the jest documentation for details):

/**
 * @jest-environment hardhat
 */

test('use hardhat in this test file', () => {
  expect(hardhat).toBeDefined()
})

jest-environment-hardhat extends a node environment by default. A jsdom environment is also available, using hardhat/jsdom.

/**
 * @jest-environment hardhat/jsdom
 */

test('use hardhat and jsdom in this test file', () => {
  expect(hardhat).toBeDefined()
  const element = document.createElement('div')
  expect(element).not.toBeNull()
})

Subclassing your own runner

jest-environment-hardhat subclasses a node environment by default, and exports a jsdom environment under hardhat/jsdom.

If you'd like to extend your own environment, you can use the setup function exported by jest-environment-hardhat/setup. See src/node.ts for an example.

Documentation

Using the environment will expose hardhat on the global scope, which you can use to interact with the hardhat network in your tests.

For documentation on the hardhat global, see the type declarations.

For examples of how to interact with the hardhat network, see the tests.

Typescript

If you are using Typescript, import types by importing the library in your test or setup file:

/**
 * @jest-environment hardhat
 */

import 'jest-environment-hardat'

test('use hardhat in this test file', () => {
  expect(hardhat).toBeDefined()
})

Made with 🦄 by Uniswap Labs