MaibornWolff / MaibornWolff/codecharta

Usage of the file query parameter

Open
#3,519 0 comments 0 reactions 0 assignees View on GitHub
pr-visualization question research
Dominant language
TypeScript
Stars
529
Forks
56
Avg merge
7h 17m
Merged PRs (30d)
34

Description

# Question

CodeCharta allows to directly load a cc.json file from the url (e.g. the web version uses this to load two maps: https://maibornwolff.github.io/codecharta/visualization/app/?file=codecharta.cc.json.gz&file=codecharta_analysis.cc.json.gz). This currently requires that one is hosting the cc.json files themselves. This has been a feature since 2018 but is not documented well.
We recently added a feature, that the different metrics can be set in the url, given the url contains a file. This can be great to share the view of a map but only works if one is hosting their cc.json files somewhere, which not many users will do.

### Questions:
What was the original purpose of the file query parameter and can we use this to make maps more easily sharable?

## Preparation

Please check these resources first before posting a question

* [ ] I searched for answers in [older issues](https://github.com/MaibornWolff/codecharta/issues?utf8=%E2%9C%93&q=)
* [ ] I looked into the [README.md](https://github.com/MaibornWolff/codecharta)
* [ ] I read the [website](https://maibornwolff.github.io/codecharta/)

Contributor guide

No contributing guide indexed for this repository

Research direction

Read README.md and the website, then inspect the visualization app's existing handling of the file query parameter. Use the linked web-version URL as a concrete example and review older issues for context. Done means documenting the parameter's original purpose and determining whether it can support more easily shareable maps.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
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.