test(path): add additional tests to relative

[rwaskiewicz]

What is the current behavior?

I was questioning some divergent behavior between our path.resolve wrapper and the underlying Node call. Specifically:

// Node.JS console
> path.relative('foo/bar/file.js', 'foo/bar/file.js')
'' // empty string

// Our code
import { relative } from '@utils';
// ...
const foo = path.relative('foo/bar/file.js', 'foo/bar/file.js');
console.log(foo); // print '.'

GitHub Issue Number: N/A

What is the new behavior?

add additional tests to stencil's wrapped version of path.relative, adding additional documentation to how the wrapped function work. specifically, add tests to verify the following behavior:

1. when there is a single directory of overlap between from and to
2. when there is multiple directory overlap, but no divergences between from and to
3. when there is complete overlap between from and to

the latter case of complete overlap is documented in JSDoc as well to signify a divergence from path.resolve.

Does this introduce a breaking change?

• Yes
• No

Testing

No functional changes have occurred - only adding unit tests. I did track the execution of the tests in a debugger and walked through normalizePath to verify they were hitting the code points that I expected them to.

Other information

the case where we have complete overlap between from and to was the impetus for this change - I didn't understand what I was seeing at first when debugging some Stencil 4.x related path related bugs. this commit is spun out from that work

[github-actions]

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1391 errors on this branch.

That's the same number of errors on main, so at least we're not creating new ones!

reports and statistics

Our most error-prone files

Path	Error Count
src/dev-server/index.ts	37
src/mock-doc/serialize-node.ts	36
src/dev-server/server-process.ts	32
src/compiler/build/build-stats.ts	27
src/compiler/output-targets/dist-lazy/generate-lazy-module.ts	25
src/compiler/style/test/optimize-css.spec.ts	23
src/testing/puppeteer/puppeteer-element.ts	23
src/compiler/prerender/prerender-main.ts	22
src/runtime/client-hydrate.ts	19
src/screenshot/connector-base.ts	19
src/runtime/vdom/vdom-render.ts	18
src/compiler/config/test/validate-paths.spec.ts	16
src/dev-server/request-handler.ts	15
src/compiler/prerender/prerender-optimize.ts	14
src/compiler/sys/stencil-sys.ts	14
src/compiler/transpile/transpile-module.ts	14
src/runtime/vdom/vdom-annotations.ts	14
src/sys/node/node-sys.ts	14
src/compiler/build/build-finish.ts	13
src/compiler/prerender/prerender-queue.ts	13

Our most common errors

Typescript Error Code	Count
TS2345	418
TS2322	395
TS18048	310
TS18047	101
TS2722	38
TS2532	34
TS2531	23
TS2454	14
TS2352	13
TS2769	10
TS2790	10
TS2538	8
TS2344	5
TS2416	4
TS2493	3
TS18046	2
TS2684	1
TS2488	1
TS2430	1

Unused exports report

There are 15 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!

Unused exports

File	Line	Identifier
src/runtime/bootstrap-lazy.ts	21	setNonce
src/screenshot/screenshot-fs.ts	18	readScreenshotData
src/testing/testing-utils.ts	198	withSilentWarn
src/utils/index.ts	145	CUSTOM
src/utils/index.ts	241	resolve
src/utils/index.ts	255	normalize
src/utils/index.ts	7	escapeRegExpSpecialCharacters
src/compiler/app-core/app-data.ts	25	BUILD
src/compiler/app-core/app-data.ts	115	Env
src/compiler/app-core/app-data.ts	117	NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts	123	updateCacheFromRebuild
src/compiler/types/validate-primary-package-output-target.ts	62	satisfies
src/compiler/types/validate-primary-package-output-target.ts	62	Record
src/testing/puppeteer/puppeteer-declarations.ts	485	WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts	7	writeFetchSuccessSync