TypeScript learning in TDD
Description
This project has as scope an experimental learning of TypeScript in TDD with Jest framework
Getting Started
The following instructions will allow you to set the project up from scratch.
System requirements
Nodejs
This project needs NPM scripts and NodeJs installed on your local machine.
Commands
Command-line interface
To install the dependencies
npm install
To run the test suite
npm test
NPM Package publish
You can publish the current package on the NPM registry. To do this you need to configure on your account a proper access token then run
cp {.env.dist,.env}
At this point you should have a proper .env file you just need to add your token instead of THIS_IS_A_SUPER_SECRET
NPM_TOKEN=THIS_IS_A_SUPER_SECRET
Assuming you have generated a new semantic release version of the package (ie. the version in the package.json has been changed) you can now publish it, first try in a dry run mode
source scripts/setenv.sh && npm publish --access=public --dry-run
Then publish it
source scripts/setenv.sh && npm publish --access=public
Git commit message convention
This projects follows the conventional commits.
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
Example:
docs: add description of TypeScript run command
Type | Description |
---|---|
style |
Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
build |
Changes to the build process |
chore |
Changes to the build process or auxiliary tools and libraries such as documentation generation |
docs |
Documentation updates |
feat |
New features |
fix |
Bug fixes |
refactor |
Code refactoring |
test |
Adding missing tests |
perf |
A code change that improves performance |