MaibornWolff / MaibornWolff/codecharta

Adjust pipe behaviour for our analysers

Open
#4,033 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

pr-analysis research
Dominant language
TypeScript
Stars
529
Forks
56
Avg merge
7h 17m
Merged PRs (30d)
34

Description

Research

General Idea

Currently our parsers send a sync flag when they are starting their execution. When piping one analyser into another, the later one waits for the sync flag and filters it our during execution. However, when piping an analyser into external commands they do not know this and treat the sync flag as normal output, potentially leading to unintended behaviour.
We should research a solution that allows our analysers to be compatible with other commands while not causing problems for the usage of one analyser as piped input for another.

Proposed Solution

Pros/Cons

Pros:

Cons:

Alternatives

<If you found any alternative solutions during your research, they can be included here>

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 reading the analyser and parser handling for sync flags, then trace how output is consumed when piping between analysers and to external commands. Research a compatible protocol that preserves analyser-to-analyser piping without exposing control data as normal output, and document the chosen approach and its trade-offs.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.