ezyVet Javascript Helper Library Documentation

ezyVet Javascript Helper Library

Development

Rules

All files should be in Typescript format
Each component must have a test file associated inside a folder tests and the filename should follow the pattern **.test.js

Git Hooks

pre-commit: Every time that a commit is requested, this will run the eslint rules and the tests, it will prevent the commit if one of the tests fails or one of the ESLint rules fails.

Deploy

IMPORTANT: Update the CHANGELOG before increasing the version.
We used tagged versions for production, so we know which version to include in each project
```
npm version {NEW_VERSION}
git push
git push --tags
```

{NEW_VERSION} has to follow the semantic versioning: e.g. 1.0.0.

We follow the Semantic Versioning

Check the package.json or the GitLab Tags to know what's the next version.

Usage

Just include this repository as a dependency in your project.

"ezyvet-fe-helpers": "git+ssh://git@git.ezyvet.com/ezyvet/dependencies/fe-helpers.git#{VERSION_NUMBER}"

Where {VERSION_NUMBER} is the version to use (e.g. v0.0.5).

NOTE: if you already have the dependency in place and just want to update the version, change the {VERSION_NUMBER} to the one that you want and run

```
npm update ezyvet-fe-helpers
```

This project requires at least one test case for each file. Tests should cover scenarios not lines of code, following best practices. The minimum statement test coverage per file is 75%. Please discuss with Sublime Team if you want to adjust this number.