Skip to content

Commit

Permalink
chore(config): migrate additional callsites to ValidatedConfig (#3498)
Browse files Browse the repository at this point in the history
this commit propagates the usage of `ValidatedConfig` throughout
various parts of the code. the changes are distributed and small in size,
which made it feel unnecessary to split into multiple pull requests, given
the nature of the changes being proposed.

this is being done following making sys a required field on ValidatedConfig
in 991843a (#3491), where driving down the number of sys-related violations of
the compile time check is the primary driver.
  • Loading branch information
rwaskiewicz authored Aug 5, 2022
1 parent 10421be commit c185d02
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions src/cli/task-generate.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { Config, ValidatedConfig } from '../declarations';
import type { ValidatedConfig } from '../declarations';
import type { CoreCompiler } from './load-compiler';
import { IS_NODE_ENV } from '../compiler/sys/environment';
import { validateComponentTag } from '@utils';
Expand Down Expand Up @@ -139,7 +139,7 @@ const getFilepathForFile = (
* used to print out a little summary of our activity to the user.
*/
const getBoilerplateAndWriteFile = async (
config: Config,
config: ValidatedConfig,
componentName: string,
withCss: boolean,
file: BoilerplateFile
Expand All @@ -161,7 +161,7 @@ const getBoilerplateAndWriteFile = async (
* @param files the files we want to check
* @param config the Config object, used here to get access to `sys.readFile`
*/
const checkForOverwrite = async (files: readonly BoilerplateFile[], config: Config): Promise<void> => {
const checkForOverwrite = async (files: readonly BoilerplateFile[], config: ValidatedConfig): Promise<void> => {
const alreadyPresent: string[] = [];

await Promise.all(
Expand Down
4 changes: 2 additions & 2 deletions src/cli/test/run.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ describe('run', () => {

describe('runTask()', () => {
let sys: d.CompilerSystem;
let unvalidatedConfig: d.Config;
let validatedConfig: d.Config;
let unvalidatedConfig: d.UnvalidatedConfig;
let validatedConfig: d.ValidatedConfig;

let taskBuildSpy: jest.SpyInstance<ReturnType<typeof BuildTask.taskBuild>, Parameters<typeof BuildTask.taskBuild>>;
let taskDocsSpy: jest.SpyInstance<ReturnType<typeof DocsTask.taskDocs>, Parameters<typeof DocsTask.taskDocs>>;
Expand Down
4 changes: 2 additions & 2 deletions src/compiler/sys/worker/sys-worker.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import type { Config } from '../../../declarations';
import type { ValidatedConfig } from '../../../declarations';
import { createWorkerContext } from '../../worker/worker-thread';
import { createWorkerMainContext } from '../../worker/main-thread';
import { isFunction } from '@utils';

export const createSysWorker = (config: Config) => {
export const createSysWorker = (config: ValidatedConfig) => {
if (
isFunction(config.sys.createWorkerController) &&
config.maxConcurrentWorkers > 0 &&
Expand Down
2 changes: 1 addition & 1 deletion src/compiler/transpile/create-build-program.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import ts from 'typescript';
* @returns a Program that marries the TypeScript and Stencil compilers together.
*/
export const createTsBuildProgram = async (
config: d.Config,
config: d.ValidatedConfig,
buildCallback: (tsBuilder: ts.BuilderProgram) => Promise<void>
): Promise<ts.WatchOfConfigFile<ts.EmitAndSemanticDiagnosticsBuilderProgram>> => {
let isBuildRunning = false;
Expand Down
2 changes: 1 addition & 1 deletion src/compiler/transpile/create-watch-program.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { getTsOptionsToExtend } from './ts-config';
import ts from 'typescript';

export const createTsWatchProgram = async (
config: d.Config,
config: d.ValidatedConfig,
buildCallback: (tsBuilder: ts.BuilderProgram) => Promise<void>
) => {
let isRunning = false;
Expand Down
2 changes: 1 addition & 1 deletion src/compiler/transpile/ts-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type * as d from '../../declarations';
import { isOutputTargetDistTypes } from '../output-targets/output-utils';
import ts from 'typescript';

export const getTsOptionsToExtend = (config: d.Config) => {
export const getTsOptionsToExtend = (config: d.ValidatedConfig) => {
const tsOptions: ts.CompilerOptions = {
experimentalDecorators: true,
declaration: config.outputTargets.some(isOutputTargetDistTypes),
Expand Down
2 changes: 1 addition & 1 deletion src/compiler/types/stencil-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ const updateTypeName = (currentTypeName: string, typeAlias: d.TypesMemberNameDat
* @returns the results of writing one or more type declaration files to disk
*/
export const copyStencilCoreDts = async (
config: d.Config,
config: d.ValidatedConfig,
compilerCtx: d.CompilerCtx
): Promise<ReadonlyArray<d.FsWriteResults>> => {
const typesOutputTargets = config.outputTargets.filter(isOutputTargetDistTypes).filter((o) => o.typesDir);
Expand Down

0 comments on commit c185d02

Please sign in to comment.