A script for monitoring the status of blockscout features that Valora depends on.
Intended for cLabs to be able to deploy as a cloud function that could be used for automated health checks and alerting.
- TypeScript
- Unit testing with Jest
- Linting with ESLint, configured with @valora/eslint-config-typescript
- Automatic code formating with Prettier, configured with @valora/prettier-config
- Scripts using ShellJS
- Linted and statically checked with TypeScript
- CI/CD with GitHub Actions
- Semantic PR title enforcement with semantic-pull-request
- Automated dependency updates with Renovate, configured with valora-inc/renovate-config
This project uses TypeScript. It's recommended to get TypeScript set up for your editor to get a really great in-editor experience with type checking and auto-complete. To run type checking across the whole project, run yarn typecheck.
For lower level tests of utilities and individual modules, we use Jest.
This project uses ESLint for linting. That is configured in .eslintrc.js.
We use Prettier for auto-formatting. It's recommended to install an editor plugin (like the VSCode Prettier plugin) to get auto-formatting on save. There's also a yarn format script you can run to format all files in the project.
This project uses depcheck for checking dependency use. It's configured in .depcheckrc.
We use TypeScript instead of shell scripts. This is it to avoid the many pitfalls of shell scripts.
To run external commands we recommend using ShellJS.
Renovate ensures our dependencies are kept up to date. It's configured with our shared config in renovate.json5.