feat(utils): add string helper

[BioPhoton]

This PR includes helper for the TypeScript plugin #902

[github-actions]

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared target commit d34b256 with source commit 6c7ed9f.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Performance	🟡 55	🟡 51
Documentation	🔴 23	🔴 23
Code coverage	🟢 91	🟢 91
Security	🟡 79	🟡 79	–
Updates	🟡 77	🟡 77	–
Accessibility	🟢 92	🟢 92	–
Best Practices	🟢 100	🟢 100	–
SEO	🟡 61	🟡 61	–
Bug prevention	🟢 100	🟢 100	–
Code style	🟢 100	🟢 100	–

👍 2 groups improved, 👎 1 group regressed, 👍 5 audits improved, 👎 6 audits regressed, 10 audits changed without impacting score

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
Lighthouse	Performance	🟡 55	🟡 51
JSDoc coverage	Documentation coverage	🔴 23	🔴 23
Code coverage	Code coverage metrics	🟢 91	🟢 91

15 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value	🔄 Value change
Lighthouse	Initial server response time was short	🟥 Root document took 610 ms	🟩 Root document took 450 ms
Lighthouse	Speed Index	🟨 5.0 s	🟥 6.3 s
Lighthouse	Time to Interactive	🟥 13.7 s	🟥 15.9 s
Lighthouse	Largest Contentful Paint	🟨 3.3 s	🟨 3.5 s
Lighthouse	First Contentful Paint	🟨 2.7 s	🟨 2.8 s
Lighthouse	Total Blocking Time	🟥 3,800 ms	🟥 7,070 ms
JSDoc coverage	Functions coverage	🟥 437 undocumented functions	🟥 437 undocumented functions
JSDoc coverage	Types coverage	🟥 198 undocumented types	🟥 200 undocumented types
Code coverage	Line coverage	🟩 90.1 %	🟩 90.1 %
Code coverage	Branch coverage	🟨 86 %	🟨 86 %
Code coverage	Function coverage	🟩 93.1 %	🟩 93.1 %
Lighthouse	Minimizes main-thread work	🟥 13.3 s	🟥 20.0 s
Lighthouse	JavaScript execution time	🟥 6.3 s	🟥 8.9 s
Lighthouse	Metrics	🟩 100%	🟩 100%
Lighthouse	Max Potential First Input Delay	🟥 1,800 ms	🟥 2,360 ms
Lighthouse	Eliminate render-blocking resources	🟥 Potential savings of 840 ms	🟥 Potential savings of 510 ms
Lighthouse	Reduce unused CSS	🟥 Potential savings of 67 KiB	🟥 Potential savings of 48 KiB
Lighthouse	Server Backend Latencies	🟩 130 ms	🟩 300 ms
Lighthouse	Avoids enormous network payloads	🟩 Total size was 1,816 KiB	🟩 Total size was 1,816 KiB
Lighthouse	Network Round Trip Times	🟩 20 ms	🟩 60 ms
Lighthouse	Uses efficient cache policy on static assets	🟨 27 resources found	🟨 27 resources found

574 other audits are unchanged.

[matejchalk]

Good job with the refactor and the tests 👍

I think the type tests need some more setup (see comments), but I don't see it as a blocker for this PR.

[matejchalk]

It's possible to configure alternative assertion function names to expect using assertFunctionNames option. I suggest adding this configuration to the base eslint.config.js:

export default tseslint.config(
  // ...
  {
    files: ['**/*.type.test.ts'],
    rules: {
      'vitest/expect-expect': [
        'error',
        { assertFunctionNames: ['expectTypeOf', 'assertType'] },
      ],
    },
  },
);

[matejchalk]

I noticed these type tests aren't included anywhere. Extending the vite.config.unit.ts configuration like this includes them in unit-test target:

export default defineConfig({
  // ...
  test: {
    // ...
    typecheck: {
      enabled: true,
      include: ['**/*.type.test.ts'],
    },
  },
});

[matejchalk]

Unfortunately, it seems to me like the typecheck always passes. When I deliberately introduce errors, they're correctly highlighted in IDE, but the test command reports passed tests anyway 😕