fix(compiler): normalize paths on windows

this patch ensures that paths are properly normalized by the compiler.
this ensures that regardless of the platform (operating system) that a
project is compiled on, paths are uniformly treated internally by
stencil. this has system-wide reaching effects - from the in-memory
filesystem, to configuration/output target validation, and file
generation.

previously, stencil's in-browser compilation support included a polyfill
for the following NodeJS `path` module functions: `join`, `normalize`,
`relative` & `resolve`. this polyfill did the following:
- it wrapped each of the aforementioned functions in a `normalizePath`
  function to convert Windows-style path separators (`\\`) to
  Unix/POSIX-style path separators (`/`)
- it overwrote the standard NodeJS `path` implementations for each of
  these functions.
as a result, calling `join` or any of the other three methods, even when
importing the method from `path` like below would result in the polyfill
being called:
```ts
import { join } from 'path'; // this imports the polyfilled `join`

// runs the native `path.join`, then normalizes the returned path
const filePath = join(part1, part2);
```

while this was 'nice' in that stencil engineers didn't need to think
about which implementation of `path` functions they were using, this
polyfill made some behavior of the compiler hard to understand.

the polyfills were removed in #4317 (b042d8b). this led to calls to the
aforementioned functions to call their original implementations, rather
than the wrapped implementations:
```ts
import { join } from 'path'; // imports Node's `join`

// run the native `path.join`, without any normalization
const filePath = join(part1, part2);
```

discrepencies arose where parts of the code would explicitly wrap a
call to `join()` (or one of its ilk) around a path normalization
function. this caused paths to not be uniformly normalized throughout
the codebase, leading to errors.

since the removal of in-browser compilation, additional pull requests
to fix path-related issues on windows have landed in the codebase:
- #4545 (cd58d9c)
- #4932 (b97dadc)

this commit builds on the previous commits by attempting to move
stencil's compiler completely over to polyfilled versions of the
mentioned `path` functions that are explicitly imported/called.

Some of the changes found herein were created/validated using Alice's
codemod branch, #4996
Co-authored-by: alicewriteswrongs <[email protected]>

STENCIL-975 Determine Scope of Path Polyfill Bug, Fix

Fixes: #4980
Fixes: #4961

Spun Off: #5036, #5032, #5029

src/compiler/app-core/app-es5-disabled.ts

@@ -1,5 +1,4 @@
-import { escapeHtml, generatePreamble } from '@utils';
-import { join } from 'path';
+import { escapeHtml, generatePreamble, join } from '@utils';
 
 import type * as d from '../../declarations';
 

src/compiler/app-core/app-polyfills.ts

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { join } from '@utils';
 
 import type * as d from '../../declarations';
 

src/compiler/build/compiler-ctx.ts

@@ -1,5 +1,5 @@
-import { noop, normalizePath } from '@utils';
-import { basename, dirname, extname, join } from 'path';
+import { join, noop, normalizePath } from '@utils';
+import { basename, dirname, extname } from 'path';
 
 import type * as d from '../../declarations';
 import { buildEvents } from '../events';

src/compiler/build/watch-build.ts

@@ -1,5 +1,5 @@
-import { isString } from '@utils';
-import { dirname, resolve } from 'path';
+import { isString, resolve } from '@utils';
+import { dirname } from 'path';
 import type ts from 'typescript';
 
 import type * as d from '../../declarations';

src/compiler/bundle/core-resolve-plugin.ts

@@ -1,5 +1,5 @@
-import { isRemoteUrl, normalizeFsPath, normalizePath } from '@utils';
-import { dirname, join } from 'path';
+import { isRemoteUrl, join, normalizeFsPath, normalizePath } from '@utils';
+import { dirname } from 'path';
 import type { Plugin } from 'rollup';
 
 import type * as d from '../../declarations';

src/compiler/bundle/dev-module.ts

