https://github.com/josefdolezal/mahele
Write model objects once, share them everywhere
https://github.com/josefdolezal/mahele
Last synced: about 2 months ago
JSON representation
Write model objects once, share them everywhere
- Host: GitHub
- URL: https://github.com/josefdolezal/mahele
- Owner: josefdolezal
- License: mit
- Created: 2018-05-08T10:21:36.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-17T20:03:37.000Z (almost 7 years ago)
- Last Synced: 2025-02-10T18:13:18.396Z (3 months ago)
- Language: Haskell
- Size: 26.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# What is Mahele
Mahele is a language-agnostic code generation tool for model objects.
Have your team ever had to share same model objects between multiple platforms?
You did manually, didn't you?
With mahele, you define model layer of your app in platform-agnostic meta language - and you guess it - once.
"Next step?" you ask? Just use it everywhere.
Since all parts of an app shares the very same model, you can treat it as contract.
## Example
Currently, mahele supports `type`s and `enum`s.
Simple mahele model may be created as follows:
```mahele
type User =
email: String
name: String?
role: UserRole
enum UserRole =
| Superuser as 'admin'
| User
```
For such schema, mahele will generate following model:
Swift
```swift
struct User {
var email: String
var name: String?
var role: UserRole
}
enum Role: String {
case superuser = "admin"
case user
}
```
Haskell
```haskell
data User = User
{ email :: String
, name :: Maybe String
, role :: UserRole
}
data Role = Superuser
| User
}
```
Elm
```elm
type alias User =
{ email : String
, name : Maybe String
, role : UserRole
}
type Role
= Superuser
| User
```
## Usage
Mahele is currently under development and supports only `mahele -> Swift` code conversion.
To setup the project, run:
1. cd `mahele-cli`
2. `stack build`
You can use Mahele CLI to generate Swift source files using following command in `mahele-cli` directory:
```sh
stack build && stack exec mahele-cli --
```
In progress
Mahele is primarly distributed as a CLI tool.
To create the model, you have two options:
- Download the schema from internet:
```bash
$ curl -L https://myre.po/schema.mahele | mahele
```
- Use pre-downloaded local schema:
```bash
$ mahele create myschema.mahele
```
Whenever possible, use the first option - this will help you to use latest schema on all platforms.
### Web interface
Want to give it a try before deploying mahele models into production?
You are not sure if mahele can handle your schema? No problemo!
There is an online version which you can try directly from your browser. Visit [mahele.online](mahele.online) and play around with your schema.
## Installation
Installation guide
Not available yet! :sad: