# tony-prelude

> Standard library of the Tony programming language

Latest version **0.1.0-alpha** (published 2021-02-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install tony-prelude
pnpm add tony-prelude
yarn add tony-prelude
bun add tony-prelude
```

## Health

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

Positive: no vulnerabilities.

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

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0-alpha |
| Published | 2021-02-21 |
| First published | 2021-02-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12 |
| Dependencies | 1 |
| Unpacked size | 15.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jonas Hübotter |
| Maintainers | jonhue |

## Links

- npm: https://www.npmjs.com/package/tony-prelude
- Repository: https://github.com/tony-lang/prelude
- Homepage: https://tony-lang.github.io/
- Issues: https://github.com/tony-lang/prelude/issues
- npm.io page: https://npm.io/package/tony-prelude

## Dependencies (1)

- [tony-lang](https://npm.io/package/tony-lang.md) github:tony-lang/tony#master

## Recent versions

- 0.1.0-alpha (latest) — 2021-02-21

## README

# Tony Prelude

This repository is home to the standard library of the Tony programming language.

Tony is a functional, strongly typed, high level, general purpose programming language. Tony employs refinement types, allowing its type checker to catch domain-specific bugs at compile time.

Other core components of Tony can be found through the following links:

* [Formal specification](https://github.com/tony-lang/spec)
* [Compiler and Type Inference algorithm](https://github.com/tony-lang/tony)
* [CLI](https://github.com/tony-lang/cli)

## Installation

The `tony-prelude` package is published on [NPM](https://www.npmjs.com/package/tony-prelude).

You may install it

* using [Yarn](https://yarnpkg.com/) (preferred)

    ```
    $ yarn global add tony-prelude
    ```

* or using [NPM](https://docs.npmjs.com/cli/v6/commands/npm)

    ```
    $ npm install -g tony-prelude
    ```

## Usage

The prelude is imported automatically in all Tony programs. If you wish to override the default import add the following import:

```tn
import { + } from 'prelude'
```

In the above example only `+` is imported from the prelude.

## Development

To start development you first have to fork this repository and locally clone your fork.

Use `yarn start` to listen to changes and rebuild dynamically.

### Testing

To run the tests:

    $ yarn test

To let TypeScript check types:

    $ yarn tsc

The linter can be run as follows:

    $ yarn lint

We use [Prettier](https://prettier.io/) for automated code formatting:

    $ yarn prettier

You can find all commands run by the CI workflow in `.github/workflows/ci.yml`.

## Contributing

We warmly welcome everyone who is intersted in contributing. Please reference our [contributing guidelines](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md).

## Releases

[Here](https://github.com/tony-lang/prelude/releases/) you can find details on all past releases.
Unreleased breaking changes that are on the current master can be found [here](CHANGELOG.md).

Tony follows Semantic Versioning 2.0 as defined at http://semver.org. Reference our [security policy](SECURITY.md).

### Publishing

1. Review breaking changes and deprecations in `CHANGELOG.md`.
1. Change the version in `package.json`.
1. Reset `CHANGELOG.md`.
1. Create a pull request to merge the changes into `master`.
1. After the pull request was merged, create a new release listing the breaking changes, deprecations and commits on `master` since the last release.
1. The release workflow will publish the package to NPM.

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