https://github.com/studiohyperdrive/tools
A monorepo containing several general purpose utility libraries that are published to npm.
https://github.com/studiohyperdrive/tools
Last synced: about 2 months ago
JSON representation
A monorepo containing several general purpose utility libraries that are published to npm.
- Host: GitHub
- URL: https://github.com/studiohyperdrive/tools
- Owner: studiohyperdrive
- License: mit
- Created: 2023-08-10T07:17:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T11:08:48.000Z (almost 2 years ago)
- Last Synced: 2024-04-28T10:42:28.681Z (almost 2 years ago)
- Language: TypeScript
- Size: 291 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Studio Hyperdrive: Tools (_tools_)
> [!IMPORTANT]
> This repository has been archived as of January 2025, but the package is still being maintained. It has been moved to a new monorepo [here (hyperdrive-opensource)](https://github.com/studiohyperdrive/hyperdrive-opensource). Issues, Pull Requests, and Discussions can be opened there and will be followed up by the same core team that maintained this repo.
>
> The guides below are deprecated and do not guarantee proper functionality. The most up-to-date documentation of this repository can be found in [the documentation](https://open-source.studiohyperdrive.be/docs).
## General
This repo contains general usage libraries for shd Angular projects. Those libraries are:
- testing (`@studiohyperdrive/testing`) :
- testing utilities
- utils (`@studiohyperdrive/utils`) :
- general purpose utilities
- rxjs-utils (`@studiohyperdrive/rxjs-utils`):
- general purpose utilities (operators, ...)
You can find detailed explanations in their respective README’s.
It is build with:
- nodejs: `18.14.0`
- npm: `9.3.1`
For a complete list of packages and version check out the `package.json` file.
### Clone and install dependencies
To setup this project, clone the repo and run `npm i` to install the dependencies.
### NPM
The available command are:
| command | runs |
|---------------------|---------------------------------|
| lint:rxjs-utils | runs `nx lint rxjs-utils` |
| lint:rxjs-utils:fix | runs `nx lint rxjs-utils --fix` |
| test:rxjs-utils | runs `nx test rxjs-utils` |
| build:rxjs-utils | runs `nx build rxjs-utils` |
| lint:utils": | runs `nx lint utils` |
| lint:utils:fix | runs `nx lint utils --fix` |
| test:utils": | runs `nx test utils` |
| build:utils": | runs `nx build utils` |
## Contribute
### Add a new library
To add a new library, consult the Nx documentation:
https://nx.dev/packages/js/generators/library#@nx/js:library
When adding a playground for your lib, also make sure the project has at least one test or provide a placeholder.
### Publish
The libraries in this project can be published to the npm registry. To do so follow these steps:
1. In the library that you want to publish, bump the version in package & package-lock files.
2. Commit the changes using the following convention: `build(): v1.0.0`.
3. Add a tag using the following convention: `@studiohyperdrive/@v1.0.0`.
4. Make a new production build of your library using `npm run build:`.
5. Move to the dist folder of your library using `cd dist/`
6. Publish the package using `npm publish`
a. If this is the first time publishing the library make sure to add the `--access public` flag.
b. Make sure you are logged into npm and that you have been added to the @studiohyperdrive organisation.
## Team
This bundle of tools has been created and is maintained by [Studio Hyperdrive](https://studiohyperdrive.be).
Contributors:
- [Denis Valcke](https://github.com/DenisValcke)
- [Iben Van de Veire](https://github.com/IbenTesara)
- [Wouter Heirstrate](https://github.com/WHeirstrate)