feat: add TypeScript plugin

[BioPhoton]

Implementation of the typescript plugin mentioned in #901. It uses the compiler programatically to retrieve TypeScript diagnostics for the compiler. Those diagnostice are mapped to audits and act like linting errors/warning.

NOTE
This is a PoC PR, when reviewing keep in mind that it will land in multiple smaller PR's.
The main reasoning behind the architecture is places in the related issue: #901

This PR includes:

• implementation
• unit tests
• integration tests
• e2e tests
• user docs
• code docs

Todos:

• tsConfigPath: './tsconfig.json', should be optional
• codes are commented
• integration tests for all diagnostic issues

Proposed PR delivery:

• changes in @code-pushup/utils
• runner logic
• plugin utils
• plugin & usage
• docs & CONTRIBUTING.md
• e2e

closes #901

Example Md Report:

Code PushUp Report

🏷 Category	⭐ Score	🛡 Audits
Typescript	🟡 88	47

🏷 Categories

Typescript

🟡 Score: 88

• 🟡 Strict (Typescript)
  • 🟥 NoImplicitAny - 1
  • 🟥 StrictFunctionTypes - 1
  • 🟥 StrictPropertyInitialization - 1
  • 🟩 AlwaysStrict - 0
  • 🟩 NoImplicitThis - 0
  • 🟩 StrictBindCallApply - 0
  • 🟩 StrictBuiltinIteratorReturn - 0
  • 🟩 StrictNullChecks - 0
• 🟡 TypeCheckingBehavior (Typescript)
  • 🟥 NoUncheckedIndexedAccess - 1
  • 🟩 ExactOptionalPropertyTypes - 0
  • 🟩 NoImplicitOverride - 0
  • 🟩 NoPropertyAccessFromIndexSignature - 0
• 🟡 ModuleResolution (Typescript)
  • 🟥 ModuleResolution - 19
  • 🟩 CustomConditions - 0
  • 🟩 ResolvePackageJsonExports - 0
  • 🟩 ResolvePackageJsonImports - 0
  • 🟩 VerbatimModuleSyntax - 0
• 🟢 BuildEmitOptions (Typescript)
  • 🟩 DownlevelIteration - 0
  • 🟩 EmitBOM - 0
  • 🟩 EmitDeclarationOnly - 0
  • 🟩 ImportHelpers - 0
  • 🟩 NoEmit - 0
  • 🟩 NoEmitHelpers - 0
  • 🟩 NoEmitOnError - 0
  • 🟩 PreserveConstEnums - 0
  • 🟩 RemoveComments - 0
  • 🟩 StripInternal - 0
• 🟢 ControlFlowOptions (Typescript)
  • 🟩 AllowUnreachableCode - 0
  • 🟩 NoFallthroughCasesInSwitch - 0
  • 🟩 NoImplicitReturns - 0
• 🟢 InteropConstraints (Typescript)
  • 🟩 AllowSyntheticDefaultImports - 0
  • 🟩 EsModuleInterop - 0
  • 🟩 ForceConsistentCasingInFileNames - 0
  • 🟩 IsolatedModules - 0
  • 🟩 PreserveSymlinks - 0
• 🟢 LanguageAndEnvironment (Typescript)
  • 🟩 EmitDecoratorMetadata - 0
  • 🟩 ExperimentalDecorators - 0
  • 🟩 Jsx - 0
  • 🟩 JsxFactory - 0
  • 🟩 JsxFragmentFactory - 0
  • 🟩 JsxImportSource - 0
  • 🟩 Lib - 0
  • 🟩 ModuleDetection - 0
  • 🟩 NoLib - 0
  • 🟩 ReactNamespace - 0
  • 🟩 Target - 0
  • 🟩 UseDefineForClassFields - 0

🛡️ Audits

ModuleResolution (Typescript)

🟥 19 (score: 0)

Issues

