Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rstraub/reporting-breakable-toy
Breakable toy to prove a reporting concept on ETL pipelines
https://github.com/rstraub/reporting-breakable-toy
Last synced: about 2 months ago
JSON representation
Breakable toy to prove a reporting concept on ETL pipelines
- Host: GitHub
- URL: https://github.com/rstraub/reporting-breakable-toy
- Owner: rstraub
- Created: 2023-10-20T14:08:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-30T09:23:36.000Z (about 1 year ago)
- Last Synced: 2023-10-30T10:26:46.391Z (about 1 year ago)
- Language: Shell
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Scala Kata Base
[](https://github.com/rstraub/scala-kata-base/actions/workflows/scala.yml)
[](https://scala-steward.org)
Starter project for Code Katas in Scala. Batteries included.
Included:
* [Sbt](https://www.scala-sbt.org/) (build tool)
* [Sbt Extras](https://github.com/dwijnand/sbt-extras) (wrapper script)
* [Scalatest](https://www.scalatest.org/) (testing library)
* [ScalaCheck](https://www.scalatest.org/plus/scalacheck) (property-based testing library)
* [scoverage](https://github.com/scoverage) (code coverage)
* [Mockito](https://www.scalatest.org/plus/mockito) (mocking library)
* [Cats](https://typelevel.org/cats/) (functional programming library)
* [Scalafmt](https://scalameta.org/scalafmt/) (code formatting)
* [Scalafix](https://scalacenter.github.io/scalafix/) (refactoring and linting)
* [Scala Steward](https://github.com/scala-steward-org/scala-steward) (automatic dependency updates)
* CI using [Github Actions](https://github.com/features/actions)
* Fast feedback using git hooks (pre-commit, pre-push)
## Installation
This project requires a JDK on your machine, as described in the `.sdkmanrc`. If you use sdkman `cd` into the
root of this project and run:
```shell
sdk env install
```
to install it. You can also install them yourself.
The build tool (Sbt) and Scala are installed automatically by the wrapper script located at `./sbtx`.
It will grab the correct versions based off the project configuration.
## Compile
```shell
./sbtx compile
```
## Tests
Run tests once:
```shell
./sbtx test
```
Or in watch mode:
```shell
./sbtx ~test
```
## Formatting
```shell
./sbtx scalafmtAll
```
```shell
./sbtx scalafixAll
```
## Code Coverage
For generating a code coverage report run:
```shell
./sbtx clean coverage test coverageReport
```
Which generates a report in `target/scala-2.13/scoverage-report`.
## Git Hooks
To install the git hooks run:
```shell
./hooks/install
```
## IDE
If you're using Intellij, make sure you have the [Scala plugin](https://plugins.jetbrains.com/plugin/1347-scala)
installed.