Install Flow Javascript Testing Framework

How to install the Flow command-line interface (CLI)

Installation

It's possible to install Flow Javacript Testing Framework manually and automatically, using generator.

Automatic Installation (via npx)

Create new folder and move into it:

1
mkdir test && cd ./test

Install @onflow/flow-js-testing

1
npm install @onflow/flow-js-testing

Generate complete setup via init call:

1
npx flow-js-testing init

Create new test suit via make call, specifying the name of the suit:

1
npx flow-js-testing make basic-test

Manual Installation

If, for some reason, you would want to do this manually here's what you need to do.

Create new folder and move into it:

1
mkdir test && cd ./test

Initiate a project in that folder with:

1
npm init

Then install all necessary packages by running following command:

1
npm install @onflow/flow-js-testing jest @babel/core @babel/preset-env babel-jest

If your project is JavaScript based, then run the above command from the folder that contains your project's package.json file.

Jest Config

You'll need to configure Jest in order for tests to work properly. Add jest.config.json file next to package.json and populate it with:

1
{
2
"testEnvironment": "node",
3
"verbose": true,
4
"coveragePathIgnorePatterns": ["/node_modules/"],
5
"testTimeout": 50000
6
}

Babel Config

Similarly, create babel.config.json then copy and paste the following configuration:

1
{
2
"presets": [
3
[
4
"@babel/preset-env",
5
{
6
"targets": {
7
"node": "current"
8
}
9
}
10
]
11
]
12
}