npm package: @ii887522/hydro
Description: It is a general purpose JavaScript/TypeScript library that can help developers create various kinds of applications in no time.
Author: ii887522
Latest version: 4.1.0

# hydro
[![Semantic Versioning 2.0.0](https://img.shields.io/badge/semver-2.0.0-standard.svg)](https://semver.org/)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![Linux](https://svgshare.com/i/Zhy.svg)](https://svgshare.com/i/Zhy.svg)
[![Windows](https://svgshare.com/i/ZhY.svg)](https://svgshare.com/i/ZhY.svg)
[![made-with-javascript](https://img.shields.io/badge/Made%20with-JavaScript-ffff00.svg)](https://www.javascript.com)
[![made-with-typescript](https://img.shields.io/badge/Made%20with-TypeScript-0000e0.svg)](https://www.typescriptlang.org/)
[![Npm package version](https://badgen.net/npm/v/@ii887522/hydro)](https://www.npmjs.com/package/@ii887522/hydro)
[![Npm package daily downloads](https://badgen.net/npm/dm/@ii887522/hydro)](https://npmjs.com/package/@ii887522/hydro)
[![Npm package license](https://badgen.net/npm/license/@ii887522/hydro)](https://npmjs.com/package/@ii887522/hydro)
[![Npm package dependents](https://badgen.net/npm/dependents/@ii887522/hydro)](https://npmjs.com/package/@ii887522/hydro)

It is a general purpose JavaScript/TypeScript library that can help developers create various kinds of applications in no time.

## Table of contents
- [Coding style](https://github.com/ii887522/hydro#coding-style)
- [Prerequisites](https://github.com/ii887522/hydro#prerequisites)
- [Install dependencies](https://github.com/ii887522/hydro#install-dependencies)
- [Lint the project](https://github.com/ii887522/hydro#lint-the-project)
- [Build the project](https://github.com/ii887522/hydro#build-the-project)
- [Automatically build the project on change](https://github.com/ii887522/hydro#automatically-build-the-project-on-change)
- [Test the project with code coverage analysis](https://github.com/ii887522/hydro#test-the-project-with-code-coverage-analysis)
- [Automatically test the project with code coverage analysis on change](https://github.com/ii887522/hydro#automatically-test-the-project-with-code-coverage-analysis-on-change)

## Coding style
This project follows [Javascript Standard Style](https://standardjs.com/). Please familiarize yourself with the rules provided in the coding style and make sure all the proposed code changes in your commits are conforming to the style before making a merge request. You can also make use of StandardJS - Javascript Standard Style which is a [Visual Studio Code](https://code.visualstudio.com/) plugin and `npm run lint` command under the [Lint the project](https://github.com/ii887522/hydro#lint-the-project) section to support you.

## Prerequisites
- Windows 11 or Linux
- [Visual Studio Code](https://code.visualstudio.com/) with plugins:
  - EditorConfig for VS Code
  - Markdown All in One
  - StandardJS - Javascript Standard Style
  - YAML
- [Node.js 16.14.2](https://nodejs.org/en/) and later

## Install dependencies
```sh
npm install
```

## Lint the project
```sh
npm run lint
```

## Build the project
```sh
npm run build
```

## Automatically build the project on change
```sh
npm run build:watch
```

## Test the project with code coverage analysis
```sh
npm test
```

## Automatically test the project with code coverage analysis on change
```sh
npm run test:watch
```