PLC-lang/rusty

Sort error codes within their categories when printing with `plc config diagnostics`

Open

#1,158 opened on Mar 15, 2024

View on GitHub
 (1 comment) (1 reaction) (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. Currently, if you want to see the error severity configuration and print it via plc config diagnostics, the error codes will be in a random order within their respective severity. If you then write the output to a json file, it will look something like this:

{
    "warning": [
        "E013",
        "E022",
        "E047",
        "E014",
        "E015",
        "E090",
        "E004",
        "E042",
        "E023",
        "E049",
        "E091",
        "E039",
        "E093",
        "E024",
        "E016"
    ],

    ...
}

Describe the solution you'd like Sort the error codes in their categories ascendingly, to make it easier to find the codes you are looking for.

Contributor guide

Research direction
Locate the function that outputs the diagnostic configuration and sort the error codes using the sort() method on the Vec or slice.
Tech stack
rust
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
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.
90