https://github.com/yorickpeterse/code-formatting-in-inko
An example of a simple code formatter, written in Inko
https://github.com/yorickpeterse/code-formatting-in-inko
code-formatter code-formatting fmt inko
Last synced: 5 months ago
JSON representation
An example of a simple code formatter, written in Inko
- Host: GitHub
- URL: https://github.com/yorickpeterse/code-formatting-in-inko
- Owner: yorickpeterse
- License: unlicense
- Created: 2024-04-11T00:45:33.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-29T13:40:46.000Z (almost 2 years ago)
- Last Synced: 2025-06-24T06:40:45.473Z (12 months ago)
- Topics: code-formatter, code-formatting, fmt, inko
- Homepage:
- Size: 6.84 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Code formatting in Inko
This repository showcases a basic code formatter written in [Inko](https://inko-lang.org/),
based on Inko's own code formatting implementation, which in turn is based on
[Prettier](https://prettier.io), which in turn is based on the paper
["A prettier printer"](https://homepages.inf.ed.ac.uk/wadler/papers/prettier/prettier.pdf)
by Philip Wadler.
The implementation is well documented, and prior knowledge of Inko shouldn't be
needed.
# Requirements
- Inko 0.19.1 or newer
# Usage
Using Inko 0.19.1 or newer, run the program like so, where `WIDTH` is the
desired line width:
```bash
inko run src/main.inko WIDTH
```
If you don't have or don't want to install Inko, you can also use Docker/Podman:
```bash
# When using Docker:
docker run --rm --volume ./src:/src:z ghcr.io/inko-lang/inko:latest inko run /src/main.inko WIDTH
# When using Podman:
podman run --rm --volume ./src:/src:z ghcr.io/inko-lang/inko:latest inko run /src/main.inko WIDTH
```
The output should be something along the lines of the following:
The vertical grey line indicates the line limit.
# License
The code in this repository is licensed under the
[Unlicense](https://unlicense.org/). A copy of this license can be found in the
file "LICENSE".