PLC-lang/rusty

`--annotations` flag

Open

#1,001 opened on Nov 2, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (71 forks)auto 404
enhancementgood first issuelow-priority

Repository metrics

Stars
 (351 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. For debugging purposes it would be really nice to have a --annotations flag to see which AST elements the resolver annotated during the compilation. The "tricky" part here is that the type_map and type_hint_map fields within the AnnotationMapImpl have no AstNode element stored directly inside it but rather a reference in the form of a AstId. Hence a mapping would be required to print the AST element and its annotation.

Describe the solution you'd like cargo r -- <input file> --annotations should print all annotations for the given input file(s)

Contributor guide

Research direction
Investigate how AstId maps to AstNode in AnnotationMapImpl and implement a annotations flag to print all AST annotations for the input file.
Tech stack
rust
Domain
clitooling
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.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50