Developer Guide

Developer Guide

Prerequisites:

• node.js (https://nodejs.org/)
• VSCode (https://code.visualstudio.com/)
• VSCode ESLint plugin (optional, but strongly recommended!) (https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

Preparation:

• Checkout code from https://github.com/stoqey/ib.git (overhaul/port-ts branch for now)
• Go to checkout folder and run npm install

Build commands

• Build the library code to /dist folder npm run build

• Run ESLint on the library code. npm run lint

• Run the library test code. npm test

• Create development (internal) documentation to /doc-dev folder npm run doc:dev

• Create public API documentation to /doc folder npm run doc

Note that the API Documentation on the github Welcome Page links to stoqey.github.io repository (not ib repository)

Make sure to update it on stoqey.github.io as well if it has changed ( https://github.com/stoqey/stoqey.github.io/tree/master/ib-doc )

TODO: add stoqey.github.io repo a submodule to ib, so that there is only 1 single place where to push/pull docu from.

• Build a full release. This includes running tests, building /dist folder and creating API documentation. npm run release

Note that the API Documentation on the github Welcome Page links to stoqey.github.io repository (not ib repository)

TODO: add stoqey.github.io repo a submodule to ib repo, so that there is only 1 single place where to push/pull docu from.

Debugging:

• Go to root folder and run code .
• Press F5 to run all test files (*.spec.ts) with mocha-runner and attached the VSCode debugger.

Rules

• When you change code or add new code, make sure npm run lint outputs 0 errors and 0 warnings.
• Before your push changes, run npm run release to verify build works, all tests succeed and documentation is updated.
• If public interfaces or public interface docu has changed, make sure to update https://github.com/stoqey/stoqey.github.io/tree/master/ib-doc as well (TODO: automate this)