Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uesteibar/minerva
Elixir framework for easily writing koans.
https://github.com/uesteibar/minerva
elixir elixir-lang elixir-library framework koans
Last synced: 3 months ago
JSON representation
Elixir framework for easily writing koans.
- Host: GitHub
- URL: https://github.com/uesteibar/minerva
- Owner: uesteibar
- License: mit
- Created: 2017-07-06T22:25:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-07-09T14:15:04.000Z (over 7 years ago)
- Last Synced: 2024-10-12T13:10:43.597Z (3 months ago)
- Topics: elixir, elixir-lang, elixir-library, framework, koans
- Language: Elixir
- Homepage: https://hex.pm/packages/minerva
- Size: 35.2 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Minerva
[](https://hex.pm/packages/minerva)
Minerva is a framework for [Elixir](http://elixir-lang.org/) that will allow you to easily write koans.
With very little setup, it will allow you to write koans in plain elixir and run them automagically every time the user modifies the file.
The DSL is inspired in [elixir-koans](https://github.com/elixirkoans/elixir-koans). Thanks!
## Index
- [Installation](#installation)
- [Usage](#usage)
- [Running Locally](#running-locally)
- [Contributing](#contributing)
## Installation
Add `minerva` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:minerva, "~> 0.2.5"}]
end
```
## Usage
Add it to your supervision tree, passing a list of your koan modules as argument.
In your `application.ex` file (If you're in a supervised project):
```elixir
def start(_type, _args) do
import Supervisor.Spec, warn: false
children = [
worker(Minerva, [[MyApp.AwesomeKoan]]),
]
opts = [strategy: :one_for_one, name: MyApp.Supervisor]
Supervisor.start_link(children, opts)
end
```
Or you can just start up the server with:
```elixir
Minerva.start_link([MyApp.AwesomeKoan])
```
In your `config.exs` file, let `minerva` know where your koans live:
```elixir
config :minerva, files: "lib/my_app/koans"
```
Now you can start writing *koans*:
```elixir
defmodule MyApp.AwesomeKoan do
use Minerva.Koans
koan "You can use variables" do
var = ___
assert 1 == var
end
koan "You can add numbers" do
assert 1 + 3 == ___
end
end
```
See that `___` represents a gap the user should fill to make the koan pass.
You can now run your project with
```
mix run --no-halt
```
You'll see something like:
```
Welcome to the koan!
######################
The exercises are found somewhere under lib/my_app/koans.
Just fill the gaps (anywhere you see ___, that's a gap),
save the file and come back here!
Module: AwesomeKoan
Koan: You can compare variables
var = ___
assert(1 == var)
Meditate a little bit and try again =)
```
Time to go to your editor and start filling the gaps!
The code will be reloaded and the koans will run every time you save a koan file.
Enjoy!
Documentation can be found on [HexDocs](https://hexdocs.pm/minerva).
## Running locally
Clone the repository
```bash
git clone [email protected]:uesteibar/minerva.git
```
Install dependencies
```bash
cd minerva && mix deps.get
```
To run the tests
```bash
mix test
```
To run the lint
```elixir
mix credo
```
## Contributing
Pull requests are always welcome =)
The project uses [standard-changelog](https://github.com/conventional-changelog/conventional-changelog) to update the [Changelog](https://github.com/uesteibar/minerva/blob/master/CHANGELOG.md) with each commit message and upgrade the package version.
For that reason every contribution should have a title and body that follows the [conventional commits standard](https://conventionalcommits.org/) conventions (e.g. `feat(runner): Make it smarter than Jarvis`).
To make this process easier, you can do the following:
Install `commitizen` and `cz-conventional-changelog` globally
```bash
npm i -g commitizen cz-conventional-changelog
```
Save `cz-conventional-changelog` as default
```bash
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
```
Instead of `git commit`, you can now run
```
git cz
```
and follow the instructions to generate the commit message.