Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE]: TypeScript Type Coverage Reporting #15

Open
helabenkhalfallah opened this issue Oct 21, 2024 · 0 comments
Open

[FEATURE]: TypeScript Type Coverage Reporting #15

helabenkhalfallah opened this issue Oct 21, 2024 · 0 comments
Assignees
Labels
Milestone

Comments

@helabenkhalfallah
Copy link
Member

✨ Description

This feature integrates TypeScript type coverage reporting into the Vitality platform. By leveraging tools like typescript-coverage-report or type-coverage, Vitality will provide developers with insights into the "typedness" of their TypeScript code, helping them identify areas where type information might be missing or incomplete.

🚀 Motivation

  • Encourage developers to write more type-safe code by providing visibility into type coverage.
  • Help prevent runtime errors caused by unexpected type issues by identifying areas with low type coverage.
  • Promote better TypeScript coding practices and improve the overall quality and maintainability of TypeScript projects.
  • Identify potential type-related issues early in the development process, reducing the risk of bugs and unexpected behavior.

📝 Proposed Solution

  • Integrate a TypeScript type coverage tool (e.g., typescript-coverage-report, type-coverage) into Vitality.
  • Analyze TypeScript projects to calculate type coverage metrics.
  • Process reports.
  • Identify recommendations and keywords.
  • Store reports.
  • Update BFF schemas and resolvers.
  • Frontend Visualisation.

🔗 Relevant Links (if any)

https://github.com/alexcanessa/typescript-coverage-report
https://github.com/plantain-00/type-coverage?tab=readme-ov-file

@helabenkhalfallah helabenkhalfallah added the enhancement New feature or request label Oct 21, 2024
@helabenkhalfallah helabenkhalfallah added feature and removed enhancement New feature or request labels Oct 21, 2024
@helabenkhalfallah helabenkhalfallah added this to the Vitality 2.0 milestone Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants