MaibornWolff / MaibornWolff/codecharta
Different types for internal and external types
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 529
- Forks
- 56
- Avg merge
- 7h 17m
- Merged PRs (30d)
- 34
Description
# Feature request
## Description
As a developer, I want to have proper types for internal and external types of the application, so that we don't have to make certain properties optional, even though they're given 100% of the time, just because we don't want to break anything.
A good example for that is the CodeMapNode, which has an optional property `isFlattened` or `id` which are only added to it when the file is being decorated. However, we use that type for variables before AND after the decoration.
This will help us to use the export-types to validate correctly in the future.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the CodeMapNode type and the decoration and export-types paths mentioned in the issue. Trace how the type is used before and after decoration, then verify that internal and external representations no longer require optional properties solely for compatibility and that export-type validation remains correct.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100