refactor(utils): move output-target related utils to @utils (#4225)

This moves a bunch of utility functions (and some constants) from
src/compiler/output-targets/output-utils.ts to instead live in a new
file in the `@utils` directory (`src/utils`). This is done to reflect
the fact that functions in the file are used outside of the
`src/compiler/` bundle so they should be pulled out into a common
location.

Author: alicewriteswrongs

scripts/bundles/internal-platform-hydrate.ts

@@ -39,6 +39,29 @@ export async function internalHydrate(opts: BuildOptions) {
       banner: getBanner(opts, 'Stencil Hydrate Platform'),
       preferConst: true,
     },
+    /**
+     * The `internal-platform-hydrate` bundle depends on functions which use
+     * the output-target utils which, in turn, imports `path`. However, none of
+     * the functions which it uses actually _use_ functioned exported by `path`,
+     * so when bundling it doesn't actually import anything from `path` but if
+     * you don't set this option Rollup will leave an unqualified import like
+     * so:
+     *
+     * ```ts
+     * import "path";
+     * ```
+     *
+     * If you say `moduleSideEffects: false` you're basically saying 'dont assume
+     * that imported a module has a desired side effect' which allows an import that
+     * doesn't result in any symbols being pulled into the importing module to be
+     * eliminated.
+     *
+     * Another way to say this is that without this change the treeshaking
+     * validation for `test.dist` doesn't pass for this bundle.
+     */
+    treeshake: {
+      moduleSideEffects: false,
+    },
     plugins: [
       {
         name: 'internalHydratePlugin',
@@ -66,6 +89,17 @@ export async function internalHydrate(opts: BuildOptions) {
       banner: getBanner(opts, 'Stencil Hydrate Runner'),
       preferConst: true,
     },
+    /**
+     * See above for an explanation, this is necessary to eliminate an
+     * unqualified import of `"path"`, like so:
+     *
+     * ```ts
+     * import "path";
+     * ```
+     */
+    treeshake: {
+      moduleSideEffects: false,
+    },
     plugins: [
       aliasPlugin(opts),
       replacePlugin(opts),

src/cli/task-docs.ts

@@ -1,4 +1,5 @@
-import { isOutputTargetDocs } from '../compiler/output-targets/output-utils';
+import { isOutputTargetDocs } from '@utils';
+
 import type { ValidatedConfig } from '../declarations';
 import type { CoreCompiler } from './load-compiler';
 import { startupCompilerLog } from './logs';

src/cli/telemetry/telemetry.ts

@@ -1,4 +1,5 @@
-import { isOutputTargetHydrate, WWW } from '../../compiler/output-targets/output-utils';
+import { isOutputTargetHydrate, WWW } from '@utils';
+
 import { IS_BROWSER_ENV } from '../../compiler/sys/environment';
 import type * as d from '../../declarations';
 import { readConfig, updateConfig, writeConfig } from '../ionic-config';

src/cli/telemetry/test/telemetry.spec.ts

@@ -1,8 +1,8 @@
 import * as coreCompiler from '@stencil/core/compiler';
 import { mockValidatedConfig } from '@stencil/core/testing';
+import { DIST, DIST_CUSTOM_ELEMENTS, DIST_HYDRATE_SCRIPT, WWW } from '@utils';
 
 import { createConfigFlags } from '../../../cli/config-flags';
-import { DIST, DIST_CUSTOM_ELEMENTS, DIST_HYDRATE_SCRIPT, WWW } from '../../../compiler/output-targets/output-utils';
 import * as environment from '../../../compiler/sys/environment';
 import { createSystem } from '../../../compiler/sys/stencil-sys';
 import type * as d from '../../../declarations';

src/compiler/build/build-hmr.ts

@@ -1,9 +1,8 @@
-import { isGlob, normalizePath, sortBy } from '@utils';
+import { isGlob, isOutputTargetWww, normalizePath, sortBy } from '@utils';
 import minimatch from 'minimatch';
 import { basename } from 'path';
 
 import type * as d from '../../declarations';
-import { isOutputTargetWww } from '../output-targets/output-utils';
 import { getScopeId } from '../style/scope-css';
 
 export const generateHmr = (config: d.Config, compilerCtx: d.CompilerCtx, buildCtx: d.BuildCtx) => {

src/compiler/build/build-stats.ts

@@ -1,7 +1,6 @@
-import { byteSize, sortBy } from '@utils';
+import { byteSize, isOutputTargetStats, sortBy } from '@utils';
 
 import type * as d from '../../declarations';
-import { isOutputTargetStats } from '../output-targets/output-utils';
 
 /**
  * Generates the Build Stats from the buildCtx. Writes any files to the file system.

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

@@ -1,9 +1,8 @@
-import { hasError, normalizeFsPath } from '@utils';
+import { hasError, isOutputTargetDistCollection, normalizeFsPath } from '@utils';
 import { join, relative } from 'path';
 import type { Plugin } from 'rollup';
 
 import type * as d from '../../declarations';
-import { isOutputTargetDistCollection } from '../output-targets/output-utils';
 import { runPluginTransformsEsmImports } from '../plugin/plugin';
 import { parseImportPath } from '../transformers/stencil-import-path';
 import type { BundleOptions } from './bundle-interface';

src/compiler/bundle/server-plugin.ts

@@ -1,9 +1,8 @@
-import { isString, normalizeFsPath } from '@utils';
+import { isOutputTargetHydrate, isString, normalizeFsPath } from '@utils';
 import { isAbsolute } from 'path';
 import type { Plugin } from 'rollup';
 
 import type * as d from '../../declarations';
-import { isOutputTargetHydrate } from '../output-targets/output-utils';
 
 export const serverPlugin = (config: d.ValidatedConfig, platform: string): Plugin => {
   const isHydrateBundle = platform === 'hydrate';

src/compiler/config/outputs/index.ts

@@ -1,7 +1,6 @@
-import { buildError } from '@utils';
+import { buildError, isValidConfigOutputTarget, VALID_CONFIG_OUTPUT_TARGETS } from '@utils';
 
 import type * as d from '../../../declarations';
-import { isValidConfigOutputTarget, VALID_CONFIG_OUTPUT_TARGETS } from '../../output-targets/output-utils';
 import { validateCollection } from './validate-collection';
 import { validateCustomElement } from './validate-custom-element';
 import { validateCustomOutput } from './validate-custom-output';

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

@@ -1,5 +1,6 @@
+import { isOutputTargetDistCollection } from '@utils';
+
 import type * as d from '../../../declarations';
-import { isOutputTargetDistCollection } from '../../output-targets/output-utils';
 import { getAbsolutePath } from '../config-utils';
 
 /**