Rijkswaterstaat AIR Node Packages

All node packages by Rijkswaterstaat for the AIR project in one convenient location

---

Project Status

Bundle Sizes

Versions

What is this?

This is a mono-repo for all NodeJS related packages used throughout other AIR projects. This repository is managed by Lerna. Each package has its own subfolder in the packages folder, you can easily create a new package with the lerna create command.

Working with this repository

Please see Lerna and working on air-node-packages on the air-dev repo

---

To get autocompletion for Lerna follow these steps:

1. Run this:

git clone https://github.com/favware/zsh-lerna ${ZSH_CUSTOM:=~/.oh-my-zsh/custom}/plugins/zsh-lerna

2. Add zsh-lerna in your ~/.zshrc:

plugins=(… zsh-lerna)

3. Reload ~/.zshrc or reload your terminal

Running the linter

Run yarn lint from repository root

Running tests

Run yarn test from repository root

Updating snapshots for Webcomponents

To easily update failing snapshots for webcomponents run this command from repository root: yarn test:web

Creating a build

Run yarn build from repository root.
If it fails, try running yarn clean, yarn, and yarn pre-build before. This will clean up install and build files.
It is important webcomponents is build before building all others.

Publishing new versions

1. Run yarn build to ensure you're about to publish all latest versions. This repo has TypeScript code that needs to be compiled to JavaScript before it can be published!
2. Prepare a git commit for your changes. But instead of using git push to finish the commit, go to the next step using lerna publish.
3. Run lerna publish to start the publishing process. This will publish packages to NPM and commit the change to github.

If lerna publish fails

1. Go to GitHub repository -> releases: https://github.com/RWS-NL/air-node-packages/releases.
2. Delete any tags created by the publish script.
3. Delete the same tags locally: git tag -d <name_of_tag> [...<name_of_other_tag>].
4. Reset your HEAD to the commit before the publish.

• tig to find commit hash.
• git checkout <commit_hash>.

5. Remove the failed commit with git push --force.
6. Fix the issues.
7. Run yarn build to ensure your fixes fix everything.
8. Re-run the publish process as described above.

If you have the error: Could not find "packages/*/dist/index.js"`?

Run yarn pre-build. This will compile all typescript files and create dist folders.

API Documentation

Check out the docs on github pages