Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rws-nl/air-node-packages
Node packages used in AIRBIM projects for Rijkswaterstaat (Directorate-General for Public Works and Water Management)
https://github.com/rws-nl/air-node-packages
Last synced: 2 months ago
JSON representation
Node packages used in AIRBIM projects for Rijkswaterstaat (Directorate-General for Public Works and Water Management)
- Host: GitHub
- URL: https://github.com/rws-nl/air-node-packages
- Owner: RWS-NL
- License: apache-2.0
- Created: 2019-04-10T10:25:47.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T12:15:50.000Z (5 months ago)
- Last Synced: 2024-10-17T11:29:35.351Z (3 months ago)
- Language: TypeScript
- Homepage: https://rws-nl.github.io/air-node-packages/
- Size: 19.8 MB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 96
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Rijkswaterstaat AIR Node Packages
All node packages by Rijkswaterstaat for the AIR project in one convenient location
---
**Project Status**
[](https://github.com/RWS-NL/air-node-packages/blob/master/LICENSE.md)
**Bundle Sizes**
[](https://bundlephobia.com/result?p=@rws-air/stylelint-config)
[](https://bundlephobia.com/result?p=@rws-air/stylelint-config)
[](https://bundlephobia.com/result?p=@rws-air/tslint-config)
[](https://bundlephobia.com/result?p=@rws-air/tslint-config)
[](https://bundlephobia.com/result?p=@rws-air/usercreator)
[](https://bundlephobia.com/result?p=@rws-air/usercreator)
[](https://bundlephobia.com/result?p=@rws-air/webcomponents)
[](https://bundlephobia.com/result?p=@rws-air/webcomponents)
[](https://bundlephobia.com/result?p=@rws-air/utils)
[](https://bundlephobia.com/result?p=@rws-air/utils)
[](https://bundlephobia.com/result?p=@rws-air/commitlint-config)
[](https://bundlephobia.com/result?p=@rws-air/commitlint-config)
[](https://bundlephobia.com/result?p=@rws-air/commitizen-config)
[](https://bundlephobia.com/result?p=@rws-air/commitizen-config)
**Versions**
[](https://www.npmjs.com/package/@rws-air/stylelint-config)
[](https://www.npmjs.com/package/@rws-air/tslint-config)
[](https://www.npmjs.com/package/@rws-air/usercreator)
[](https://www.npmjs.com/package/@rws-air/webcomponents)
[](https://www.npmjs.com/package/@rws-air/utils)
[](https://www.npmjs.com/package/@rws-air/commitlint-config)
[](https://www.npmjs.com/package/@rws-air/commitizen-config)
## What is this?
This is a mono-repo for all NodeJS related packages used throughout other AIR projects. This repository is managed by [Lerna](https://github.com/lerna/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](https://github.com/RWS-NL/air-dev/blob/master/docs/Lerna_and_working_on_air-node-packages.md) on the air-dev repo
---
To get autocompletion for Lerna follow these steps:
1. Run this:
```zsh
git clone https://github.com/favware/zsh-lerna ${ZSH_CUSTOM:=~/.oh-my-zsh/custom}/plugins/zsh-lerna
```
2. Add `zsh-lerna` in your `~/.zshrc`:
```zsh
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 [...]`.
4. Reset your HEAD to the commit before the publish.
- `tig` to find commit hash.
- `git checkout `.
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](https://rws-nl.github.io/air-node-packages/)