MaibornWolff / metric-gardener

BSD 3-Clause "New" or "Revised" License

6 stars 0 forks source link

Add keywords in comments metric #301

Closed ce-bo closed 5 months ago

ce-bo commented 6 months ago

Add keywords in comments metric

Closes #298 Closes #315

Description

Added new metric keywords in comment: return the number of theses keywords in comments with case insensivity: wtf, todo, hack, bug.
Refactor the CommentLines metric to make it more inline with other metrics and to prevent errors.
Documented the new metric in README.md
Add tests for the new metric
Definition of Done

A PR is only ready for merge once all the following acceptance criteria are fulfilled:

[x] There are automated tests for newly written code and bug fixes
[x] Documentation (README.md, UPDATE_GRAMMARS.md) has been updated

github-actions[bot] commented 5 months ago

Coverage Report

Status	Category	Percentage	Covered / Total
🟢	Lines	96.02% (🎯 90%)	4587 / 4777
🟢	Statements	96.02% (🎯 90%)	4587 / 4777
🟢	Functions	95.77% (🎯 90%)	204 / 213
🟢	Branches	92.17% (🎯 90%)	542 / 588

File Coverage

File	Stmts	% Branch	% Funcs	% Lines	Uncovered Lines
Changed Files
src/parser/MetricCalculator.ts	96.62%	85.71%	100%	96.62%	83-85
src/parser/helper/Helper.ts	100%	100%	100%	100%
src/parser/metrics/CommentLines.ts	100%	100%	100%	100%
src/parser/metrics/KeywordsInComments.ts	100%	100%	100%	100%
src/parser/metrics/Metric.ts	100%	100%	100%	100%

Generated in workflow #38