Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 2.52 KB

README.md

File metadata and controls

47 lines (28 loc) · 2.52 KB

blockscout-status

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.

What's in the stack?

Type Checking

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.

Testing

For lower level tests of utilities and individual modules, we use Jest.

Linting

This project uses ESLint for linting. That is configured in .eslintrc.js.

Formatting

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.

Dependency Checking

This project uses depcheck for checking dependency use. It's configured in .depcheckrc.

Scripts

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

Renovate ensures our dependencies are kept up to date. It's configured with our shared config in renovate.json5.