@@ -1,5 +1,5 @@
-import { generatePreamble } from '@utils';
-import { basename, dirname, join, relative } from 'path';
+import { generatePreamble, join, relative } from '@utils';
+import { basename, dirname } from 'path';
 import { OutputOptions, rollup } from 'rollup';
 
 import type * as d from '../../declarations';

src/compiler/bundle/dev-node-module-resolve.ts

@@ -1,4 +1,5 @@
-import { basename, dirname, join, relative } from 'path';
+import { join, relative } from '@utils';
+import { basename, dirname } from 'path';
 import { ResolveIdResult } from 'rollup';
 
 import type * as d from '../../declarations';

src/compiler/bundle/ext-transforms-plugin.ts

@@ -1,5 +1,4 @@
-import { hasError, isOutputTargetDistCollection, normalizeFsPath } from '@utils';
-import { join, relative } from 'path';
+import { hasError, isOutputTargetDistCollection, join, normalizeFsPath, relative } from '@utils';
 import type { Plugin } from 'rollup';
 
 import type * as d from '../../declarations';

src/compiler/bundle/plugin-helper.ts

@@ -1,5 +1,4 @@
-import { buildError } from '@utils';
-import { relative } from 'path';
+import { buildError, relative } from '@utils';
 
 import type * as d from '../../declarations';
 

src/compiler/bundle/user-index-plugin.ts

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { join } from '@utils';
 import type { Plugin } from 'rollup';
 
 import type * as d from '../../declarations';

src/compiler/cache.ts

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { join } from '@utils';
 
 import type * as d from '../declarations';
 import { InMemoryFileSystem } from './sys/in-memory-fs';

src/compiler/config/config-utils.ts

@@ -1,5 +1,5 @@
-import { isBoolean } from '@utils';
-import { isAbsolute, join } from 'path';
+import { isBoolean, join } from '@utils';
+import { isAbsolute } from 'path';
 
 import type { ConfigFlags } from '../../cli/config-flags';
 import type * as d from '../../declarations';

src/compiler/config/outputs/validate-custom-element.ts

@@ -1,5 +1,4 @@
-import { COPY, DIST_TYPES, isBoolean, isOutputTargetDistCustomElements } from '@utils';
-import { join } from 'path';
+import { COPY, DIST_TYPES, isBoolean, isOutputTargetDistCustomElements, join } from '@utils';
 
 import type {
   OutputTarget,

src/compiler/config/outputs/validate-dist.ts

@@ -9,8 +9,10 @@ import {
   isBoolean,
   isOutputTargetDist,
   isString,
+  join,
+  resolve,
 } from '@utils';
-import { isAbsolute, join, resolve } from 'path';
+import { isAbsolute } from 'path';
 
 import type * as d from '../../../declarations';
 import { getAbsolutePath } from '../config-utils';

src/compiler/config/outputs/validate-docs.ts

@@ -8,8 +8,9 @@ import {
   isOutputTargetDocsReadme,
   isOutputTargetDocsVscode,
   isString,
+  join,
 } from '@utils';
-import { isAbsolute, join } from 'path';
+import { isAbsolute } from 'path';
 
 import type * as d from '../../../declarations';
 import { NOTE } from '../../docs/constants';

src/compiler/config/outputs/validate-hydrate-script.ts

@@ -5,8 +5,9 @@ import {
   isOutputTargetHydrate,
   isOutputTargetWww,
   isString,
+  join,
 } from '@utils';
-import { isAbsolute, join } from 'path';
+import { isAbsolute } from 'path';
 
 import type * as d from '../../../declarations';
 

src/compiler/config/outputs/validate-lazy.ts

@@ -1,5 +1,4 @@
-import { DIST_LAZY, isBoolean, isOutputTargetDistLazy } from '@utils';
-import { join } from 'path';
+import { DIST_LAZY, isBoolean, isOutputTargetDistLazy, join } from '@utils';
 
 import type * as d from '../../../declarations';
 import { getAbsolutePath } from '../config-utils';

src/compiler/config/outputs/validate-stats.ts

@@ -1,5 +1,5 @@
-import { isOutputTargetStats, STATS } from '@utils';
-import { isAbsolute, join } from 'path';
+import { isOutputTargetStats, join, STATS } from '@utils';
+import { isAbsolute } from 'path';
 
 import type * as d from '../../../declarations';
 

src/compiler/config/outputs/validate-www.ts

@@ -7,9 +7,10 @@ import {
   isOutputTargetDist,
   isOutputTargetWww,
   isString,
+  join,
   WWW,
 } from '@utils';
-import { isAbsolute, join } from 'path';
+import { isAbsolute } from 'path';
 
 import type * as d from '../../../declarations';
 import { getAbsolutePath } from '../config-utils';

src/compiler/config/validate-dev-server.ts

@@ -1,5 +1,5 @@
-import { buildError, isBoolean, isNumber, isOutputTargetWww, isString, normalizePath } from '@utils';
-import { isAbsolute, join } from 'path';
+import { buildError, isBoolean, isNumber, isOutputTargetWww, isString, join, normalizePath } from '@utils';
+import { isAbsolute } from 'path';
 
 import type * as d from '../../declarations';
 

src/compiler/config/validate-paths.ts

@@ -1,4 +1,5 @@
-import { isAbsolute, join } from 'path';
+import { join } from '@utils';
+import { isAbsolute } from 'path';
 
 import type * as d from '../../declarations';
 

src/compiler/config/validate-prerender.ts

@@ -1,5 +1,5 @@
-import { buildError, isString, normalizePath } from '@utils';
-import { isAbsolute, join } from 'path';
+import { buildError, isString, join, normalizePath } from '@utils';
+import { isAbsolute } from 'path';
 
 import type * as d from '../../declarations';
 

src/compiler/config/validate-service-worker.ts

@@ -1,5 +1,5 @@
-import { isString } from '@utils';
-import { isAbsolute, join } from 'path';
+import { isString, join } from '@utils';
+import { isAbsolute } from 'path';
 
 import type * as d from '../../declarations';
 

src/compiler/config/validate-testing.ts

@@ -1,5 +1,5 @@
-import { buildError, isOutputTargetDist, isOutputTargetWww, isString } from '@utils';
-import { basename, dirname, isAbsolute, join } from 'path';
+import { buildError, isOutputTargetDist, isOutputTargetWww, isString, join } from '@utils';
+import { basename, dirname, isAbsolute } from 'path';
 
 import type * as d from '../../declarations';
 import { isLocalModule } from '../sys/resolve/resolve-utils';

src/compiler/docs/generate-doc-data.ts

@@ -1,5 +1,5 @@
-import { flatOne, isOutputTargetDocsJson, normalizePath, sortBy, unique } from '@utils';
-import { basename, dirname, join, relative } from 'path';
+import { flatOne, isOutputTargetDocsJson, join, normalizePath, relative, sortBy, unique } from '@utils';
+import { basename, dirname } from 'path';
 
 import type * as d from '../../declarations';
 import { JsonDocsValue } from '../../declarations';

src/compiler/docs/json/index.ts

@@ -1,5 +1,4 @@
-import { isOutputTargetDocsJson } from '@utils';
-import { join } from 'path';
+import { isOutputTargetDocsJson, join } from '@utils';
 
 import type * as d from '../../../declarations';
 

src/compiler/docs/readme/markdown-dependencies.ts

@@ -1,5 +1,4 @@
-import { normalizePath } from '@utils';
-import { relative } from 'path';
+import { normalizePath, relative } from '@utils';
 
 import type * as d from '../../../declarations';
 

src/compiler/docs/readme/output-docs.ts

@@ -1,4 +1,4 @@
-import { join, relative } from 'path';
+import { join, relative } from '@utils';
 
 import type * as d from '../../../declarations';
 import { AUTO_GENERATE_COMMENT } from '../constants';

src/compiler/docs/vscode/index.ts

@@ -1,5 +1,4 @@
-import { isOutputTargetDocsVscode } from '@utils';
-import { join } from 'path';
+import { isOutputTargetDocsVscode, join } from '@utils';
 
 import type * as d from '../../../declarations';
 import { getNameText } from '../generate-doc-data';

src/compiler/html/add-script-attr.ts

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { join } from '@utils';
 
 import type * as d from '../../declarations';
 import { getAbsoluteBuildDir } from './html-utils';

src/compiler/html/html-utils.ts

@@ -1,4 +1,4 @@
-import { join, relative } from 'path';
+import { join, relative } from '@utils';
 
 import type * as d from '../../declarations';
 

src/compiler/html/inject-module-preloads.ts

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { join } from '@utils';
 
 import type * as d from '../../declarations';
 import { getAbsoluteBuildDir } from './html-utils';

src/compiler/html/inline-esm-import.ts

@@ -1,5 +1,4 @@
-import { isString } from '@utils';
-import { join } from 'path';
+import { isString, join } from '@utils';
 import ts from 'typescript';
 
 import type * as d from '../../declarations';

src/compiler/html/inline-style-sheets.ts

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { join } from '@utils';
 
 import type * as d from '../../declarations';
 

src/compiler/html/update-global-styles-link.ts

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { join } from '@utils';
 
 import type * as d from '../../declarations';
 import { getAbsoluteBuildDir } from './html-utils';

src/compiler/html/validate-manifest-json.ts

@@ -1,5 +1,5 @@
-import { buildError, buildJsonFileError, isOutputTargetWww } from '@utils';
-import { dirname, join } from 'path';
+import { buildError, buildJsonFileError, isOutputTargetWww, join } from '@utils';
+import { dirname } from 'path';
 
 import type * as d from '../../declarations';
 

src/compiler/output-targets/copy/assets-copy-tasks.ts

@@ -1,5 +1,5 @@
-import { normalizePath } from '@utils';
-import { dirname, join, relative } from 'path';
+import { join, normalizePath, relative } from '@utils';
+import { dirname } from 'path';
 
 import type * as d from '../../../declarations';
 

src/compiler/output-targets/copy/hashed-copy.ts

@@ -1,4 +1,5 @@
-import { dirname, extname, join } from 'path';
+import { join } from '@utils';
+import { dirname, extname } from 'path';
 
 import type * as d from '../../../declarations';
 

src/compiler/output-targets/copy/local-copy-tasks.ts

@@ -1,4 +1,5 @@
-import { isAbsolute, join } from 'path';
+import { join } from '@utils';
+import { isAbsolute } from 'path';
 
 import type * as d from '../../../declarations';
 

src/compiler/output-targets/copy/output-copy.ts

@@ -1,6 +1,5 @@
-import { buildError, isGlob, isOutputTargetCopy, normalizePath } from '@utils';
+import { buildError, isGlob, isOutputTargetCopy, join, normalizePath } from '@utils';
 import minimatch from 'minimatch';
-import { join } from 'path';
 
 import type * as d from '../../../declarations';
 import { canSkipAssetsCopy, getComponentAssetsCopyTasks } from './assets-copy-tasks';

src/compiler/output-targets/dist-custom-elements/index.ts

@@ -6,9 +6,9 @@ import {
   hasError,
   isOutputTargetDistCustomElements,
   isString,
+  join,
   rollupToStencilSourceMap,
 } from '@utils';
-import { join } from 'path';
 import ts from 'typescript';
 
 import type * as d from '../../../declarations';

src/compiler/output-targets/dist-hydrate-script/generate-hydrate-app.ts

@@ -1,6 +1,5 @@
-import { catchError, createOnWarnFn, generatePreamble, loadRollupDiagnostics } from '@utils';
+import { catchError, createOnWarnFn, generatePreamble, join, loadRollupDiagnostics } from '@utils';
 import MagicString from 'magic-string';
-import { join } from 'path';
 import { RollupOptions } from 'rollup';
 import { rollup } from 'rollup';
 

src/compiler/output-targets/dist-hydrate-script/write-hydrate-outputs.ts

@@ -1,4 +1,5 @@
-import { basename, join } from 'path';
+import { join } from '@utils';
+import { basename } from 'path';
 import type { RollupOutput } from 'rollup';
 
 import type * as d from '../../../declarations';

src/compiler/output-targets/dist-lazy/generate-cjs.ts

@@ -1,5 +1,4 @@
-import { generatePreamble, relativeImport } from '@utils';
-import { join } from 'path';
+import { generatePreamble, join, relativeImport } from '@utils';
 import type { OutputOptions, RollupBuild } from 'rollup';
 
 import type * as d from '../../../declarations';

src/compiler/output-targets/dist-lazy/generate-lazy-module.ts

@@ -2,10 +2,10 @@ import {
   formatComponentRuntimeMeta,
   getSourceMappingUrlForEndOfFile,
   hasDependency,
+  join,
   rollupToStencilSourceMap,
   stringifyRuntimeData,
 } from '@utils';
-import { join } from 'path';
 import type { SourceMap as RollupSourceMap } from 'rollup';
 
 import type * as d from '../../../declarations';

src/compiler/output-targets/dist-lazy/generate-system.ts

@@ -1,5 +1,4 @@
-import { generatePreamble, relativeImport } from '@utils';
-import { join } from 'path';
+import { generatePreamble, join, relativeImport } from '@utils';
 import type { OutputOptions, RollupBuild } from 'rollup';
 
 import type * as d from '../../../declarations';

src/compiler/output-targets/dist-lazy/write-lazy-entry-module.ts

@@ -1,5 +1,4 @@
-import { getSourceMappingUrlForEndOfFile } from '@utils';
-import { join } from 'path';
+import { getSourceMappingUrlForEndOfFile, join } from '@utils';
 
 import type * as d from '../../../declarations';
 

src/compiler/plugin/plugin.ts

@@ -1,5 +1,5 @@
-import { buildError, catchError, isFunction, isOutputTargetDocs, isString } from '@utils';
-import { basename, relative } from 'path';
+import { buildError, catchError, isFunction, isOutputTargetDocs, isString, relative } from '@utils';
+import { basename } from 'path';
 
 import type * as d from '../../declarations';
 import { PluginCtx, PluginTransformResults } from '../../declarations';

src/compiler/prerender/prerender-main.ts

@@ -1,5 +1,5 @@
-import { buildError, catchError, hasError, isOutputTargetWww, isString } from '@utils';
-import { isAbsolute, join } from 'path';
+import { buildError, catchError, hasError, isOutputTargetWww, isString, join } from '@utils';
+import { isAbsolute } from 'path';
 
 import type * as d from '../../declarations';
 import { createHydrateBuildId } from '../../hydrate/runner/render-utils';

src/compiler/prerender/prerender-optimize.ts

@@ -1,5 +1,4 @@
-import { catchError, flatOne, isString, unique } from '@utils';
-import { join } from 'path';
+import { catchError, flatOne, isString, join, unique } from '@utils';
 
 import type * as d from '../../declarations';
 import { injectModulePreloads } from '../html/inject-module-preloads';

src/compiler/prerender/prerender-worker.ts

@@ -1,5 +1,5 @@
-import { catchError, isFunction, isPromise, isRootPath, normalizePath } from '@utils';
-import { dirname, join } from 'path';
+import { catchError, isFunction, isPromise, isRootPath, join, normalizePath } from '@utils';
+import { dirname } from 'path';
 
 import type * as d from '../../declarations';
 import { crawlAnchorsForNextUrls } from './crawl-urls';