@origyn/borscht

BORSCHT

a tool for testing DFINITY project

| Scripts | Options | Usage | Commands |

Scripts:

• test: running build tests
• build: assembling a minified build
• format: format the code with Prettier
• lint: pass the code through the linter

Usage: borscht [options] [command]

Options:

FLAG	DESCRIPTION
--network	host options
--host [address]	host address
-h, --help	display help
[command] -h	display help for [command]

Commands:

deploy

Command deploy defines and prepares all your canisters for work. A folder (./actors) is created in the root directory of your project in which all your future canisters are defined. For each, a file of the format [canister_name.js] will be created in which.

generate [options]

Command generate collects data from files ( dfx.json ) and ( canister_ids.json ). From which it takes and determines the ID for each individual canister. For each canister_ID in the ( ./candid ) folder, two files will be created according to the template ( [canister_ID.did.dts] ) contains a description of the data types for your canister and ( [canister_ID].did.js ) contains a description of methods for working inside your canister when generating, you must define the host address that your project will refer to. To do this, you need to enter the flag --network the name of the object containing the host address in the file ( dfx.json ) in the root directory of your project. Also, configuration files for babel ( babelrc ) and jest ( jest.config.js ) are generated wasm field for canisters must be set if you want to Actor.deploy(...)

run-tests [options]

Command run-tests runs all tests in the ( ./test ) folder of your DFX project one by one. The host address can be specified in the command as an additional option. It is indicated after the keyword (--host your_host_address ) If the address is not specified, the default address will be used as the host. Upon completion, information about the status of the tests will be displayed in the console.