Wharfkit Antelope

https://github.com/wharfkit/antelope
Admin
A JavaScript library for interacting with Antelope-powered blockchains, formerly known as EOSIO,...
Tokens:2,054
Snippets:7
Trust Score:7.1
License:BSD-3-Clause
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install @wharfkit/antelope

Source: https://github.com/wharfkit/antelope/blob/master/README.md

Installs the @wharfkit/antelope library using npm.

```javascript
npm install @wharfkit/antelope
```

--------------------------------

### Install ts-node

Source: https://github.com/wharfkit/antelope/blob/master/docs/IDE_Debug.md

Installs ts-node globally, which is required for debugging TypeScript files directly without pre-compilation.

```shell
npm install -g ts-node
```

--------------------------------

### Running Unit Tests

Source: https://github.com/wharfkit/antelope/blob/master/README.md

Commands to run the unit test suite, with or without coverage, and to run tests in a browser.

```bash
make test
```

```bash
make coverage
```

```bash
make browser-test
```

--------------------------------

### Visual Studio VS Code Launch Configuration

Source: https://github.com/wharfkit/antelope/blob/master/docs/IDE_Debug.md

Configuration for Visual Studio Code's launch.json file to set up debugging for Mocha tests with TypeScript. Includes environment variable for tsconfig path.

```json
{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "Mocha Tests",
            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
            "args": [
                "--require",
                "ts-node/register",
                "-r",
                "tsconfig-paths/register",
                "--extension",
                "ts",
                "test/**/*.ts"
            ],
            "env": {
                "TS_NODE_PROJECT": "${workspaceFolder}/tsconfig.json" 
            },
            "protocol": "inspector",
            "internalConsoleOptions": "neverOpen"
        }
    ]
}
```

--------------------------------

### Report Bug with Failing Test

Source: https://github.com/wharfkit/antelope/blob/master/README.md

Demonstrates how to run a specific bug report test using make or mocha, including instructions for mocking API requests.

```bash
grep="bug-report" make test
```

```bash
TS_NODE_PROJECT='./test/tsconfig.json' ./node_modules/.bin/mocha -u tdd -r ts-node/register -r tsconfig-paths/register --extension ts test/*.ts --grep="bug-report"
```

```bash
# For mocking API requests:
MOCK_RECORD=true <command>
MOCK_RECORD=overwrite <command>
```

--------------------------------

### Webstorm IDE Debug Configuration

Source: https://github.com/wharfkit/antelope/blob/master/docs/IDE_Debug.md

Configuration settings for Webstorm (IntelliJ) to enable debugging of TypeScript files with Mocha. Includes environment variables and Mocha options.

```APIDOC
Webstorm (IntelliJ) Debug Configuration:

1. Navigate to `Run` > `Edit Configurations`.
2. Set Environment Variables: `TS_NODE_PROJECT=./test/tsconfig.json`
3. Set User Interface: `tdd`
4. Set Mocha Options: `--require ts-node/register -r tsconfig-paths/register --extension ts`
5. Check `Store as Project File` to save configurations.
```

--------------------------------

### Dry Run Make Commands

Source: https://github.com/wharfkit/antelope/blob/master/docs/IDE_Debug.md

Executes make commands with the '-n' flag to show the commands that would be executed without actually running them. Useful for verifying configurations.

```shell
make -n test
```
Tokens:
Raw