Git Product home page Git Product logo

teash's Introduction

TEASH

TEA for the shell, in OCaml.

Description

Teash is an interpretation of TEA for the shell, using Lwt and Notty to gain async and terminal rendering capabilities. Use it to build interactive terminal programs that are mostly event driven and organized according to a Model -> Update -> View pattern. Then compile them to either bytecode or native binaries.

Most of the inspiration for this library comes from the excellent bucklescript-tea project.

Installation

opam install teash

Getting started

Make sure to add a reference to the teash library to your build.

A simple Hello world program might look like this:

(* bring Teash into scope *)
open Teash

(* a type to define possible messages/events in the program *)
type msg =
	| Key of Notty.Unescape.key (* this will hold key presses *)

(* initialize the model *)
let init () = ()

(* the central message/event handler *)
let update model = function
	| Key (`Escape, _mods) -> model, App.exit (* listen for ESC and exit *)
	| Key _ -> model, Cmd.none

(* the view is just a function that returns a Notty.image given the model *)
let view _model =
	Notty.(I.string A.(fg red) "Hello World!")

(* hookup subscription to events *)
let subscriptions _model =
	Keyboard.presses (fun key -> Key key) (* subscribe to key presses and map to our msg type *)

(* "main" *)
let () =
	App.run {
		init;
		update;
		view;
		subscriptions;
		shutdown = (fun _model -> ());
	} ()

For further details have a look at the examples.

teash's People

Contributors

neochrome avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

teash's Issues

compilation fails

$ git log --oneline
eb71e68 (HEAD -> master, origin/master, origin/HEAD) Upgrade to opam v2.0
27945c6 Add annotation to ensure tail recursive call
2dc8992 Add Cmd/Sub map functionality to support modules
4b9ef2a Add support for multiple subscriptions of same type
c59b9e8 Ignore opam prepare folders
9eb2615 Remove install section from opam file
e5db904 (tag: 0.1.0) Relax contraints on dependencies
467af46 Downgrade to opam v1.2
b2ee1e0 Initial version
$ git status
On branch master
Your branch is up to date with 'origin/master'.

nothing to commit, working tree clean
$ make
dune build
File "src/sub.ml", line 20, characters 11-25:
20 | module M = Misc.StringMap
                ^^^^^^^^^^^^^^
Error: Unbound module Misc.StringMap
make: *** [Makefile:6: build] Error 1
$ 

Widget support

Instead of having to manage keypresses "centrally" in the update function it would be nice to have textboxes/areas for input and buttons etc available as a higher level of abstraction.

It would be nice if such an abstraction could exist side by side with the current low-level interface.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.