MaibornWolff / MaibornWolff/codecharta

Analysis Getting Started should heavily reference the unifiedparser

Open
#4,127 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
529
Forks
56
Avg merge
7h 17m
Merged PRs (30d)
34

Description

# Feature request

The unified parser supports all the most important languages, missing only C/C++. It also provides better metrics than the Tokeiparser and Rawtextparser (uni does not currently calculate nesting level and [bumpy road though](https://codescene.com/engineering-blog/bumpy-road-code-complexity-in-context/) but I won't hold that against it). It is also significantly easier to get started with than the sonarimporter. So the docs should make heavy use of it, the coverageimporter and the gitlogparser.

## Description

As a novice user, I want the 'getting started' to show me a very easy way to get started, so that I can try CodeCharta asap.

### Language rankings

| [Redmonk 01-2025](https://redmonk.com/sogrady/2025/06/18/language-rankings-1-25/) | [Tiobe 07-2025](https://www.tiobe.com/tiobe-index/) | [IEEE 2024](https://spectrum.ieee.org/top-programming-languages-2024) |
| ------------- | ------------- |------------- |
| 1 **JavaScript** | 1 **Python** | 1 **Python** |
| 2 **Python** | 2 **C++** | 2 **Java** |
| 3 **Java** | 3 **C** | 3 **JavaScript** |
| 4 **PHP** | 4 **Java** | 4 **C++** |
| 5 **C#** | 5 **C#** | 5 **TypeScript** |
| 6 **TypeScript** | 6 **JavaScript** | 6 SQL |
| 7 CSS | 7 **Go** | 7 **C#** |
| 7 **C++** | 8 Visual Basic | 8 **Go** |
| 9 **Ruby** | 9 Ada | 9 **C** |
| 10 **C** | 10 Delphi | 10 Html |
| 14 **Kotlin** | 20 **Kotlin** | 17 **Kotlin** |

**Bold** what the unified parser currently supports.

## Acceptance criteria
- Getting started focuses on the unified parser
- Getting started also mentions that projects that have sonar set up, should use the sonarimporter
- Getting started references the rawtextparser, but only as an alternative, when the unifiedparser does not support the project language

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the existing Getting Started documentation and locate its current parser and importer guidance. Update it to focus on the unified parser, mention the sonarimporter for projects with Sonar configured, and present the rawtextparser only as an alternative when the unified parser lacks language support.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.