embarklabs
/
embark
mirror of https://github.com/embarklabs/embark.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add API docs for scripts-runner

Pascal Precht 2020-02-06 12:41:01 +01:00
parent 479be3e6fb
commit 5e00906d68
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
API-Documentation.md

@ -47,6 +47,7 @@
* profiler
* rpc-manager
* scaffolding
* [scripts-runner](#scripts-runner)
* snark
* solc
* solidity-tests
@ -523,6 +524,18 @@ module type: plugin component
* `deployment:deployContracts:afterAll` - to associate contract addresses to ens domain
* `deployment:contract:beforeDeploy` - to replace contract arguments if they have ens domains with the associated adddress
### scripts-runner
Plugins to execute (migration) scripts inside Embark projects.
#### Requests
**name**: `scripts-runner:execute`
**description**: Takes a path to a file or directory and tries to run the script(s) that the path is pointing to. If a path to a directory is given, all files inside of that directory are considered script files.
**params**:
* `target: string` - Path to script file or directory containing scripts.
* `forceTacking: boolean` - Flag to enforce tracking of scripts to be executed. By default, scripts-runner only track scripts that live inside a configured migrations directory.
### graph
module type: plugin