https://github.com/kritzcreek/motoko-pretty

A pretty printing library for Motoko
https://github.com/kritzcreek/motoko-pretty

Last synced: about 2 months ago
JSON representation

A pretty printing library for Motoko

• Host: GitHub
• URL: https://github.com/kritzcreek/motoko-pretty
• Owner: kritzcreek
• License: apache-2.0
• Created: 2021-05-08T10:34:05.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-05-15T14:22:18.000Z (over 3 years ago)
• Last Synced: 2024-10-11T23:54:53.800Z (2 months ago)
• Language: Modelica
• Homepage: https://kritzcreek.github.io/motoko-pretty
• Size: 31.3 KB
• Stars: 4
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-motoko - motoko-pretty - A pretty printer library for Motoko. (Libraries / Logging)

README

        
# motoko-pretty

A pretty printer library for Motoko.

Ported from [purescript-dodo-printer](https://github.com/natefaubion/purescript-dodo-printer).

All credit goes to Nathan Faubion

## Examples

More examples are coming, but for now there's a basic Json printer in `test/JsonExample.mo` to

give you an idea.

You can run it with `make -C test json`.

## How to develop

- Write your library code in `*.mo` source files in the `src/` directory.

- Run `make check` to make sure your changes compile (or use the

  VSCode extension to get quicker feedback)

- Add tests to the source files in the `test/` directory, and run them

  with `make test`. The project template is set up to include

  motoko-matchers.

- Generate API documentation locally by running `make docs` and then

  open the resulting `docs/index.html` in your browser

## API Documentation

API documentation for this library can be found at https://kritzcreek.github.io/motoko-pretty

## License

motoko-pretty is distributed under the terms of the Apache License (Version 2.0).

See LICENSE for details.