Developer Guide

Developer Guide

Prerequisites:

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

Preparation:

• Clone IB API code repository: git clone https://github.com/stoqey/ib.git
• Navigate to checkout folder: cd ib
• Checkout Public Documentation sub-module: git submodule update --init
• Install dependencies: npm install

Build commands

• Build the library code to /dist folder: npm run build or Shift+Ctrl+B in VSCode

• Run ESLint on the library code: npm run lint

• Run the library test code: npm test or F5 in VSCode

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

• Create public API documentation to /pages/ib-doc folder (this is a submodule!): npm run doc

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

Debugging

• Go to root folder and run code .
• Implement your test code on a *.spec.ts file and add debug breakpoints as needed.
• Press F5 to run all test files (*.spec.ts) on mocha-runner, with attached the VSCode debugger.

Development Workflow

• Create a development branch.
• Implement and test your changes.
• Run npm run release successfully
• If content on pages\ib-doc submodule has been changed, commit the changes and push it.
• Commit and push changes on your development branch.
• Create a Pull-Request to master.