FuelLabs/sway

Pretty print the AST from sway-core

Open

#2,487 opened on Aug 9, 2022

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Rust (61,702 stars) (5,421 forks)batch import
compiler: uienhancementgood first issueloggingteam:compiler

Description

It would be nice if we could implement a pretty printer for the AST produced from sway-core.

Currently, it's pretty hard to read when using a println! on the return AST in rust. Alex mentioned he had used the ptree crate before. Perhaps it might be worth also looking at leveraging this crate for pretty printing.

Contributor guide

Tech stack
rust
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust knowledgeAST basicsFamiliarity with sway core
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
First, examine the AST types in sway core to understand the structure. Then, look into the ptree crate documentation to see how it can be used to render tree structures. Implement a pretty printer function that traverses the AST and outputs formatted text using ptree. Consider writing tests to verify the output.
Pretty print the AST from sway-core · FuelLabs/sway#2487 | Good First Issue