IntersectMBO/plutus

A way to turn off indentation in the pretty-printer

Open

#5,917 opened on Apr 22, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (1,637 stars) (511 forks)batch import
Good first issueLow priorityTextual representationstatus: triaged

Description

@kwxm asks for a feature:

It might be useful to be able to turn off the indentation completely. I find that largish textual programs quickly become too large and too wide to read when I prettyprint them, so I end up using sed to transform the output. For example, the uniswap-3 script is 12721 bytes of flat, but when I convert it to textual form I get 24029 lines of output, the longest of them being 732 characters wide. There's a total of 10,221,880 characters, but if I delete all of the leading spaces that goes down to 105,491, which is a bit more manageable.

This should perhaps be just an additional flag in the pretty-printing config and a carefully placed group calls. Although we might have hardlines in the pretty-printing code.

Contributor guide

Tech stack
None
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Haskell basicsfamiliarity with Plutusknowledge of pretty printing libraries
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the pretty printer configuration and the `group` calls in the codebase. Look for the pretty printing in files like `PlutusCore/Pretty.hs` or similar. Consider adding a flag to disable indentation and adjust the pretty printing logic accordingly. Review similar PRs or issues for prior discussions.
A way to turn off indentation in the pretty-printer · IntersectMBO/plutus#5917 | Good First Issue