diff options
| -rw-r--r-- | README.md | 40 | ||||
| -rw-r--r-- | default.nix (renamed from yants.nix) | 0 | ||||
| -rw-r--r-- | screenshots/enums.png (renamed from z-enums.png) | bin | 41305 -> 41305 bytes | |||
| -rw-r--r-- | screenshots/functions.png (renamed from z-functions.png) | bin | 32907 -> 32907 bytes | |||
| -rw-r--r-- | screenshots/nested-structs.png (renamed from z-nested-structs.png) | bin | 70264 -> 70264 bytes | |||
| -rw-r--r-- | screenshots/simple.png (renamed from z-simple.png) | bin | 43010 -> 43010 bytes | |||
| -rw-r--r-- | screenshots/structs.png (renamed from z-structs.png) | bin | 69499 -> 69499 bytes | |||
| -rw-r--r-- | tests.nix (renamed from z-yants-tests.nix) | 2 | ||||
| -rw-r--r-- | yants.md | 38 |
9 files changed, 41 insertions, 39 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000000..55ea764d8fbc --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +yants +===== + +This is a tiny type-checker for data in Nix, written in Nix. + +Features: + +* Checking of primitive types (`int`, `string` etc.) +* Checking polymorphic types (`option`, `list`, `either`) +* Defining & checking struct/record types +* Defining & matching enum types +* Defining & matching sum types +* Defining function signatures (including curried functions) +* Types are composable! `option string`! `list (either int (option float))`! +* Type errors also compose! + +Lacking: + +* Any kind of inference +* Convenient syntax for attribute-set function signatures + +## Primitives & simple polymorphism + + + +## Structs + + + +## Nested structs! + + + +## Enums! + + + +## Functions! + + diff --git a/yants.nix b/default.nix index 17564b61b91e..17564b61b91e 100644 --- a/yants.nix +++ b/default.nix diff --git a/z-enums.png b/screenshots/enums.png index 71673e7ab63c..71673e7ab63c 100644 --- a/z-enums.png +++ b/screenshots/enums.png Binary files differdiff --git a/z-functions.png b/screenshots/functions.png index 30ed50f8327b..30ed50f8327b 100644 --- a/z-functions.png +++ b/screenshots/functions.png Binary files differdiff --git a/z-nested-structs.png b/screenshots/nested-structs.png index 6b03ed65ceb7..6b03ed65ceb7 100644 --- a/z-nested-structs.png +++ b/screenshots/nested-structs.png Binary files differdiff --git a/z-simple.png b/screenshots/simple.png index 05a302cc6b9d..05a302cc6b9d 100644 --- a/z-simple.png +++ b/screenshots/simple.png Binary files differdiff --git a/z-structs.png b/screenshots/structs.png index fcbcf6415fad..fcbcf6415fad 100644 --- a/z-structs.png +++ b/screenshots/structs.png Binary files differdiff --git a/z-yants-tests.nix b/tests.nix index e1e521c5abf0..344f2c1f5934 100644 --- a/z-yants-tests.nix +++ b/tests.nix @@ -1,5 +1,5 @@ with builtins; -with (import ./yants.nix {}); +with (import ./default.nix {}); # Note: Derivations are not included in the tests below as they cause # issues with deepSeq. diff --git a/yants.md b/yants.md deleted file mode 100644 index e10e120f08b6..000000000000 --- a/yants.md +++ /dev/null @@ -1,38 +0,0 @@ -yants -===== - -This is a tiny type-checker for data in Nix, written in Nix. - -Features: - -* Checking of primitive types (`int`, `string` etc.) -* Checking polymorphic types (`option`, `list`, `either`) -* Defining & checking struct/record types -* Defining & matching enum types -* Defining function signatures (including curried functions) -* Types are composable! `option string`! `list (either int (option float))`! - -Lacking: - -* Any kind of inference (Nix's reflection ability is not strong enough) -* Convenient syntax for attribute-set function signatures - -## Primitives & simple polymorphism - - - -## Structs - - - -## Nested structs! - - - -## Enums! - - - -## Functions! - - |
