An implementation of the [BENNC](https://wiki.jacknet.io/books/simontech/chapter/bennc) client specification.
## Build
To build the BENNC-JS library, first clone this repository.
Run the following commands from the root of the repository:
```bash
$ npm install
$ npm run build
```
The build output will be saved to the `dist` directory.
## Development instructions
Requirements:
- The latest LTS builds of Node and npm.
Follow the instructions below to lint, test and build BENNC-JS.
#### Lint
```bash
$ npm install
$ npm run lint
```
#### Test
```bash
$ npm install
$ npm run test
```
#### Build
```bash
$ npm install
$ npm run build
```
### Visual Studio Code
This repository contains the necessary configuration files to debug, test and build BENNC-JS using only Visual Studio Code.
Run the build task (`Ctrl+Shift+B` or `⇧⌘B`) to automatically compile the Typescript source files in the background.
Unit tests use the [Jest](https://jestjs.io/) library. Support for Visual Studio Code is offered through the [Jest marketplace package](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest) maintained by Orta.
This library uses [ts-standard](https://github.com/standard/ts-standard), based on [JavaScript Standard Style](https://standardjs.com/rules.html). Please ensure all contributions are ts-standard compliant before submitting a pull request.