chore: Technical Debt Metrics

[rusackas]

SUMMARY

What if you could actually measure various sources of technical debt, upon the merge of each PR? This PR is the start of being able to do so. We will be able to track different piles of work we care about over time, and generate actionable to-do lists for others to tackle.

This is a reboot of an antique branch/PR, for cleanliness. It does the following:

• Adds a new eslintrc file that's custom-built to track/warn on technical debt metrics
• Adds a custom eslint transformer that splits the eslint report into aggregated stats and individual offenses
  • aggregated stats are added to one google sheet tab
  • individual offenses are added to an eslint TODO tab in the same google sheet.
• adds an npm script to run this
• adds a github action to run the script on mergest to master

This PR just does this for Javascript - and only for a limited set of rules. We can do the same here for python, and other bits of code and content in our universe. Ultimately, we want to have this all in a nice visible dashboard for all to leverage in either tracking this debt, and/or contributing to its demise. Here's the humble beginning of such a dashboard, using these scripts:

Once Apache adds the secret to the repo to write to GitHub actions, we should actually see this working. That ticket is open. This will run on merges to master or main so we can get ahead of that change.

In time, we can gather a lot more info here... and hopefully make this an example dashboard and a regular touch point of community engagement.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5e633d2) 67.22% compared to head (e990e11) 67.22%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master   #26442   +/-   ##
=======================================
  Coverage   67.22%   67.22%           
=======================================
  Files        1894     1894           
  Lines       74192    74192           
  Branches     8244     8244           
=======================================
  Hits        49877    49877           
  Misses      22243    22243           
  Partials     2072     2072           

Flag	Coverage Δ
javascript	56.99% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[michael-s-molina]

This is awesome! Thanks for working on this @rusackas. It will be a powerful tool to help improve quality.

[rusackas]

Accidentally deleted my TODO from the code... adding it here so I can maybe start a kanban board or something...

/**

• TODO (@rusackas)
• • SIP-61 content organization
• [SIP-61] Improve the organization of front-end folders #13632
• • Component/Design system rules
• • Organization of folders in Storybook
• • All components have a description page
• • Props have controls
• • Components have figma links
• • Anything from frontent style guidelines
• https://github.com/apache/superset/wiki/Frontend-Style-Guidelines
• • Hex colors!
    */

[michael-s-molina]

LGMT. Thanks for the feature @rusackas. It will greatly contribute to improving code quality.

[betodealmeida]