The ts-configurable repository is managed using an Nx workspace.
Run all tests for the ts-configurable library:
$ npm run test ts-configurable
Run the example-webserver application:
$ npm run start example-webserver
The recommended IDE for developing is Visual Studio Code (VSCode). The following extensions can be helpful:
A development environment can be created using docker and docker-compose:
$ ./start-dev-container.sh
All dependencies have to be initially installed using npm:
$ npm install
As the ts-configurable package is small in size yet its correct behavior is critical for the applications depending on it, a 100% test coverage is enforced. This means that all contributed source code needs to be tested with a 100% code coverage before being accepted into the main branch. Reasonable exceptions can be discussed and added to the Jest coverage configuration.
A new version of the ts-configurable package can be published to npm like this:
$ npm run pack:lib
$ cd dist/libs/ts-configurable/src
$ npm publish