https://github.com/heusalagroup/test
Tests for our libraries
https://github.com/heusalagroup/test
Last synced: 7 months ago
JSON representation
Tests for our libraries
- Host: GitHub
- URL: https://github.com/heusalagroup/test
- Owner: heusalagroup
- License: mit
- Created: 2021-07-31T12:59:39.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-12T13:14:37.000Z (almost 2 years ago)
- Last Synced: 2025-02-02T10:16:30.475Z (8 months ago)
- Language: Shell
- Size: 325 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
**Join our [Discord](https://discord.gg/UBTrHxA78f) to discuss about our software!**
# @heusalagroup/test
This is a unit test environment for our TypeScript libraries.
Our own projects usually require very few dependencies. Adding all testing tools
would add over 300 dependencies to our projects, which can be burdensome.
Instead, we have created this separate testing environment to keep our projects
lightweight while still providing a comprehensive testing environment.
This separation also makes it easier to run newer tests against older versions
of the project to test backwards compatibility.
## Working on the Development Environment
### Fetching the Source Code
To get started, clone the repository and initialize the submodules:
```bash
git clone git@github.com:heusalagroup/test.git test
cd test
git submodule update --init --recursive
```
### Updating the Source Code Modules
Next, install the necessary dependencies:
```bash
npm install
```
### Clearing the Cache
There may be instances where you need to clear the cache, such as when you
encounter errors about non-existent files. To clear the cache, run the following
command:
```bash
npm run clear
```
This will remove any cached files and allow you to start fresh. Note that this
may cause some tasks to take longer to run the next time they are executed, as
the system will need to rebuild the cache from scratch.
### Updating source code modules
To update the source code modules to the latest version, run:
```bash
./scripts/pull-all.sh
```
## Libraries
| Repository | Summary |
|------------------------------------------------------------------------------------|------------------------|
| [@heusalagroup/fi.hg.core](https://github.com/heusalagroup/fi.hg.core) | The core library |
| [@heusalagroup/fi.hg.node](https://github.com/heusalagroup/fi.hg.node) | The node library |
| [@heusalagroup/fi.hg.backend](https://github.com/heusalagroup/fi.hg.backend) | The backend library |
| [@heusalagroup/fi.hg.frontend](https://github.com/heusalagroup/fi.hg.frontend) | The frontend library |
| [@heusalagroup/fi.hg.repository](https://github.com/heusalagroup/fi.hg.repository) | The Repository library |
| [@heusalagroup/fi.hg.pipeline](https://github.com/heusalagroup/fi.hg.pipeline) | The pipeline processor |
| [@heusalagroup/fi.hg.matrix](https://github.com/heusalagroup/fi.hg.matrix) | The Matrix library |
## Running Tests
To run the tests once:
```
npm run test:ci
```
While developing code, you can use the following command to continuously run
tests as you make changes:
```
npm test
```
## Development with GitHub Using SSH
To use SSH when working with submodules in this repository, you will need to
configure your Git settings as follows:
```
git config --global url."git@github.com:heusalagroup/".insteadOf "https://github.com/heusalagroup/"
```
This configuration is necessary because the repository uses HTTPS links for
read-only access. However, you may prefer to use SSH when pushing and pulling
changes.
## License
Copyright (c) Heusala Group. All rights reserved. Licensed under the MIT License
(the "[License](./LICENSE)");