chore(config): add rootDir to the validated config type (#3577)

alicewriteswrongs · web-flow · commit f30db9c67c20 · 2022-09-07T10:19:07.000-04:00
Just adding `.rootDir` as a required field on the `ValidatedConfig` type,
cutting down our null check violations a little bit.
diff --git a/src/cli/run.ts b/src/cli/run.ts
@@ -133,6 +133,7 @@ export const runTask = async (
     flags: createConfigFlags(config.flags ?? { task }),
     logger,
     outputTargets: config.outputTargets ?? [],
+    rootDir: config.rootDir ?? '/',
     sys: sys ?? config.sys ?? coreCompiler.createSystem({ logger }),
     testing: config.testing ?? {},
   };
diff --git a/src/compiler/config/test/validate-service-worker.spec.ts b/src/compiler/config/test/validate-service-worker.spec.ts
@@ -12,6 +12,7 @@ describe('validateServiceWorker', () => {
   beforeEach(() => {
     config = {
       fsNamespace: 'app',
+      rootDir: '/',
       sys: mockCompilerSystem(),
       devMode: false,
       flags: createConfigFlags(),
diff --git a/src/compiler/config/validate-config.ts b/src/compiler/config/validate-config.ts
@@ -53,6 +53,7 @@ export const validateConfig = (
     flags: JSON.parse(JSON.stringify(config.flags || {})),
     logger,
     outputTargets: config.outputTargets ?? [],
+    rootDir: typeof config.rootDir === 'string' ? config.rootDir : '/',
     sys: config.sys ?? bootstrapConfig.sys ?? createSystem({ logger }),
     testing: config.testing ?? {},
   };
diff --git a/src/compiler/config/validate-paths.ts b/src/compiler/config/validate-paths.ts
@@ -1,7 +1,14 @@
 import type * as d from '../../declarations';
 import { isAbsolute, join } from 'path';
 
-export const validatePaths = (config: d.UnvalidatedConfig) => {
+/**
+ * Do logical-level validation (as opposed to type-level validation)
+ * for various properties in the user-supplied config which represent
+ * filesystem paths.
+ *
+ * @param config a validated user-supplied configuration
+ */
+export const validatePaths = (config: d.ValidatedConfig) => {
   if (typeof config.rootDir !== 'string') {
     config.rootDir = '/';
   }
diff --git a/src/compiler/sys/config.ts b/src/compiler/sys/config.ts
@@ -11,6 +11,7 @@ export const getConfig = (userConfig: d.Config): d.ValidatedConfig => {
     flags: createConfigFlags(userConfig.flags ?? {}),
     logger,
     outputTargets: userConfig.outputTargets ?? [],
+    rootDir: userConfig.rootDir ?? '/',
     sys: userConfig.sys ?? createSystem({ logger }),
     testing: userConfig ?? {},
   };
diff --git a/src/declarations/stencil-public-compiler.ts b/src/declarations/stencil-public-compiler.ts
@@ -410,7 +410,7 @@ type RequireFields<T, K extends keyof T> = T & { [P in K]-?: T[P] };
 /**
  * Fields in {@link Config} to make required for {@link ValidatedConfig}
  */
-type StrictConfigFields = 'flags' | 'logger' | 'outputTargets' | 'sys' | 'testing';
+type StrictConfigFields = 'flags' | 'logger' | 'outputTargets' | 'rootDir' | 'sys' | 'testing';
 
 /**
  * A version of {@link Config} that makes certain fields required. This type represents a valid configuration entity.
diff --git a/src/testing/mocks.ts b/src/testing/mocks.ts
@@ -35,6 +35,7 @@ export function mockValidatedConfig(overrides: Partial<ValidatedConfig> = {}): V
     flags: createConfigFlags(),
     logger: mockLogger(),
     outputTargets: baseConfig.outputTargets ?? [],
+    rootDir: path.resolve('/'),
     sys: createTestingSystem(),
     testing: {},
     ...overrides,
