# formality-core-stdlib

Latest version **0.1.0** (published 2019-06-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install formality-core-stdlib
pnpm add formality-core-stdlib
yarn add formality-core-stdlib
bun add formality-core-stdlib
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-06-12 |
| First published | 2019-06-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 74.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 43 |
| Maintainers | maiavictor |

## Links

- npm: https://www.npmjs.com/package/formality-core-stdlib
- Repository: https://github.com/moonad/formality-core
- Homepage: https://github.com/moonad/formality-core#readme
- Issues: https://github.com/moonad/formality-core/issues
- npm.io page: https://npm.io/package/formality-core-stdlib

## Recent versions

- 0.1.0 (latest) — 2019-06-12

## README

Formality-Core
==============

A lighweight proof language. [Whitepaper.](https://github.com/moonad/Formality-Core/blob/master/Whitepaper.md)

Installation
------------

Formality-Core has multiple reference implementations. Currently, the easiest to
install uses JavaScript. First, [install `npm`](https://www.npmjs.com/get-npm)
in your system. Then, on the command line, type: `npm -g formality-core`. If all
goes well, the language should be accessible via the `fm` command.

Using
-----

To use it, save a `.fm` file. For example, save the file below as `main.fm`:

```
main : <A: Type> -> A -> A
  <A> (x) x
```

And type `fm main`. This should output:

```
Type-checking main.fm:
main : <A: Type> -> A -> A

All terms check.

Evaluating `main`:
(x) x
```

You can also compile `.fm` files to JavaScript. First, run `fm` to generate a
`.fmc`. Then, run `fmcjs main`. You can also compile to Haskell with `fmchs`
main. You can run a script with `fmcio main`. In this case, `main` must have an
[IO](https://github.com/moonad/Moonad/blob/master/IO.fmc) type.

Contributing
------------

Since Formality-Core is so simple, it doesn't come with built-in functions you
would expect, and it doesn't have a standard library. But you're welcome to
clone the [`Moonad` repository](https://github.com/moonad/moonad), where we're
building several common data structures and algorithms, and contribute!

---
_Source: https://npm.io/package/formality-core-stdlib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
