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.
To setup this project, clone the repo and run npm i to install the dependencies.
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 |
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.
The libraries in this project can be published to the npm registry. To do so follow these steps:
- In the library that you want to publish, bump the version in package & package-lock files.
- Commit the changes using the following convention:
build(<library>): v1.0.0. - Add a tag using the following convention:
@studiohyperdrive/<library>@v1.0.0. - Make a new production build of your library using
npm run build:<library>. - Move to the dist folder of your library using
cd dist/<library> - Publish the package using
npm publish
a. If this is the first time publishing the library make sure to add the--access publicflag.
b. Make sure you are logged into npm and that you have been added to the @studiohyperdrive organisation.
This bundle of tools has been created and is maintained by Studio Hyperdrive.
Contributors: