superset icon indicating copy to clipboard operation
superset copied to clipboard

feat(script): Tech debt metrics generation via ESLint

Open rusackas opened this issue 3 years ago • 1 comments

SUMMARY

This adds a script that generates a report of technical debt issues we care to track. These tech debt items are added as lint rules in a separate lint config for cleanliness. The script generates a JSON file with rollups/counts of each type of offense, as well as their granular files/lines. Over time, we can use these rollups/files to generate a report/dashboard and track our technical debt over time or enforce that it doesn't grow.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

npm run lint-stats

ADDITIONAL INFORMATION

  • [ ] Has associated issue:
  • [ ] Required feature flags:
  • [ ] Changes UI
  • [ ] Includes DB Migration (follow approval process in SIP-59)
    • [ ] Migration is atomic, supports rollback & is backwards-compatible
    • [ ] Confirm DB migration upgrade and downgrade tested
    • [ ] Runtime estimates and downtime expectations provided
  • [ ] Introduces new feature or API
  • [ ] Removes existing feature or API

rusackas avatar Aug 31 '22 20:08 rusackas

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (a23825c) 69.16% compared to head (c44a727) 82.85%.

Additional details and impacted files
@@             Coverage Diff             @@
##           master   #21276       +/-   ##
===========================================
+ Coverage   69.16%   82.85%   +13.69%     
===========================================
  Files        1948      520     -1428     
  Lines       76054    36534    -39520     
  Branches     8493        0     -8493     
===========================================
- Hits        52601    30271    -22330     
+ Misses      21273     6263    -15010     
+ Partials     2180        0     -2180     
Flag Coverage Δ
hive 53.68% <ø> (ø)
javascript ?
mysql 78.07% <ø> (ø)
postgres 78.17% <ø> (ø)
presto 53.63% <ø> (ø)
python 82.85% <ø> (ø)
sqlite 77.76% <ø> (ø)
unit 55.86% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Aug 31 '22 21:08 codecov[bot]

Closing this and starting a fresh branch/PR

rusackas avatar Jan 09 '24 22:01 rusackas