TypeScript Projects Boilerplate

This project is a simple boilerplate to start new projects in TypeScript. It includes testing scripts, code coverage mocks and related configuration, including the integration with Travis CI. The latter, at the end of the process, increases the version, creates a new release on Github and publishes the package to NPM registry.

The project is configured to put built sources into the dist directory.

Tests can be written in TypeScript or JavaScript. The test directory contains two subfolders:

• ts: put here the test files written in Typescript, remember to import entities to test from the ../../dist dir, see test sample. Compiled TypeScript tests are kept in the test/ts directory;
• js: put here the test files written in JavaScript.

It is possible to run tests in debug mode, using the Node Inspector.

To run tests in debug mode:

1. npm run test:debug
2. Open Chrome at: chrome://inspect/#devices, and select the running node process.

See package.json to discover all the defined scripts.

---

Prerequisites

1. a Github account and a repository; put the correct repos name in the repository.url property in the package.json file.
2. a Travis CI account, with your Github repos enabled; remember to configure the tokens!
3. a Coveralls account, with your Github repository imported and enabled;
4. npm install
5. Install npm install -g semantic-release-cli and then run: semantic-release-cli setup. Follow the instructions and answer to questions to configure semantic release
6. Install [npm i -g commitizen] (https://commitizen.github.io/cz-cli/).

---

The Workflow

After you configured all the tools, you can start working to your project, edit and create new files, etc... Then, the workflow you can adopt is the following:

1. Write code and tests;
2. npm run build;
3. npm test;

OR

2. Run npm run precommit;
3. goto 1 ;)

When ready to create a new version:

4. git add <your modified files>;
5. npm run commit;
6. git push.

The latter step fires an event for Travis CI which reads the .travis.yml configuration file, builds and tests the code and if all is ok the it publishes the new version of the package.

---

License - "MIT License"

Copyright (c) 2017 Antonio Pintus

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.