Severity	Message	Source file	Line(s)
🚨 error	Cannot find module '@babel/parser'. Did you mean to set the 'moduleResolution' option to 'nodenext', or to add aliases to the 'paths' option?	node_modules/@types/babel__core/index.d.ts	2
🚨 error	Cannot find module '@babel/types'. Did you mean to set the 'moduleResolution' option to 'nodenext', or to add aliases to the 'paths' option?	node_modules/@types/babel__core/index.d.ts	5
🚨 error	Cannot find module '@babel/parser'. Did you mean to set the 'moduleResolution' option to 'nodenext', or to add aliases to the 'paths' option?	node_modules/@types/babel__core/index.d.ts	10
🚨 error	Cannot find module '@babel/types'. Did you mean to set the 'moduleResolution' option to 'nodenext', or to add aliases to the 'paths' option?	node_modules/@types/babel__generator/index.d.ts	1
🚨 error	Cannot find module '@babel/parser'. Did you mean to set the 'moduleResolution' option to 'nodenext', or to add aliases to the 'paths' option?	node_modules/@types/babel__template/index.d.ts	1
🚨 error	Cannot find module '@babel/types'. Did you mean to set the 'moduleResolution' option to 'nodenext', or to add aliases to the 'paths' option?	node_modules/@types/babel__template/index.d.ts	2
🚨 error	Cannot find module '@babel/types'. Did you mean to set the 'moduleResolution' option to 'nodenext', or to add aliases to the 'paths' option?	node_modules/@types/babel__traverse/index.d.ts	1
🚨 error	Cannot find module 'undici-types'. Did you mean to set the 'moduleResolution' option to 'nodenext', or to add aliases to the 'paths' option?	node_modules/@types/node/globals.d.ts	6

📖 Docs

[github-actions]

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared target commit 9b54309 with source commit c219602.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Performance	🟡 57	🔴 39
Code coverage	🟢 91	🟢 91
Typescript	n/a (*)	🟢 100	n/a (*)
Security	🟡 81	🟡 81	–
Updates	🟡 80	🟡 80	–
Accessibility	🟢 91	🟢 91	–
Best Practices	🟢 100	🟢 100	–
SEO	🟡 61	🟡 61	–
Bug prevention	🟢 100	🟢 100	–
Code style	🟢 100	🟢 100	–

(*) New category.

👍 1 group improved, 👎 1 group regressed, 👍 1 audit improved, 👎 6 audits regressed, 11 audits changed without impacting score

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
Lighthouse	Performance	🟡 57	🔴 39
Code coverage	Code coverage metrics	🟢 91	🟢 91

15 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value	🔄 Value change
Lighthouse	Largest Contentful Paint	🟨 2.9 s	🟥 4.6 s
Lighthouse	Speed Index	🟨 5.3 s	🟥 7.6 s
Lighthouse	First Contentful Paint	🟨 2.9 s	🟥 3.7 s
Lighthouse	Time to Interactive	🟥 12.2 s	🟥 16.3 s
Lighthouse	Total Blocking Time	🟥 2,860 ms	🟥 6,820 ms
Code coverage	Function coverage	🟩 93.1 %	🟩 93.3 %
Code coverage	Line coverage	🟩 90.9 %	🟩 90.8 %
Lighthouse	Minimizes main-thread work	🟥 12.4 s	🟥 21.4 s
Lighthouse	JavaScript execution time	🟥 5.0 s	🟥 10.1 s
Lighthouse	Avoids enormous network payloads	🟩 Total size was 1,825 KiB	🟩 Total size was 1,820 KiB
Lighthouse	Metrics	🟩 100%	🟩 100%
Lighthouse	Max Potential First Input Delay	🟥 1,170 ms	🟥 3,960 ms
Lighthouse	Uses efficient cache policy on static assets	🟨 28 resources found	🟨 28 resources found
Lighthouse	Eliminate render-blocking resources	🟥 Potential savings of 1,080 ms	🟥 Potential savings of 1,460 ms
Lighthouse	Initial server response time was short	🟩 Root document took 550 ms	🟩 Root document took 460 ms
Lighthouse	Server Backend Latencies	🟩 190 ms	🟩 200 ms
Lighthouse	Network Round Trip Times	🟩 70 ms	🟩 70 ms
Code coverage	Branch coverage	🟨 85.8 %	🟨 85.8 %

570 other audits are unchanged.

[vmasek]

Amazing work, can't wait to give it a try in some big project, I had a brief look but I'll review later (🤔 is this a 🎄🎁?)

[BioPhoton]

This is a left over

[BioPhoton]

here we should mention the helper