chore(compiler): make outputTargets required on the ValidatedConfig (#3477)

This makes the `outputTargets` field required on the `ValidatedConfig`
type, allowing us to freely access `.outputTargets` on a validated
configuration object in the compiler code without having to use the `!`
operator, check `=== undefined`, etc.

This includes changes to the places where a `ValidatedConfig` object is
created to default `.outputTargets` to `[]` if no suitable value is
present.

Author: alicewriteswrongs

src/cli/run.ts

@@ -75,9 +75,14 @@ export const run = async (init: d.CliInitOptions) => {
     loadedCompilerLog(sys, logger, flags, coreCompiler);
 
     if (task === 'info') {
-      await telemetryAction(sys, { flags: createConfigFlags({ task: 'info' }), logger }, coreCompiler, async () => {
-        await taskInfo(coreCompiler, sys, logger);
-      });
+      await telemetryAction(
+        sys,
+        { flags: createConfigFlags({ task: 'info' }), logger, outputTargets: [] },
+        coreCompiler,
+        async () => {
+          await taskInfo(coreCompiler, sys, logger);
+        }
+      );
       return;
     }
 
@@ -122,9 +127,12 @@ export const runTask = async (
   sys?: d.CompilerSystem
 ) => {
   const logger = config.logger ?? createLogger();
-  const strictConfig: ValidatedConfig = { ...config, flags: createConfigFlags(config.flags ?? { task }), logger };
-
-  strictConfig.outputTargets = strictConfig.outputTargets || [];
+  const strictConfig: ValidatedConfig = {
+    ...config,
+    flags: createConfigFlags(config.flags ?? { task }),
+    logger,
+    outputTargets: config.outputTargets ?? [],
+  };
 
   switch (task) {
     case 'build':

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

@@ -16,6 +16,7 @@ describe('validateServiceWorker', () => {
       devMode: false,
       flags: createConfigFlags(),
       logger: mockLogger(),
+      outputTargets: [],
     };
   });
 

src/compiler/config/validate-config.ts

@@ -51,6 +51,7 @@ export const validateConfig = (
     // flags _should_ be JSON safe
     flags: JSON.parse(JSON.stringify(config.flags || {})),
     logger,
+    outputTargets: config.outputTargets ?? [],
   };
 
   // default devMode false

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

@@ -12,12 +12,12 @@ import { normalizePath, dashToPascalCase } from '@utils';
  * @param typesDir the path to the directory where type declarations are saved
  */
 export const generateCustomElementsTypes = async (
-  config: d.Config,
+  config: d.ValidatedConfig,
   compilerCtx: d.CompilerCtx,
   buildCtx: d.BuildCtx,
   typesDir: string
 ): Promise<void> => {
-  const outputTargets = (config.outputTargets ?? []).filter(isOutputTargetDistCustomElements);
+  const outputTargets = config.outputTargets.filter(isOutputTargetDistCustomElements);
 
   await Promise.all(
     outputTargets.map((outputTarget) =>
@@ -36,7 +36,7 @@ export const generateCustomElementsTypes = async (
  * @param outputTarget the output target for which types are being currently generated
  */
 const generateCustomElementsTypesOutput = async (
-  config: d.Config,
+  config: d.ValidatedConfig,
   compilerCtx: d.CompilerCtx,
   buildCtx: d.BuildCtx,
   typesDir: string,

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

@@ -28,21 +28,21 @@ import ts from 'typescript';
  * which do actual work of generating the rollup configuration, creating an
  * entry chunk, running, the build, etc.
  *
- * @param config the user-supplied compiler configuration we're using
+ * @param config the validated compiler configuration we're using
  * @param compilerCtx the current compiler context
  * @param buildCtx the current build context
  * @returns an empty Promise which won't resolve until the work is done!
  */
 export const outputCustomElements = async (
-  config: d.Config,
+  config: d.ValidatedConfig,
   compilerCtx: d.CompilerCtx,
   buildCtx: d.BuildCtx
 ): Promise<void> => {
   if (!config.buildDist) {
     return;
   }
 
-  const outputTargets = (config.outputTargets ?? []).filter(isOutputTargetDistCustomElements);
+  const outputTargets = config.outputTargets.filter(isOutputTargetDistCustomElements);
   if (outputTargets.length === 0) {
     return;
   }
@@ -59,14 +59,14 @@ export const outputCustomElements = async (
  * Get bundle options for our current build and compiler context which we'll use
  * to generate a Rollup build and so on.
  *
- * @param config user-supplied Stencil configuration
+ * @param config a validated Stencil configuration object
  * @param buildCtx the current build context
  * @param compilerCtx the current compiler context
  * @param outputTarget the outputTarget we're currently dealing with
  * @returns bundle options suitable for generating a rollup configuration
  */
 export const getBundleOptions = (
-  config: d.Config,
+  config: d.ValidatedConfig,
   buildCtx: d.BuildCtx,
   compilerCtx: d.CompilerCtx,
   outputTarget: d.OutputTargetDistCustomElements
@@ -96,15 +96,15 @@ export const getBundleOptions = (
 /**
  * Get bundle options for rollup, run the rollup build, optionally minify the
  * output, and write files to disk.
- * @param config user-supplied Stencil configuration
- * @param buildCtx the current build context
+ *
+ * @param config the validated Stencil configuration we're using
  * @param compilerCtx the current compiler context
+ * @param buildCtx the current build context
  * @param outputTarget the outputTarget we're currently dealing with
  * @returns an empty promise
  */
-
 export const bundleCustomElements = async (
-  config: d.Config,
+  config: d.ValidatedConfig,
   compilerCtx: d.CompilerCtx,
   buildCtx: d.BuildCtx,
   outputTarget: d.OutputTargetDistCustomElements

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

@@ -9,7 +9,7 @@ import { isOutputTargetDistTypes } from './output-utils';
  * @param buildCtx the context associated with the current build
  */
 export const outputTypes = async (
-  config: d.Config,
+  config: d.ValidatedConfig,
   compilerCtx: d.CompilerCtx,
   buildCtx: d.BuildCtx
 ): Promise<void> => {

src/compiler/output-targets/test/custom-elements-types.spec.ts

@@ -1,5 +1,11 @@
 import { path } from '@stencil/core/compiler';
-import { mockConfig, mockCompilerSystem, mockBuildCtx, mockCompilerCtx, mockModule } from '@stencil/core/testing';
+import {
+  mockCompilerSystem,
+  mockBuildCtx,
+  mockCompilerCtx,
+  mockModule,
+  mockValidatedConfig,
+} from '@stencil/core/testing';
 import type * as d from '../../../declarations';
 import * as outputCustomElementsMod from '../dist-custom-elements';
 import { stubComponentCompilerMeta } from '../../types/tests/ComponentCompilerMeta.stub';
@@ -9,7 +15,7 @@ import { join, relative } from 'path';
 
 const setup = () => {
   const sys = mockCompilerSystem();
-  const config: d.Config = mockConfig(sys);
+  const config: d.ValidatedConfig = mockValidatedConfig(sys);
   const compilerCtx = mockCompilerCtx(config);
   const buildCtx = mockBuildCtx(config, compilerCtx);
   const root = config.rootDir;

src/compiler/output-targets/test/output-targets-dist-custom-elements.spec.ts

@@ -1,5 +1,11 @@
 import { path } from '@stencil/core/compiler';
-import { mockConfig, mockCompilerSystem, mockBuildCtx, mockCompilerCtx, mockModule } from '@stencil/core/testing';
+import {
+  mockCompilerSystem,
+  mockBuildCtx,
+  mockCompilerCtx,
+  mockModule,
+  mockValidatedConfig,
+} from '@stencil/core/testing';
 import type * as d from '../../../declarations';
 import {
   addCustomElementInputs,
@@ -16,7 +22,7 @@ import { DIST_CUSTOM_ELEMENTS, DIST_CUSTOM_ELEMENTS_BUNDLE } from '../output-uti
 
 const setup = () => {
   const sys = mockCompilerSystem();
-  const config: d.Config = mockConfig(sys);
+  const config: d.ValidatedConfig = mockValidatedConfig(sys);
   const compilerCtx = mockCompilerCtx(config);
   const buildCtx = mockBuildCtx(config, compilerCtx);
   const root = config.rootDir;

src/compiler/sys/config.ts

@@ -6,7 +6,12 @@ import { createConfigFlags } from '../../cli/config-flags';
 
 export const getConfig = (userConfig: d.Config): d.ValidatedConfig => {
   const logger = userConfig.logger ?? createLogger();
-  const config: d.ValidatedConfig = { ...userConfig, flags: createConfigFlags(userConfig.flags ?? {}), logger };
+  const config: d.ValidatedConfig = {
+    ...userConfig,
+    flags: createConfigFlags(userConfig.flags ?? {}),
+    logger,
+    outputTargets: userConfig.outputTargets ?? [],
+  };
 
   if (!config.sys) {
     config.sys = createSystem({ logger: config.logger });

src/compiler/types/generate-types.ts

@@ -14,7 +14,7 @@ import { isDtsFile } from '@utils';
  * @param outputTarget the output target to generate types for
  */
 export const generateTypes = async (
-  config: d.Config,
+  config: d.ValidatedConfig,
   compilerCtx: d.CompilerCtx,
   buildCtx: d.BuildCtx,
   outputTarget: d.OutputTargetDistTypes
@@ -33,7 +33,7 @@ export const generateTypes = async (
  * @param outputTarget the output target to generate types for
  */
 const generateTypesOutput = async (
-  config: d.Config,
+  config: d.ValidatedConfig,
   compilerCtx: d.CompilerCtx,
   buildCtx: d.BuildCtx,
   outputTarget: d.OutputTargetDistTypes