MaibornWolff / MaibornWolff/codecharta

More descriptive validation results

Open
#1,144 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

difficulty:low feature pr-visualization priority:low
Dominant language
TypeScript
Stars
529
Forks
56
Avg merge
7h 17m
Merged PRs (30d)
34

Description

# Feature request

## Description

Right now, we show the last encountered warning or the first encountered error when validating files. When opening more than one file, the dialog does not provide enough information for the user to know which file is broken and how to fix it.

As a user, I want to know which files resulted in which errors/warnings and get information on what to do next , so that I can take action to fix the file.

## Acceptance criteria
- Instead of printing validation results instantly after validating, collect them and keep a reference to the fileName.
- Print a list of all errors and warnings ONCE all validation results are collected. Errors first.
- Extend the validationResults to include information on how to continue with the broken file. Encountering a newer minor version, should indicate, that the user should install the newest version of codecharta in order to not miss any features.

## Development notes (optional Task Breakdown)
- [ ] Extend validationResults with information on how to continue with the broken file
- [x] Extend validationResults with fileName
- [x] Collect and print all results once
- [x] dialog should have max height, content should be scrollable

## Open questions

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the validationResults handling and the validation dialog in the TypeScript/Angular application. Trace how validation results are collected and displayed for multiple files, then verify that all errors and warnings are shown once, with file names and continuation guidance, in a scrollable dialog.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.